client.appointmentsOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/appointmentsappointments.list
Lists native and provider-managed appointment metadata. Private foreign appointments are redacted; provider identifiers, participants, recurrence payloads, and tokens are never returned.
client.appointments.list(options: CalendarListOptions)- Return form
Promise- Operation ID
listAppointments- Required scopes
appointments:read- Conditional scopes
appointments:delegated:read- SDK parameters
options: CalendarListOptions- Query request fields
cursor?: stringlimit?: integerarchived?: booleanstart: stringend: stringuserId?: Array<string>- Success
200 Array<Appointment> envelope
/appointmentsappointments.create
The cell-local App re-authenticates the credential, derives the acting user from the credential principal, and applies tenant, sharing, plan, idempotency, and provider-management policy.
client.appointments.create(data: AppointmentCreate, options: MutationOptions = {})- Return form
Promise- Operation ID
createAppointment- Required scopes
appointments:write- Conditional scopes
appointments:delegated:write- SDK parameters
data: AppointmentCreateoptions: MutationOptions- Header request fields
Idempotency-Key: string- Request body
AppointmentCreateapplication/json- Success
201 Appointment envelope
/appointments/{id}appointments.get
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.
client.appointments.get(id: string, options?: RequestOptions)- Return form
Promise- Operation ID
getAppointment- Required scopes
appointments:read- Conditional scopes
appointments:delegated:read- SDK parameters
id: stringoptions: RequestOptions- Path request fields
id: string- Success
200 Appointment envelope
/appointments/{id}appointments.update
Requires the latest strong resource ETag. The cell-local App re-authenticates and atomically applies the tenant-bound revision before returning a fresh ETag.
client.appointments.update(id: string, data: AppointmentUpdate, options: AppointmentMutationOptions)- Return form
Promise- Operation ID
updateAppointment- Required scopes
appointments:write- Conditional scopes
appointments:delegated:write- SDK parameters
id: stringdata: AppointmentUpdateoptions: AppointmentMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Request body
AppointmentUpdateapplication/json- Success
200 Appointment envelope
/appointments/{id}appointments.archive
Requires the latest strong resource ETag. The cell-local App re-authenticates and atomically applies the tenant-bound revision before returning a fresh ETag.
client.appointments.archive(id: string, options: AppointmentMutationOptions)- Return form
Promise- Operation ID
archiveAppointment- Required scopes
appointments:write- Conditional scopes
appointments:delegated:write- SDK parameters
id: stringoptions: AppointmentMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Success
200 Appointment envelope
/appointments/{id}/restoreappointments.restore
Requires the latest strong resource ETag. The cell-local App re-authenticates and atomically applies the tenant-bound revision before returning a fresh ETag.
client.appointments.restore(id: string, options: AppointmentMutationOptions)- Return form
Promise- Operation ID
restoreAppointment- Required scopes
appointments:write- Conditional scopes
appointments:delegated:write- SDK parameters
id: stringoptions: AppointmentMutationOptions- Path request fields
id: string- Header request fields
If-Match: string- Success
200 Appointment envelope
Convenience helpers
These typed helpers compose mapped operations. They do not grant scopes or bypass API limits.
appointments.pages
Iterate cursor pages with a bounded PaginationOptions policy.
client.appointments.pages(options: CalendarListOptions, pagination?: PaginationOptions)AsyncGeneratorErrors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.