Perfis
Obter perfil
Obter um perfil de paciente por ID
GET
/
api
/
v1
/
profiles
/
{id}
curl --request GET \
--url https://anivahealth.com/api/v1/profiles/a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"handle": null,
"first_name": "Maria",
"last_name": "Schmidt",
"email": "maria.schmidt@example.com",
"phone": "+4930123456789",
"sex": 2,
"date_of_birth": "1985-03-22",
"height": 168,
"weight": 65,
"language": "de",
"transactional_emails_enabled": true,
"created_at": "2026-04-01T09:14:32Z",
"updated_at": "2026-04-01T11:05:00Z"
}
{
"error": "id: Invalid profile ID format"
}
{
"error": "Profile not found"
}
Obtém um único perfil de paciente através do respetivo UUID. Usa este endpoint para consultar dados demográficos ou verificar se um perfil existe antes de agendar uma marcação.
Requer o scope
profiles_view ou impersonate.
Pedido
Parâmetros de caminho
Resposta
Em caso de sucesso, a API devolve200 OK com o perfil.
Sexo biológico segundo a norma ISO/IEC 5218 (
0 = desconhecido, 1 = masculino, 2 = feminino). Pode ser null.Idioma preferido:
en, bg, ca, cs, da, de, el, es, et, fi, fr, ga, hr, hu, is, it, lb, lt, lv, mt, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, tr ou uk.Indica se este perfil recebe emails transacionais (programáticos).
null quando nunca foi definido.Respostas de erro
| Estado | Descrição |
|---|---|
400 | Formato de ID inválido — o valor fornecido não é um UUID válido. |
403 | Proibido — a tua chave de API não tem acesso a esta operação ou o perfil está fora do teu contexto de acesso. |
404 | Perfil não encontrado. |
500 | Erro interno do servidor. |
curl --request GET \
--url https://anivahealth.com/api/v1/profiles/a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"handle": null,
"first_name": "Maria",
"last_name": "Schmidt",
"email": "maria.schmidt@example.com",
"phone": "+4930123456789",
"sex": 2,
"date_of_birth": "1985-03-22",
"height": 168,
"weight": 65,
"language": "de",
"transactional_emails_enabled": true,
"created_at": "2026-04-01T09:14:32Z",
"updated_at": "2026-04-01T11:05:00Z"
}
{
"error": "id: Invalid profile ID format"
}
{
"error": "Profile not found"
}
⌘I
curl --request GET \
--url https://anivahealth.com/api/v1/profiles/a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d \
--header 'x-api-key: YOUR_API_KEY'
{
"id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
"handle": null,
"first_name": "Maria",
"last_name": "Schmidt",
"email": "maria.schmidt@example.com",
"phone": "+4930123456789",
"sex": 2,
"date_of_birth": "1985-03-22",
"height": 168,
"weight": 65,
"language": "de",
"transactional_emails_enabled": true,
"created_at": "2026-04-01T09:14:32Z",
"updated_at": "2026-04-01T11:05:00Z"
}
{
"error": "id: Invalid profile ID format"
}
{
"error": "Profile not found"
}