CLclinicos
ScheduleItems

Get a paginated and filtered list of schedule items

Changed on
get/ScheduleItems

Request

Query parameters

integer
OR
string int32

Page number (default: 1)

integer
OR
string int32

Number of items per page (default: 20)

startDatestring date-time

Filter by start date

endDatestring date-time

Filter by end date

typestring

Filter by schedule item type

locationIdstring

Filter by location ID

assignedToIdstring

Filter by assigned user ID

excludeAppointmentsboolean

Exclude appointment-linked items

includeCareTeamboolean

With assignedToId, also match appointments where that user is a supporting care-team member (AppointmentCareTeam flag)

Response

Paginated list of schedule items

Example response

{
  "data": [
    {
      "appointment": {
        "patient": {
          "species": "Cat",
          "breed": "Siamese",
          "sex": "Male"
        }
      }
    }
  ]
}

Changes

  • 021fabd866ffRevision changes
    • info

      added the new optional query request parameter includeCareTeam

    • info

      added the optional property /////// to the response with the status (media type: text/plain)

    • info

      added the optional property /////// to the response with the status (media type: application/json)

    • info

      added the optional property /////// to the response with the status (media type: text/json)

  • 503cd0546309Revision changes
    • info

      added the optional property /// to the response with the status (media type: text/plain)

    • info

      added the optional property /// to the response with the status (media type: application/json)

    • info

      added the optional property /// to the response with the status (media type: text/json)