Listar Seguros
Requisição
Endpoint
- Metodo: GET
- Endpoint:
/v2/policies
Parâmetros de consulta (query)
| Parâmetro | Tipo | Padrão | Limites | Obrigatório | Descrição |
|---|---|---|---|---|---|
| page | integer | 1 | page ≥ 1 | ❌ | Número da página. |
| pageSize | integer | 100 | 1 ≤ pageSize ≤ 100 | ❌ | Quantidade de registros por página. |
Exemplo de chamada
GET /v2/policies?page=1&pageSize=25
Authorization: Bearer ...
Resposta
Campos da resposta (200)
| Campo | Tipo | Descrição |
|---|---|---|
| items | Policy[] | Lista de apólices. |
| total | integer | Total de registros na coleção. |
| page | integer | Página atual. |
| page_size | integer | Tamanho da página aplicado. |
| total_pages | integer | Total de páginas disponíveis. |
Exemplo (200)
{
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"active_from": "2025-08-11T00:00:00.000Z",
"active_until": "2035-08-11T00:00:00.000Z",
"proposal": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa4",
"client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "SIGNED",
"credit_contract_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"premium": "100.0"
},
"is_active": true,
"proposal_doc_url": "https://url.to/policy/file.pdf",
"created_at": "2025-08-10T02:07:49.030Z",
"updated_at": "2025-08-10T02:07:49.030Z",
"cancelled_at": null
}
],
"total": 42,
"page": 1,
"page_size": 25,
"total_pages": 2
}