Documentação API EST

Listar Convênios

URL: /convenios

Método: GET

CampoTipoDescrição
tokenStringToken de acesso

Parâmetros QueryString Opcionais

CampoTipoDescrição
statusStringFiltra por Status

exemplo: /convenios?status=A

Resposta em caso de sucesso

Código HTTP: 200

{
"convenios": [
{
"id": "63",
"desc": "SAUDE BRADESCO",
"sigla": "BRADESCO",
"status": "A",
"planos": [
{
"desc": "PRIVATIVO",
"status": "A"
}
]
},
{
"id": "64",
"desc": "UNIMED",
"sigla": "UNIMED",
"status": "A",
"planos": []
}
]
}

Resposta em caso de falha

Código HTTPMensagem
401Token de acesso obrigatório
401Falha ao autenticar com o token informado
{
"msg": "Token de acesso obrigatório."
}