Appointments
Availabilities
Availability Slots
Clients
List all appointments
curl --request GET \
--url https://api.caspen.com/v1/appointments{
"data": [
{
"id": "<string>",
"location_id": "<string>",
"practitioner_id": "<string>",
"service_id": "<string>",
"client_id": "<string>",
"client_package_id": "<string>",
"case_id": "<string>",
"starts_at": "<string>",
"ends_at": "<string>",
"duration": 123,
"status": "<string>",
"confirmed": true,
"confirmed_at": "<string>",
"room_id": "<string>",
"vehicle_id": "<string>",
"resource_ids": [
"<string>"
],
"note": "<string>",
"cancellation_reason_id": "<string>",
"cancellation_note": "<string>",
"cancelled_at": "<string>",
"created_at": "<string>"
}
],
"links": {
"prev": "<string>",
"next": "<string>"
}
}Response
Paginated set of AppointmentResource
Show child attributes
Show child attributes
The appointment's unique identifier.
The location identifier where the appointment takes place.
The practitioner identifier who provides the service.
The service identifier being provided.
The client identifier who has the appointment.
The client package identifier if this appointment uses a package.
The case identifier if this appointment is part of a case.
The appointment start time (ISO 8601).
The appointment end time (ISO 8601).
The appointment duration in minutes.
The appointment status.
Whether the appointment is confirmed.
When the appointment was confirmed (ISO 8601).
The room identifier where the appointment takes place.
The vehicle identifier if transportation is involved.
The IDs of resources required for this appointment.
The appointment note.
The cancellation reason identifier if cancelled.
The cancellation note if cancelled.
When the appointment was cancelled (ISO 8601).
The timestamp when the appointment was created (ISO 8601).
curl --request GET \
--url https://api.caspen.com/v1/appointments{
"data": [
{
"id": "<string>",
"location_id": "<string>",
"practitioner_id": "<string>",
"service_id": "<string>",
"client_id": "<string>",
"client_package_id": "<string>",
"case_id": "<string>",
"starts_at": "<string>",
"ends_at": "<string>",
"duration": 123,
"status": "<string>",
"confirmed": true,
"confirmed_at": "<string>",
"room_id": "<string>",
"vehicle_id": "<string>",
"resource_ids": [
"<string>"
],
"note": "<string>",
"cancellation_reason_id": "<string>",
"cancellation_note": "<string>",
"cancelled_at": "<string>",
"created_at": "<string>"
}
],
"links": {
"prev": "<string>",
"next": "<string>"
}
}