Envíos
Listar citas del envío
Listar las citas vinculadas a un envío
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"
}
Devuelve los objetos completos de las citas vinculadas a este envío que estén dentro de tu contexto de acceso,
empezando por el vínculo más antiguo. La lectura inversa
es Listar envíos con
?appointment_id=.
Array vacío cuando no hay citas vinculadas. Para consultar solo los ID sin los datos completos
de las citas, lee el campo appointments en Obtener envío.
Requiere el scope shipments_view, shipments_manage o appointments_view.
Solicitud
Parámetros de ruta
Respuesta
En caso de éxito, la API devuelve200 OK con un array de objetos de cita. Cada entrada tiene la
misma estructura que Obtener cita.
Respuestas de error
| Estado | Descripción |
|---|---|
400 | Formato de ID no válido. |
403 | Prohibido: tu clave de API no tiene acceso a esta operación o el envío está fuera de tu contexto de acceso. |
404 | Envío no encontrado. |
500 | Error interno del 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"
}