Browse available locations
Retrieve the list of test locations available on your account by sending a The response is an array of location objects:
GET request to /api/v1/locations.Create the appointment
Send a A successful request returns Save the appointment
POST request to /api/v1/appointments with the profile ID, location ID, and your desired appointment time.scheduled_at must be a future datetime in ISO 8601 format, for example 2026-05-12T09:30:00+02:00. Timestamps in the past are rejected with a 400 error.201 Created with the appointment object:id — you’ll need it to add panels and confirm the blood draw.Add test panels
Attach the test panels you want run on the blood sample by sending a A successful request returns
POST request to /api/v1/appointments/{id}/panels.Panel IDs are UUIDs provided by Aniva for your partner account. Contact Aniva if you need the list of available panel IDs.200 OK confirming the panels have been added:Rescheduling or cancelling
After creating an appointment, you can still modify it before the blood draw is confirmed:- Reschedule or change location — Send a
PATCHrequest to/api/v1/appointments/{id}with the fields to update. See Update Appointment. - Cancel — Send a
DELETErequest to/api/v1/appointments/{id}. See Cancel Appointment.
Both operations are only available before the blood draw — i.e. while the appointment is in
pending or confirmed status. Once the appointment moves to blood_drawn, no further
modifications are possible.Error handling
| Status | Cause | Resolution |
|---|---|---|
400 Bad Request | A required field is missing, scheduled_at is in the past, or panel_ids is empty. | Check the error body for the validation message and correct the request. |
403 Forbidden | Your API key does not have access to this operation. | Contact Aniva to confirm your API key permissions. |
404 Not Found | The profile_id or location_id does not exist, or the appointment ID is invalid when adding panels. | Verify the IDs are correct and belong to your account. |
409 Conflict | You attempted to add panels to or modify an appointment that has already been confirmed or cancelled. | No further changes are possible after confirmation. |