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

# Listar marcações

> Obter marcações de colheita de sangue acessíveis à tua chave de API

Obtém uma lista de marcações de colheita de sangue. Cada marcação inclui o perfil do paciente incorporado.

Os filtros combinam-se:

* `date` devolve as marcações de um dia de calendário. O dia é o dia local da localização de cada marcação, pelo que uma colheita de sangue às 23:30 em Berlim conta na sua data de Berlim.
* `location_id` devolve as marcações num local de análise.
* `profile_id` sem `date` devolve todas as marcações desse perfil, sem restrição temporal.
* Sem `profile_id` nem `date`, aplica-se a janela temporal predefinida: dos últimos 2 meses até 1 mês no futuro.

Requer o scope `appointments_view` ou `appointments_schedule`.

## Pedido

### Parâmetros de consulta

**profile\_id** `string`

Filtra por UUID do perfil. Quando fornecido, são devolvidas todas as marcações deste perfil independentemente
da data de agendamento. Quando omitido, aplica-se a janela temporal predefinida.

**location\_id** `string`

Filtra por UUID do local de análise.

**date** `string`

Dia de calendário no formato `YYYY-MM-DD`, no fuso horário da localização de cada marcação. Substitui a
janela temporal predefinida. Os resultados são ordenados por `scheduled_at`, mais cedo primeiro.

## Resposta

Em caso de sucesso, a API devolve `200 OK` com um array de objetos de marcação.

**id** `string` *required*

Identificador único da marcação (UUID).

**profile\_id** `string` *required*

UUID do perfil a que pertence esta marcação.

**location\_id** `string`

UUID do local de teste onde decorre a colheita de sangue.

**scheduled\_at** `string`

Data e hora agendada da marcação como instante UTC (ISO 8601 com sufixo `Z`, p. ex.,
`2026-05-15T10:30:00Z`). Pode ser `null`.

**status** `string` *required*

Estado atual da marcação. Um de `pending`, `confirmed`, `blood_drawn` ou `cancelled`. O detalhe
sobre a conclusão dos resultados laboratoriais obtém-se em
[Obter resultados](https://docs.anivahealth.com/pt/api/appointments/get-results.md); a progressão detalhada dos envios obtém-se a
partir de cada entrada no array `shipments` incorporado (vê abaixo) seguindo para
[Obter envio](https://docs.anivahealth.com/pt/api/shipments/get-shipment.md).

**cancellation\_reason** `string`

Motivo em texto livre registado quando a marcação foi cancelada (p. ex., falta de comparência, cancelamento tardio,
'Falhou. Repetição necessária'). `null`, exceto quando `status` é `cancelled`.

**results\_ready\_emails** `string[]` *required*

Endereços que recebem um e-mail assim que todos os resultados laboratoriais forem definitivos, em minúsculas. Vazio quando desativado. Consulta
[E-mails de resultados prontos](https://docs.anivahealth.com/pt/concepts/results.md#e-mails-de-resultados-prontos).

**draw\_method** `string` *required*

Como o sangue é colhido: `capillary` (ponta do dedo ou parte superior do braço, em microtubos) ou `venous` (na veia,
em tubos). É o método definido na marcação ou, caso contrário, o `default_draw_method` do respetivo
[local](https://docs.anivahealth.com/pt/concepts/locations.md). Após a colheita de sangue, é o método que foi utilizado.

**created\_at** `string` *required*

Data e hora ISO 8601 da criação da marcação.

**updated\_at** `string`

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

**profile** `object` *required*

O perfil do paciente associado a esta marcação.

**perfil**

**id** `string`

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 e-mail. 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. 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: um dos 32 códigos em [Criar perfil](https://docs.anivahealth.com/pt/api/profiles/create-profile.md).

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

Se este perfil recebe e-mails transacionais (programáticos). Pode ser `null`.

**created\_at** `string`

Data e hora ISO 8601 da criação do perfil.

**updated\_at** `string`

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

**panels** `AppointmentPanel[]` *required*

Painéis atualmente associados a esta marcação. Exclui associações canceladas. Consulta os detalhes
do painel (nome, biomarcadores) através de [Listar painéis](https://docs.anivahealth.com/pt/api/panels/list-panels.md).

**Campos de associação de painel**

**panel\_id** `string`

UUID do painel — cruza com [Listar painéis](https://docs.anivahealth.com/pt/api/panels/list-panels.md).

**added\_at** `string`

Data e hora ISO 8601 em que o painel foi associado pela primeira vez a esta marcação.

**individual\_biomarkers** `AppointmentIndividualBiomarker[]` *required*

Biomarcadores avulsos associados a esta marcação fora de qualquer painel (consulta [Adicionar biomarcadores
personalizados](https://docs.anivahealth.com/pt/api/appointments/add-individual-biomarkers.md)). Cruza cada `biomarker_id`
com [Listar biomarcadores](https://docs.anivahealth.com/pt/api/biomarkers/list-biomarkers.md) para obter os dados de apresentação.

**Campos de biomarcador individual**

**biomarker\_id** `integer`

Identificador do biomarcador — cruza com
[Listar biomarcadores](https://docs.anivahealth.com/pt/api/biomarkers/list-biomarkers.md).

**added\_at** `string`

Data e hora ISO 8601 em que o biomarcador foi associado pela primeira vez a esta marcação.

**shipments** `AppointmentShipmentLink[]` *required*

Envios associados a esta marcação, com a associação mais antiga primeiro. Array vazio quando não há envios
associados. Cruza cada `id` com [Obter envio](https://docs.anivahealth.com/pt/api/shipments/get-shipment.md) para obter o
payload completo do envio (estado, número de seguimento, atualizações de estado, etc.).

**Campos de associação de envio**

**id** `string`

Identificador de referência do envio — cruza com
[Obter envio](https://docs.anivahealth.com/pt/api/shipments/get-shipment.md).

**added\_at** `string`

Data e hora ISO 8601 em que o envio foi associado pela primeira vez a esta marcação.

**lab\_codes** `string[]` *required*

Códigos de laboratório (códigos de barras dos tubos) registados para esta marcação, por ordem de leitura. Vazio até a colheita de sangue
ser confirmada. Uma colheita venosa tem um código impresso em todos os tubos; uma colheita capilar tem um
código por microtubo. Os resultados e documentos em [Obter resultados](https://docs.anivahealth.com/pt/api/appointments/get-results.md) referenciam
estes códigos através de `lab_code`.

## 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 logo de uma alteração, subscreve os eventos de webhook `appointment.created`, `appointment.rescheduled` e o evento de cada estado, por exemplo `appointment.confirmed`.
Consulta [Leituras repetidas](https://docs.anivahealth.com/pt/concepts/webhooks.md#leituras-repetidas).

## Respostas de erro

| Estado | Descrição |
| - | - |
| `400` | Parâmetro de consulta inválido, por exemplo uma `date` que não está no formato `YYYY-MM-DD`. |
| `403` | Proibido — a tua chave API não tem acesso a esta operação, ou o perfil ou localização pedidos estão fora do teu âmbito de permissões. |
| `500` | Erro interno do servidor. |

```bash cURL (all appointments) theme={null}
curl --request GET \
  --url https://anivahealth.com/api/v1/appointments \
  --header 'x-api-key: YOUR_API_KEY'
```

```bash cURL (one day at one location) theme={null}
curl --request GET \
  --url 'https://anivahealth.com/api/v1/appointments?date=2026-10-21&location_id=b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b' \
  --header 'x-api-key: YOUR_API_KEY'
```

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

```json 200 theme={null}
[
  {
    "id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
    "profile_id": "a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d",
    "location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
    "scheduled_at": "2026-05-15T10:30:00Z",
    "status": "confirmed",
    "cancellation_reason": null,
    "results_ready_emails": [],
    "draw_method": "venous",
    "created_at": "2026-04-01T09:45:00Z",
    "updated_at": null,
    "profile": {
      "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": null
    },
    "panels": [
      {
        "panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
        "added_at": "2026-04-01T09:50:00Z"
      }
    ],
    "individual_biomarkers": [
      {
        "biomarker_id": 42,
        "added_at": "2026-04-01T09:52:00Z"
      }
    ],
    "shipments": [
      {
        "id": "P2611194821",
        "added_at": "2026-04-15T07:00:00Z"
      }
    ],
    "lab_codes": []
  }
]
```

```json 403 theme={null}
{
  "error": "Access denied: profile is outside your permission scope"
}
```


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