Skip to main content

GET Buscar API Key

Retorna os dados de uma API key da clínica (sem o valor completo).

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.


Endpoint​

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

Parâmetros de Rota​

NomeTipoObrigatórioDescrição
idstring✅Id da chave (api_key_ + 26 caracteres), como devolvido por Listar API Keys

Requisição​

curl -X 'GET' \n 'https://api-dev.imagemais.com.br/api/api-keys/api_key_01HXXXXXXXXXXXXXXXXXXXXXXX' \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 Id inválido​

{
"message": "API key inválida",
"error": "Bad Request",
"statusCode": 400
}

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
}

404 Chave não encontrada​

Inclui chave de outra clínica.

{
"message": "API key não encontrada",
"error": "Not Found",
"statusCode": 404
}

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
}