get/changesRead operation

List cell-local resource changes

Returns metadata-only, cell-local changes at a fixed page watermark. The opaque cursor is bound to the credential, workspace, cell, epoch, and exact filter set. A 410 response requires a new checkpoint and full resource snapshot.

Required scopes

changes:read

Request example

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

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

const result: ApiResponse = await response.json()

teamgrid changes list \
  --output json

Example response 2xx

{
  "data": [
    "ChangeEvent"
  ],
  "meta": {
    "page": {
      "limit": 1,
      "nextCursor": "string",
      "caughtUp": false
    },
    "requestId": "string"
  }
}

EndpointGerman region

Interactive request builder

Prepare this request

Build locally · nothing is sent

Region

Credential variable

cursorquerylimitqueryoperationsqueryresourceTypesquerystartAtLatestquery

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.

operations

array<string>

Filter by one or more change operations. Repeat the query parameter for multiple values.

resourceTypes

array<string>

Filter by one or more public resource types. Repeat the query parameter for multiple values.

startAtLatest

boolean

Create an empty checkpoint at the latest committed cell sequence. Cannot be combined with cursor. Use this before a full resource snapshot, then poll with the returned cursor.

Responses

200A fixed-watermark change page and the checkpoint for the next poll.application/json

Response schemaapplication/json

required

array<ChangeEvent>

Public API representation of change event.

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.

410The cursor is outside retained history or cell continuity cannot be proven. A full resynchronization is required.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 IDlistChangesOpenAPI JSON ↗

Documentation feedbackWas this page useful?