| Argument | Type | Description |
|---|---|---|
idrequired | ID! | Unique identifier |
query($id: ID!) { appointment(id: $id) { id # Add other fields you need }}{ "id": "1"}query( $patientId: ID!, $start: DateTime) { appointmentReminders( patientId: $patientId, start: $start ) { id # Add other fields you need }}{ "patientId": "1", "start": {}}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | ID of resource to lookup |
query($id: ID!) { appointmentTypeTag(id: $id) { id # Add other fields you need }}{ "id": "1"}query( $locationId: ID, $name: String) { appointmentTypeTags( locationId: $locationId, name: $name ) { id # Add other fields you need }}{ "locationId": "1", "name": "example"}| Argument | Type | Description |
|---|---|---|
deleted | Boolean | Include deleted records in results |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $deleted: Boolean, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { appointmentTypes( deleted: $deleted, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "deleted": true, "updatedAtEnd": {}, "updatedAtStart": {}}Get a list of appointments either by location id or provider id
| Argument | Type | Description |
|---|---|---|
appointmentTypeIds | [Int] | List of appointment type IDs to filter by |
apptOnly | Boolean | only return patient appointments (not events) |
clientId | ID | ID of the client (pet owner) |
daycareOnly | Boolean | only return daycare appointments |
end | DateTime | Ending point for the range |
historicalId | String | ID of the historical |
ids | [ID] | List of IDs |
includeCompleted | Boolean | Include completed |
includeDeleted | Boolean | Include deleted |
isLive | Boolean | is not completed |
isOngoing | Boolean | is checked in or in-progress |
limit | Int | Maximum number of results to return |
locationId | ID | ID of the location |
offset | Int | Number of results to skip for pagination |
onlyDeleted | Boolean | only return deleted appts (normally deleted appts are hidden) |
onlyToday | Boolean | Only today |
patientId | ID | ID of the patient |
patientIds | [ID] | List of patient IDs |
providerId | ID | ID of the provider |
start | DateTime | Starting point for the range |
statuses | [AppointmentStatus] | show only certain statuses |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $appointmentTypeIds: [Int], $apptOnly: Boolean, $clientId: ID, $daycareOnly: Boolean, $end: DateTime, $historicalId: String, $ids: [ID], $includeCompleted: Boolean, $includeDeleted: Boolean, $isLive: Boolean, $isOngoing: Boolean, $limit: Int, $locationId: ID, $offset: Int, $onlyDeleted: Boolean, $onlyToday: Boolean, $patientId: ID, $patientIds: [ID], $providerId: ID, $start: DateTime, $statuses: [AppointmentStatus], $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { appointments( appointmentTypeIds: $appointmentTypeIds, apptOnly: $apptOnly, clientId: $clientId, daycareOnly: $daycareOnly, end: $end, historicalId: $historicalId, ids: $ids, includeCompleted: $includeCompleted, includeDeleted: $includeDeleted, isLive: $isLive, isOngoing: $isOngoing, limit: $limit, locationId: $locationId, offset: $offset, onlyDeleted: $onlyDeleted, onlyToday: $onlyToday, patientId: $patientId, patientIds: $patientIds, providerId: $providerId, start: $start, statuses: $statuses, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "appointmentTypeIds": 1, "apptOnly": true, "clientId": "1", "daycareOnly": true, "end": {}, "historicalId": "example", "ids": "1", "includeCompleted": true, "includeDeleted": true, "isLive": true, "isOngoing": true, "limit": 1, "locationId": "1", "offset": 1, "onlyDeleted": true, "onlyToday": true, "patientId": "1", "patientIds": "1", "providerId": "1", "start": {}, "statuses": {}, "updatedAtEnd": {}, "updatedAtStart": {}}query( $appointmentTypeId: ID!, $date: Date!, $firstAvailable: Boolean, $locationId: ID!, $numberOfPets: Int) { availableTimes( appointmentTypeId: $appointmentTypeId, date: $date, firstAvailable: $firstAvailable, locationId: $locationId, numberOfPets: $numberOfPets ) { id # Add other fields you need }}{ "appointmentTypeId": "1", "date": {}, "firstAvailable": true, "locationId": "1", "numberOfPets": 1}Count the number of appointments in a range from start to end segmented into days, weeks, months, years.
| Argument | Type | Description |
|---|---|---|
end | DateTime | Ending point for the range |
segmentrequired | TimeSegment! | Segment |
start | DateTime | Starting point for the range |
query( $end: DateTime, $segment: TimeSegment!, $start: DateTime) { countAppointmentProviders( end: $end, segment: $segment, start: $start ) { id # Add other fields you need }}{ "end": {}, "segment": {}, "start": {}}Count the number of appointments in a range from start to end segmented into days, weeks, months, years.
| Argument | Type | Description |
|---|---|---|
end | DateTime | Ending point for the range |
segmentrequired | TimeSegment! | Segment |
start | DateTime | Starting point for the range |
query( $end: DateTime, $segment: TimeSegment!, $start: DateTime) { countAppointments( end: $end, segment: $segment, start: $start ) { id # Add other fields you need }}{ "end": {}, "segment": {}, "start": {}}Count the number of appointments by a certain provider id
| Argument | Type | Description |
|---|---|---|
end | DateTime | Ending point for the range |
segmentrequired | TimeSegment! | Segment |
start | DateTime | Starting point for the range |
query( $end: DateTime, $segment: TimeSegment!, $start: DateTime) { countViewerAppointments( end: $end, segment: $segment, start: $start ) { id # Add other fields you need }}{ "end": {}, "segment": {}, "start": {}}Get a list of appointments types which are either enabled globally, or enabled for the given location
query( $includeDeleted: Boolean, $limit: Int, $locationId: ID!, $offset: Int) { locationAppointmentTypes( includeDeleted: $includeDeleted, limit: $limit, locationId: $locationId, offset: $offset ) { id # Add other fields you need }}{ "includeDeleted": true, "limit": 1, "locationId": "1", "offset": 1}query( $locationId: ID, $patientId: ID) { locationSchedules( locationId: $locationId, patientId: $patientId ) { id # Add other fields you need }}{ "locationId": "1", "patientId": "1"}| Argument | Type | Description |
|---|---|---|
idrequired | ID! | ID of resource to lookup |
query($id: ID!) { scheduleTemplate(id: $id) { id # Add other fields you need }}{ "id": "1"}| Argument | Type | Description |
|---|---|---|
locationId | ID | ID of the location |
updatedAtEnd | NaiveDateTime | Updated at end |
updatedAtStart | NaiveDateTime | Updated at start |
query( $locationId: ID, $updatedAtEnd: NaiveDateTime, $updatedAtStart: NaiveDateTime) { scheduleTemplates( locationId: $locationId, updatedAtEnd: $updatedAtEnd, updatedAtStart: $updatedAtStart ) { id # Add other fields you need }}{ "locationId": "1", "updatedAtEnd": {}, "updatedAtStart": {}}| Argument | Type | Description |
|---|---|---|
appointmentIdrequired | ID! | ID of the appointment |
query($appointmentId: ID!) { selfCheckInLink(appointmentId: $appointmentId) { id # Add other fields you need }}{ "appointmentId": "1"}