Skip to main content
GET
List a client's appointment history

Path Parameters

clientId
string
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Query Parameters

type
enum<string>

History view filter. When visits, return the full past history (completed visits, cancellations, and no-shows). When noShows, return only no-show appointments. When omitted, return the full past history. History view filter for a client's past appointments. visits is the full past history. noShows returns only no-shows.

Available options:
visits,
noShows
offset
integer<int16>
default:0

The offset for pagination. Defaults to 0.

Required range: 0 <= x <= 32767
limit
integer<int16>
default:20

The maximum number of results to return. Defaults to 20.

Required range: 1 <= x <= 100

Response

Ok. The operation succeeded.

A paginated list of a client's past appointments, newest first.

items
object[]
required
count
integer<int16>
required
Required range: x >= 0
offset
integer<int16>
required

The offset of list results for the current page.

Required range: x >= 0
limit
integer<int16>
required

The maximum number of results included in items.

Required range: x >= 0