List all appointments

Updated:

GET/dms/{connection_id}/appointment

Returns a list of DmsAppointments. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

Parameters

limitnumber default=100
offsetnumber default=0
updated_gtedate-time
Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sort enum
order enum
querystring
Query string to search. eg. email address or name
contact_idstring
The contact ID to filter by
vehicle_idstring
The DMS vehicle ID to filter by
user_idstring
The user/employee ID to filter by (reference to HrisEmployee)
status enum
start_gtestring
The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_ltstring
The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Returns

A service appointment (booking)

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
numberstring
Dealer-visible appointment number
status enum
Valid values:
"SCHEDULED"
"CONFIRMED"
"CONVERTED"
"CANCELLED"
"NO_SHOW"
contact_idstring
Customer, as a CRM Contact
vehicle_idstring
The DmsVehicle ID
vinstring
advisor_user_idstring
Service advisor, as an HR Employee (reference to HrisEmployee)
booked_by_user_idstring
Employee who booked the appointment, as an HR Employee (reference to HrisEmployee)
repairorder_idstring
The DmsRepairorder created from this appointment
start_atdate-time
Appointment (due-in) time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate-time
Promised ready (due-out) time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
transport_type enum
Valid values:
"WAITER"
"DROP_OFF"
"SHUTTLE"
"LOANER"
"RENTAL"
odometernumber
Odometer reported at booking
odometer_unit enum
Valid values:
"MILES"
"KILOMETERS"
"HOURS"
"OTHER"
notesstring
services array
Requested services
metadata array

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/dms/5de520f96e439b002043d8dc/appointment',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-01-01T00:00:00.000Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    contact_id: '',
    vehicle_id: '',
    user_id: '',
    status: '',
    start_gte: '',
    end_lt: '',
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?