Envios
Listar marcações do envio
Listar as marcações associadas a um envio
GET
/
api
/
v1
/
shipments
/
{id}
/
appointments
curl --request GET \
--url https://anivahealth.com/api/v1/shipments/P2611194821/appointments \
--header 'x-api-key: YOUR_API_KEY'
[
{
"id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
"profile_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
"scheduled_at": "2026-04-15T08:30:00Z",
"status": "blood_drawn",
"created_at": "2026-04-01T10:00:00Z",
"updated_at": "2026-04-15T09:00:00Z",
"profile": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"date_of_birth": "1990-06-15",
"sex": 2
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-04-01T10:05:00Z"
}
],
"individual_biomarkers": [],
"shipments": [
{
"id": "P2611194821",
"added_at": "2026-04-15T07:00:00Z"
}
]
}
]
{
"error": "Shipment not found"
}
Devolve os objetos completos das marcações associadas a este envio que estão no teu contexto de
acesso, pela ligação mais antiga primeiro. A leitura inversa
é Listar envios com
?appointment_id=.
Array vazio quando não há marcações associadas. Para veres apenas os IDs sem os payloads completos
das marcações, lê o campo appointments em Obter envio.
Requer o scope shipments_view, shipments_manage ou appointments_view.
Pedido
Parâmetros de caminho
Resposta
Em caso de sucesso, a API devolve200 OK com um array de objetos de marcação. Cada entrada tem o
mesmo formato que Obter marcação.
Respostas de erro
| Estado | Descrição |
|---|---|
400 | Formato de ID inválido. |
403 | Proibido — a tua chave de API não tem acesso a esta operação ou o envio está fora do teu contexto de acesso. |
404 | Envio não encontrado. |
500 | Erro interno do servidor. |
curl --request GET \
--url https://anivahealth.com/api/v1/shipments/P2611194821/appointments \
--header 'x-api-key: YOUR_API_KEY'
[
{
"id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
"profile_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
"scheduled_at": "2026-04-15T08:30:00Z",
"status": "blood_drawn",
"created_at": "2026-04-01T10:00:00Z",
"updated_at": "2026-04-15T09:00:00Z",
"profile": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"date_of_birth": "1990-06-15",
"sex": 2
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-04-01T10:05:00Z"
}
],
"individual_biomarkers": [],
"shipments": [
{
"id": "P2611194821",
"added_at": "2026-04-15T07:00:00Z"
}
]
}
]
{
"error": "Shipment not found"
}
⌘I
curl --request GET \
--url https://anivahealth.com/api/v1/shipments/P2611194821/appointments \
--header 'x-api-key: YOUR_API_KEY'
[
{
"id": "c9f3e2a1-7d6b-4c5e-b3a2-1f0e9d8c7b6a",
"profile_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"location_id": "b7e2d1f5-3c4a-4e8b-a2f1-9d0c1e2f3a4b",
"scheduled_at": "2026-04-15T08:30:00Z",
"status": "blood_drawn",
"created_at": "2026-04-01T10:00:00Z",
"updated_at": "2026-04-15T09:00:00Z",
"profile": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"date_of_birth": "1990-06-15",
"sex": 2
},
"panels": [
{
"panel_id": "f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d",
"added_at": "2026-04-01T10:05:00Z"
}
],
"individual_biomarkers": [],
"shipments": [
{
"id": "P2611194821",
"added_at": "2026-04-15T07:00:00Z"
}
]
}
]
{
"error": "Shipment not found"
}