/appointments/{id}Read operationGet an appointment
Use this operation to get an appointment. It returns the resource only when it belongs to the authenticated workspace and is visible to the credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
appointments:readappointments:delegated:readPrepare this request
The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.
Path parameters
1idrequiredStable identifier of the resource in the authenticated workspace.
Responses
8200The request to get an appointment succeeded. The response contains the canonical public result and request metadata.application/json
application/jsonPublic API representation of appointment.
The attributes associated with this appointment.
allDayrequiredWhether all day applies to this appointment attributes.
archivedrequiredWhether this resource is archived.
busyrequiredWhether busy applies to this appointment attributes.
createdAtrequiredTimestamp at which the resource was created.
descriptionrequiredHuman-readable description of the resource.
End timestamp of the represented interval.
atrequiredISO 8601 timestamp for at.
timeZonerequiredThe time zone associated with this appointment attributes end.
locationrequiredThe location associated with this appointment attributes.
managedByrequiredCanonical managed by value for this appointment attributes.
providerteamgridredactedrequiredWhether redacted applies to this appointment attributes.
revisionrequiredStrong resource revision used for optimistic concurrency control.
Start timestamp of the represented interval.
atrequiredISO 8601 timestamp for at.
timeZonerequiredThe time zone associated with this appointment attributes start.
titlerequiredHuman-readable title of the resource.
updatedAtrequiredTimestamp of the most recent successful update.
userIdrequiredIdentifier of the related workspace user.
visibilityrequiredCanonical visibility value for this appointment attributes.
defaultprivatepublicidrequiredStable TeamGrid identifier for this resource.
typerequiredCanonical type discriminator for this resource.
Public API representation of meta.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
400The request is invalid.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
401The bearer credential is missing, invalid, expired, or revoked.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
403The credential has insufficient scope.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
404The tenant-scoped resource does not exist.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
429The credential or source exceeded its rate limit.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
502The cell-local application returned an invalid response.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
503A required cell-local dependency is unavailable.application/json
application/jsonThe errors associated with this error.
coderequiredStable machine-readable code for programmatic error or state handling.
detailrequiredThe detail associated with this api error.
sourceThe source associated with this api error.
statusrequiredCanonical status of the resource or operation.
titlerequiredHuman-readable title of the resource.
Request metadata, including the request identifier and pagination state when applicable.
requestIdrequiredUnique identifier assigned to the API request for tracing and support.
Thank you. The rating contains no account or customer data.