REST API for managing scheduling entities such as appointments.
An appointment is a scheduled interaction between a staff member and a person at a given time.
Status: Alpha — Breaking changes expected.
https://api.example.com/schedulingAppointments
Manage appointments.
▶
GET
/appointments
List appointments
#
Retrieve a paginated list of appointments.
| Name | Type | In | Req | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ▶q | string | query | Search query using field:value syntax. Multiple conditions separated by | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Search query using field:value syntax. Multiple conditions separated by spaces are ANDed together. URL Encoding: This parameter must be URL-encoded when sent over HTTP. Most HTTP clients handle this automatically. Examples in this documentation show human-readable syntax for clarity. Syntax
ListsA condition on a list matches when any item matches. That holds for a list of values ( Each condition is checked on its own. Examples
URL Encoding ReferenceWhen manually constructing URLs, encode these characters:
Example: `` | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| limit | integer | query | Maximum number of items to return (1-100). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| offset | integer | query | Number of items to skip before collecting results. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ▶sort | string | query | Comma-separated list of fields to sort the response by. Prefix a field | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comma-separated list of fields to sort the response by. Prefix a field with URL Encoding: This parameter must be URL-encoded when sent over HTTP. Most HTTP clients handle this automatically. Examples below show human-readable syntax for clarity. Which fields a given list endpoint allows is declared in the operation's See Syntax
Examples
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
▶ AppointmentList
▶ items array[Appointment] required
scheduled completed canceled no_show▶ BadRequest
▶ InternalError
▶
POST
/appointments
Create an appointment
#
Create a new appointment record.
▶ AppointmentCreate
scheduled completed canceled no_show▶ Appointment
scheduled completed canceled no_show▶ BadRequest
▶ Conflict
▶ UnprocessableEntity
▶ InternalError
▶
GET
/appointments/{appointmentId}
Get an appointment
#
Retrieve a single appointment by identifier.
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| appointmentId | string | path | ✓ | Unique identifier of the appointment. |
▶ Appointment
scheduled completed canceled no_show▶ NotFound
▶ InternalError
▶
PATCH
/appointments/{appointmentId}
Update an appointment
#
Apply partial updates to an existing appointment.
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| appointmentId | string | path | ✓ | Unique identifier of the appointment. |
▶ AppointmentUpdate
scheduled completed canceled no_show▶ Appointment
scheduled completed canceled no_show▶ BadRequest
▶ NotFound
▶ UnprocessableEntity
▶ InternalError
▶
DELETE
/appointments/{appointmentId}
Delete an appointment
#
Permanently remove an appointment record.
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| appointmentId | string | path | ✓ | Unique identifier of the appointment. |