Perfis
Listar perfis
Listar ou procurar perfis de pacientes por email
GET
/
api
/
v1
/
profiles
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?email=maria.schmidt@example.com' \
--header 'x-api-key: YOUR_API_KEY'
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?limit=50&offset=0' \
--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": "email: Invalid email format"
}
Lista os perfis de pacientes acessíveis à tua chave de API ou procura um pelo endereço de email exato.
Quando
email é fornecido, o endpoint faz uma pesquisa exata em cache Redis pelo
email canónico de início de sessão e devolve 0 ou 1 resultado; limit e offset são ignorados nesse
caso. Quando omitido, o endpoint devolve uma lista paginada de perfis limitada ao contexto de acesso da tua chave
de API.
A correspondência de email não distingue maiúsculas de minúsculas e é exata — não são suportadas correspondências parciais nem por prefixo.
Apenas o email canónico de início de sessão é verificado; endereços alternativos como work_email não são
considerados.
Requer o scope profiles_view ou impersonate.
Pedido
Parâmetros de consulta
Filtra pelo endereço de email exato (sem distinção entre maiúsculas e minúsculas). Quando definido, devolve 0 ou 1 resultado e
limit/offset são ignorados. A pesquisa usa um índice invertido em cache Redis, com fallback
para SQL indexado.Número máximo de perfis a devolver. O valor predefinido é 100 e o máximo é 500. Ignorado quando
email está definido.Número de perfis a ignorar para paginação. O valor predefinido é 0. Ignorado quando
email está definido.Resposta
Em caso de sucesso, a API devolve200 OK com um array de objetos de perfil. A estrutura de cada
entrada corresponde a Obter 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.Notas de comportamento
- É devolvido um array vazio tanto quando nenhum perfil corresponde ao email como quando existe uma correspondência fora do teu contexto de acesso. Isto é intencional — impede que o endpoint revele a existência de perfis que não consegues ler.
- Os perfis recém-criados podem ser encontrados de imediato por
emailporque o fluxo de criação aquece a cache de forma síncrona. - A lista sem filtros é ordenada por
created_atde forma descendente (mais recentes primeiro) e paginada através delimiteoffset.
Chamadas repetidas
A Aniva guarda a resposta deste endpoint durante 5 minutos por cada chave API. Uma chamada repetida dentro deste período recebe a resposta guardada. Os cabeçalhosCache-Status e Age mostram que a resposta está
guardada e há quanto tempo.
Para saberes de imediato quando há uma alteração, subscreve os eventos de webhook profile.created, profile.updated e profile.deleted.
Vê Leituras repetidas.
Respostas de erro
| Estado | Descrição |
|---|---|
400 | Erro de validação — formato de email inválido, ou limit/offset fora do intervalo permitido. |
403 | Proibido — a tua chave de API não tem o scope necessário (profiles_view/impersonate). |
500 | Erro interno do servidor. |
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?email=maria.schmidt@example.com' \
--header 'x-api-key: YOUR_API_KEY'
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?limit=50&offset=0' \
--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": "email: Invalid email format"
}
⌘I
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?email=maria.schmidt@example.com' \
--header 'x-api-key: YOUR_API_KEY'
curl --request GET \
--url 'https://anivahealth.com/api/v1/profiles?limit=50&offset=0' \
--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": "email: Invalid email format"
}