Skip to main content

GET Listar Orçamentos

Retorna a lista de orçamentos ativos da conta, com filtros opcionais e paginação baseada em cursor.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão read_budgets.


Endpoint​

GET https://api-dev.imagemais.com.br/api/budgets

Parâmetros de Query​

NomeTipoObrigatórioValores válidosDescrição
limitnumber❌0–100Itens por página (padrão: 12)
cursornumber (string)❌qualquerCursor para paginação (ID do último item da página anterior)
createUserIdnumber❌inteiro positivoFiltra pelo ID do usuário que criou o orçamento
searchstring❌qualquerBusca por ID (≤ 10 dígitos), nome, CPF ou telefone do paciente
sendToQueuestring (boolean)❌"0", "1"1 = enviado para fila / 0 = não enviado
dateInitialstring❌YYYY-MM-DDData inicial do filtro (por updatedAt)
dateFinalstring❌YYYY-MM-DDData final do filtro (por updatedAt)
offsetnumber❌inteiro; mín. 0Número da página atual
Sobre o parâmetro search

Quando search tem 11 dígitos, a busca é feita por CPF ou telefone. Quando tem até 10 dígitos numéricos, busca pelo ID do orçamento. Caso contrário, busca pelo nome do paciente.


Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/budgets?limit=12&search=João&dateInitial=2026-01-01&dateFinal=2026-01-31' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

{
"data": [
{
"id": 109,
"createdAt": "2026-09-17T16:29:44.906Z",
"updatedAt": "2026-09-17T16:29:44.906Z",
"deletedAt": null,
"discountId": null,
"requestingDoctorId": null,
"observationId": null,
"reason": null,
"note": null,
"contacted": false,
"contactedAt": null,
"contactedById": null,
"netValue": "190",
"user": {
"name": "Ana Ferreira Souza"
},
"patient": {
"name": "Maria Oliveira Santos",
"contact": {
"id": 60,
"phone": "(81) 99999-9999",
"email": null,
"secondary_phone": null
},
"cpf": "12345678900"
},
"budgetsProcedures": [
{
"id": 168,
"price": "190",
"discountBudgetsProcedures": null,
"procedure": {
"name": "ECOCARDIOGRAMA",
"discounts": []
}
}
],
"status": {
"name": "PENDING"
},
"discount": null
}
],
"pagination": {
"nextCursor": 109
}
}