Skip to main content

GET Listar Descontos

Retorna a lista de descontos com filtros opcionais.

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_discounts.

Nenhum campo é obrigatório

Todos os parâmetros são opcionais. A requisição funciona sem nenhum filtro.


Endpoint​

GET https://api-dev.imagemais.com.br/api/finances/discounts

Parâmetros de Query​

NomeTipoObrigatórioDetalhe
limitnumber❌Mín: 0, Máx: 100, padrão: 50
offsetnumber❌Mín: 0, padrão: 0
searchstring❌Pesquisa por nome
isEveryoneboolean❌Passar "true" ou "false" como string na query
procedureIdnumber❌Devolve só os descontos elegíveis para o procedimento (ativos, não expirados, de procedimento e vinculados a ele) (inteiro)

Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/finances/discounts?limit=1&offset=0' \
-H 'accept: */*' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

{
"data": [
{
"id": 7,
"name": "Plano Bem Viver",
"description": "Desconto do Plano Bem Viver",
"percentage": null,
"fixed": "20",
"isActive": true,
"expirationDate": null,
"isEveryone": false,
"procedures": [
{
"id": 3676,
"name": "Ultrassom: Doppler Obstetrico 2/3 Trimestre",
"price": "140"
}
],
"createdAt": "2026-02-19T11:58:13.090Z",
"updatedAt": "2026-02-19T11:58:13.090Z"
}
]
}

200 Sucesso — sem resultados​

Retornado quando nenhum desconto é encontrado para o search informado.

{
"data": []
}