client.availabilityOperation 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.
/availabilityavailability.list
Returns bounded free intervals derived in the credential cell. Source appointments, absence reasons, provider payloads, working-hour configuration, and personal calendar details are never exposed.
client.availability.list(options: AvailabilityListOptions)- Return form
Promise- Operation ID
listAvailability- Required scopes
availability:read- Conditional scopes
availability:delegated:read- SDK parameters
options: AvailabilityListOptions- Query request fields
start: stringend: stringtimeZone: stringuserId?: Array<string>- Success
200 Availability envelope
Errors 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.