Skip to main content

GET Listar API Keys

Lista as API keys da clínica, da mais recente para a mais antiga. O valor completo não é devolvido — só um trecho mascarado.

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

Chaves da clínica no provedor de login

As chaves são emitidas e validadas pelo provedor de identidade (WorkOS) e pertencem à clínica do token. O valor completo não fica guardado: só aparece na criação.


Endpoint​

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

Requisição​

curl -X 'GET' \n 'https://api-dev.imagemais.com.br/api/api-keys' \n -H 'accept: application/json' \n -H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

[
{
"id": "api_key_01HXXXXXXXXXXXXXXXXXXXXXXX",
"name": "Integração Feegow",
"obfuscatedValue": "sk_live_...a1b2",
"permissions": [
"read_patients",
"read_appointments"
],
"createdAt": "2026-10-09T13:20:00.000Z",
"lastUsedAt": null
}
]

400 Clínica ainda não migrada​

{
"message": "A clínica ainda não foi migrada para o novo login. As API keys ficam disponíveis depois da migração.",
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}

503 Serviço de login indisponível​

{
"message": "Não foi possível falar com o serviço de login. Tente novamente em instantes.",
"error": "Service Unavailable",
"statusCode": 503
}
CampoTipoDescrição
idstringId da chave no provedor (api_key_...)
namestringNome de identificação
obfuscatedValuestringTrecho mascarado, para identificar a chave
permissionsstring[]Permissões da chave
createdAtstringData de criação (ISO 8601)
lastUsedAtstring | nullÚltimo uso; null se nunca foi usada