Skip to main content
GET
/
api
/
v1
/
shipments
/
{id}
/
appointments
curl --request GET \
  --url https://anivahealth.com/api/v1/shipments/P2604154821/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-15T10:30:00+02:00",
    "status": "blood_drawn",
    "test_method": "practitioner",
    "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"
      }
    ]
  }
]
Returns the full appointment objects linked to this shipment, oldest-link first. Mirror of List Appointment Shipments. Empty array when no appointments are linked. To check just the IDs without the full appointment payloads, read the appointments field on Get Shipment.
Requires shipments_manage or test_sessions_view scope.

​
Request

​
Path parameters

​
id
string
required
Shipment reference ID (e.g., P2604154821).

​
Response

On success, the API returns 200 OK with an array of appointment objects. Each entry has the same shape as Get Appointment.

​
Error responses

StatusDescription
400Invalid ID format.
403Forbidden — your API key does not have access to this operation or the shipment is outside your access context.
404Shipment not found.
500Internal server error.
curl --request GET \
  --url https://anivahealth.com/api/v1/shipments/P2604154821/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-15T10:30:00+02:00",
    "status": "blood_drawn",
    "test_method": "practitioner",
    "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"
      }
    ]
  }
]