get/availabilityRead operation

List user availability

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.

Required scopes

availability:read

Conditional scopes

availability:delegated:read

Request example

curl --request GET \
  --url 'https://api.de.teamgrid.app/v1/availability?start=2026-07-29T09%3A00%3A00Z&end=2026-07-29T09%3A00%3A00Z&timeZone=TIMEZONE' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN'

const response = await fetch('https://api.de.teamgrid.app/v1/availability?start=2026-07-29T09%3A00%3A00Z&end=2026-07-29T09%3A00%3A00Z&timeZone=TIMEZONE', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result = await response.json()

type ApiResponse = unknown

const response = await fetch('https://api.de.teamgrid.app/v1/availability?start=2026-07-29T09%3A00%3A00Z&end=2026-07-29T09%3A00%3A00Z&timeZone=TIMEZONE', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result: ApiResponse = await response.json()

teamgrid availability list \
  --output json

Example response 2xx

{
  "data": {
    "attributes": {
      "end": "2026-07-29T09:00:00.000Z",
      "start": "2026-07-29T09:00:00.000Z",
      "timeZone": "string",
      "users": [
        {
          "intervals": [
            null
          ],
          "userId": "string"
        }
      ]
    },
    "id": "string",
    "type": null
  },
  "meta": {
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

startquery · requiredendquery · requiredtimeZonequery · requireduserIdquery

Generated cURL

The builder does not execute requests or persist credentials. Replace the environment-variable placeholder only in your terminal or secret-aware runtime.

Query parameters

startrequired

string

Inclusive beginning of the bounded calendar interval.

endrequired

string

Exclusive end of the bounded calendar interval.

timeZonerequired

string

IANA time-zone name used to evaluate working hours.

userId

array<string>

One or more user ids. Foreign users additionally require a delegated scope and product sharing permission.

Responses

200Availability intervals for the requested users and window.application/json

Response schemaapplication/json

required

Availability

Public API representation of availability.

required

ResponseMeta

Public API representation of meta.

400The request is invalid.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

401The bearer credential is missing, invalid, expired, or revoked.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

403The credential has insufficient scope.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

413The requested availability window contains too many source records.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

429The credential or source exceeded its rate limit.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

502The cell-local application returned an invalid response.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

503A required cell-local dependency is unavailable.application/json

Response schemaapplication/json

required

array<ApiError>

The errors associated with this error.

required

ResponseMeta

Request metadata, including the request identifier and pagination state when applicable.

Operation IDlistAvailabilityOpenAPI JSON ↗

Documentation feedbackWas this page useful?