Saltar para o conteúdo principal
GET
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

string
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.
integer
padrão:"100"
Número máximo de perfis a devolver. O valor predefinido é 100 e o máximo é 500. Ignorado quando email está definido.
integer
padrão:"0"
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 devolve 200 OK com um array de objetos de perfil. A estrutura de cada entrada corresponde a Obter perfil.
string
obrigatório
Identificador único do perfil (UUID).
string
Handle ou nome de utilizador do perfil. Pode ser null.
string
Nome próprio. Pode ser null.
string
Apelido. Pode ser null.
string
Endereço de email. Pode ser null.
string
Número de telefone no formato E.164. Pode ser null.
integer
Sexo biológico segundo a norma ISO/IEC 5218 (0 = desconhecido, 1 = masculino, 2 = feminino). Pode ser null.
string
Data de nascimento no formato YYYY-MM-DD. Pode ser null.
number
Altura em centímetros. Pode ser null.
number
Peso em quilogramas. Pode ser null.
string
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.
boolean
Indica se este perfil recebe emails transacionais (programáticos). null quando nunca foi definido.
string
Carimbo de data/hora ISO 8601 da criação do perfil.
string
Data e hora ISO 8601 da última atualização. Pode ser null.

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 email porque o fluxo de criação aquece a cache de forma síncrona.
  • A lista sem filtros é ordenada por created_at de forma descendente (mais recentes primeiro) e paginada através de limit e offset.

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çalhos Cache-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