Skip to main content
GET
Get Appointment

Authorizations

Authorization
string
header
required

Consumer JWT minted by the tenant's backend

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Path Parameters

id
string
required

Query Parameters

fields
string

Comma-separated top-level fields to return; the parameter can also be repeated, once per field. id is always returned. Omit it, or pass allFields, to get every field, including original. Unknown names return 400.

Response

Response for status 200

id
string
required
personId
string | null

Present unless the request's fields leaves it out.

userId
string | null

Present unless the request's fields leaves it out.

createdById
string | null

Present unless the request's fields leaves it out.

updatedById
string | null

Present unless the request's fields leaves it out.

appointmentOutcomeId
string | null

Present unless the request's fields leaves it out.

appointmentTypeId
string | null

Present unless the request's fields leaves it out.

invitees
object[]

Present unless the request's fields leaves it out.

title
string

Present unless the request's fields leaves it out.

description
string

Present unless the request's fields leaves it out.

location
string

Present unless the request's fields leaves it out.

isAllDay
boolean

Present unless the request's fields leaves it out.

type
string

Present unless the request's fields leaves it out.

outcome
string

Present unless the request's fields leaves it out.

outcomeReason
string

Present unless the request's fields leaves it out.

isCompleted
boolean | null

Present unless the request's fields leaves it out.

isOverdue
boolean | null

Present unless the request's fields leaves it out.

completedAt
string | null

Present unless the request's fields leaves it out.

startsAt
string | null

Present unless the request's fields leaves it out.

endsAt
string | null

Present unless the request's fields leaves it out.

created
string | null

Present unless the request's fields leaves it out.

updated
string | null

Present unless the request's fields leaves it out.

rolloutUpdated
string

Present unless the request's fields leaves it out.

originalIds
object

Present unless the request's fields leaves it out.

original
object

Present unless the request's fields leaves it out.