Listar propostas
Esse método retorna uma lista paginada com todas as propostas enviadas.
GET{{api_url}}/api/v1/proposals
Headers
Authorization*
String
Código de acesso
Query params
page
Number
Página a ser buscada
Response Body
totalCount
String
Quantidade total de itens
hasNextPage
Number
Indica se há mais uma página a ser buscada
proposals.id
Number
Identificador único da proposta
proposals.status
String
'awaiting_inspection', 'awaiting_inspection_evaluation', 'evaluating_inspection', 'awaiting_complementar', 'awaiting_vistei', 'awaiting_complementar_report', 'awaiting_registration', 'awaiting_payment', 'activated', 'rejected', 'cancelled', 'expired'
proposals.created_at
date
proposals.user.name
String
Nome do cliente da proposta
proposals.user.cpf
String
CPF do cliente da proposta
proposals.author.name
String
Nome do autor da proposta
proposals.vehicle.plate
String
Placa da proposta
Response Examples
{
"totalCount": 1,
"hasNextPage": true,
"proposals": [
{
"id": 1,
"status": "awaiting_inspection",
"created_at": "2024-04-11 03:47",
"user": {
"name": "BEATRIZ CRISTINA GONCALVES",
"cpf": "14458884670"
},
"author": {
"name": "BRUNO MELLO"
},
"vehicle": {
"plate": "ABC1230"
}
}
]Last updated