Listar apólices

Esse método retorna uma lista paginada com todas as apólices do sistema.

GET{{api_url}}/api/v1/policies

Headers

Name
Type
Description

Authorization*

String

Código de acesso

Query params

Name
Type
Description

page

Number

Página a ser buscada

Response Body

Name
Type
Description

totalCount

String

Quantidade total de itens

hasNextPage

Number

Indica se há mais uma página a ser buscada

policies.id

Number

Identificador único da apólice

policies.value_final

Float

Valor do prêmio

policies.policy_number

String

Protocolo de identificação da apólice

policies.status

String

Status da apólice

policies.created_at

Date

Data de criação da apólice

policies.author.name

String

Autor da apólice

policies.user.name

String

Nome do cliente

policies.user.cpf

String

Número de documento do cliente

policies.vehicle

String

Placa do veículo

Response Examples

{
    "totalCount": 1,
    "hasNextPage": false,
    "policies": [
        {
            "id": 500,
            "value_final": 115.85,
            "policy_number": "SPLITAUTO20240474EA625696I813O",
            "status": "active",
            "created_at": "2024-04-11 01:40",
            "author": {
                "name": "BEATRIZ CRISTINA GONÇALVES"
            },
            "user": {
                "name": "BRUNO MELLO",
                "cpf": "12584678962"
            },
            "vehicle": {
                "plate": "ABC1234"
            }
        }
      ]

Last updated