> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter perfil

> Obter um perfil de paciente por ID

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

**id** `string` *required*

Identificador único (UUID) do perfil a obter.

## Resposta

Em caso de sucesso, a API devolve `200 OK` com o perfil.

**id** `string` *required*

Identificador único do perfil (UUID).

**handle** `string`

Handle ou nome de utilizador do perfil. Pode ser `null`.

**first\_name** `string`

Nome próprio. Pode ser `null`.

**last\_name** `string`

Apelido. Pode ser `null`.

**email** `string`

Endereço de email. Pode ser `null`.

**phone** `string`

Número de telefone no formato E.164. Pode ser `null`.

**sex** `integer`

Sexo biológico segundo a norma ISO/IEC 5218 (`0` = desconhecido, `1` = masculino, `2` = feminino). Pode ser `null`.

**date\_of\_birth** `string`

Data de nascimento no formato `YYYY-MM-DD`. Pode ser `null`.

**height** `number`

Altura em centímetros. Pode ser `null`.

**weight** `number`

Peso em quilogramas. Pode ser `null`.

**language** `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`.

**transactional\_emails\_enabled** `boolean`

Indica se este perfil recebe emails transacionais (programáticos). `null` quando nunca foi definido.

**created\_at** `string`

Carimbo de data/hora ISO 8601 da criação do perfil.

**updated\_at** `string`

Data e hora ISO 8601 da última atualização. Pode ser `null`.

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

```bash cURL theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/profiles/a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d \
  --header 'x-api-key: YOUR_API_KEY'
```

```json 200 theme={null}
{
  "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"
}
```

```json 400 theme={null}
{
  "error": "id: Invalid profile ID format"
}
```

```json 404 theme={null}
{
  "error": "Profile not found"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.