get/appointmentsRead operation

List appointments in a bounded interval

Lists native and provider-managed appointment metadata. Private foreign appointments are redacted; provider identifiers, participants, recurrence payloads, and tokens are never returned.

Required scopes

appointments:read

Conditional scopes

appointments:delegated:read

Request example

curl --request GET \
  --url 'https://api.de.teamgrid.app/v1/appointments?cursor=CURSOR&limit=50&archived=false' \
  --header 'Authorization: Bearer $TEAMGRID_API_TOKEN'

const response = await fetch('https://api.de.teamgrid.app/v1/appointments?cursor=CURSOR&limit=50&archived=false', {
  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/appointments?cursor=CURSOR&limit=50&archived=false', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TEAMGRID_API_TOKEN}`,
  },
})

const result: ApiResponse = await response.json()

teamgrid appointments list \
  --output json

Example response 2xx

{
  "data": [
    "Appointment"
  ],
  "meta": {
    "page": {
      "limit": 1,
      "nextCursor": null
    },
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

cursorquerylimitqueryarchivedquerystartquery · requiredendquery · 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

cursor

string

Opaque cursor returned in meta.page.nextCursor.

limit

integer

Maximum number of records to return in this page. The response may contain fewer records.

archived

boolean

Return archived resources instead of active resources.

startrequired

string

Inclusive beginning of the bounded calendar interval.

endrequired

string

Exclusive end of the bounded calendar interval.

userId

array<string>

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

Responses

200A bounded page of resources visible to the credential, with request metadata and an opaque cursor when another page is available.application/json

Response schemaapplication/json

required

array<Appointment>

Public API representation of appointment.

required

object

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.

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 IDlistAppointmentsOpenAPI JSON ↗

Documentation feedbackWas this page useful?