v1

latestSwagger 2.02026-08-043765135.6 KB

appointments

Get Appointments

Retrieve all existing appointments.

get/appointments

Query parameters

mockboolean

Return mock data

idstring[]

scheduledStartDateTimestring date-time

This is the date and time that an appointment is scheduled to start.

scheduledEndDateTimestring date-time

This is the date and time that an appointment is scheduled to end.

actualStartDateTimestring date-time

This is the date and time that an appointment actually started. This field should not be set until the appointment has started.

actualEndDateTimestring date-time

This is the date and time that an appointment actually ended. This field should not be set until the appointment has ended.

startDateRangestring date-time

Limit your query to appointments with scheduledStartDateTime or scheduledEndDateTime falling between queryStartDateRange and queryEndDateRange

endDateRangestring date-time

Limit your query to appointments with scheduledStartDateTime or scheduledEndDateTime falling between queryStartDateRange and queryEndDateRange

perPageinteger

Query parameter to set the number of results per page

pageAfterstring

Query parameter to set the token for the next page of results

orderBystring

Field by which to order results

order'asc' | 'desc'

Specify the order of the returned data based on the field specified in "orderBy".

organizationIdstring uuid

Query by organization UUID

statusstring

Query by the current status appointment status. Valid options are "requested, confirmed, canceled, checkedIn, noShow, occurred"

resourceUristring string

Query by resourceUri

Response

Return an array of data responses

Example response

{
  "data": [
    {
      "attributes": {
        "createdAt": "2018-02-03T10:30:00Z",
        "updatedAt": "2018-02-03T10:30:00Z",
        "scheduledStartDateTime": "2018-02-03T10:30:00Z",
        "scheduledEndDateTime": "2018-02-03T10:30:00Z",
        "actualStartDateTime": "2018-02-03T10:30:00Z",
        "actualEndDateTime": "2018-02-03T10:30:00Z"
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": "bdb88373-bf66-4bfc-a4f8-3a35be5c2f9c"
          }
        },
        "resources": {
          "data": [
            {
              "type": "customers",
              "id": "00000000-0000-0000-0000-000000000069"
            }
          ]
        },
        "answers": {
          "data": [
            {
              "type": "answers",
              "id": "00000000-0000-0000-0000-000000000069"
            }
          ]
        }
      }
    }
  ]
}