> ## Documentation Index
> Fetch the complete documentation index at: https://docs.promete.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Padrões de Resposta

> Formato padrão das respostas da API

## Padrões de Resposta

Todas as respostas da API seguem um formato padronizado para garantir consistência e facilitar o consumo pelos clientes.

## Resposta de Sucesso

```json theme={null}
{
  "status": "success",
  "data": {
    "id": "uuid-do-recurso",
    "type": "person",
    "attributes": {
      "name": "João Silva",
      "territory": "Zona Norte",
      "created_at": "2026-01-15T10:30:00Z"
    }
  },
  "meta": {
    "request_id": "req-uuid",
    "timestamp": "2026-01-15T10:30:00Z"
  }
}
```

## Resposta com Lista (Paginada)

```json theme={null}
{
  "status": "success",
  "data": [...],
  "meta": {
    "total": 1500,
    "page": 1,
    "per_page": 20,
    "total_pages": 75
  }
}
```

## Paginação

Todas as listagens são paginadas por padrão:

| Parâmetro  | Tipo    | Padrão       | Descrição                              |
| ---------- | ------- | ------------ | -------------------------------------- |
| `page`     | integer | 1            | Número da página                       |
| `per_page` | integer | 20           | Itens por página (máximo: 100)         |
| `sort`     | string  | `created_at` | Campo de ordenação                     |
| `order`    | string  | `desc`       | Direção da ordenação (`asc` ou `desc`) |

<Info>
  Os padrões de resposta serão refinados durante o desenvolvimento. O formato acima é uma proposta inicial baseada em boas práticas de APIs RESTful.
</Info>