Skip to main content

Listar Propostas

Requisição

Endpoint

  • Metodo: GET
  • Endpoint: /v2/proposals

Parâmetros de consulta (query)

ParâmetroTipoPadrãoLimitesObrigatórioDescrição
pageinteger1page ≥ 1Número da página.
pageSizeinteger1001 ≤ pageSize ≤ 100Quantidade de registros por página.
Exemplo de chamada
GET /v2/proposals?page=2&pageSize=25
Authorization: Bearer ...

Resposta

Campos da resposta (200)

CampoTipoDescrição
itemsProposal[]Lista de propostas.
totalintegerTotal de registros na coleção.
pageintegerPágina atual.
page_sizeintegerTamanho da página aplicado.
total_pagesintegerTotal de páginas disponíveis.
Exemplo (200)
{
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa4",
"client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "PENDING_SIGNATURE",
"expires_at": "2025-08-11T02:07:49.030Z",
"credit_contract_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quote_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"premium": "100.0",
"lucky_number": null,
"coverage_from": "2025-08-11T00:00:00.000Z",
"coverage_until": "2035-08-11T00:00:00.000Z",
"loan": {
"amount": "1000.0",
"period_in_months": 120
},
"person": {
"name": "Fulano de Tal",
"date_of_birth": "2000-01-01",
"gender": "M",
"cpf": "01234567890",
"marital_status": "SINGLE",
"phone": "+5551999998888",
"email": "fulano@mail.com"
},
"address": null,
"signature": {
"signature_id": null,
"signed_at": null,
"signature_provider": null
},
"created_at": "2025-08-10T02:07:49.030Z",
"updated_at": "2025-08-10T02:07:49.030Z",
"cancelled_at": null
}
],
"total": 1234,
"page": 1,
"page_size": 25,
"total_pages": 50
}