v2

latestOpenAPI 3.1.12026-08-078549932.4 MB

ScheduleItems

Get a paginated and filtered list of schedule items

get/ScheduleItems

Query parameters

integer

string int32

Page number (default: 1)

integer

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

Response

Paginated list of schedule items

Example response

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