List all context records

get

Authorizations

useroauth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

typestring · enumOptional

Filter context records by type.

Possible values:

connectorone ofOptional

Filter context records by connector type.

stringOptional

Integration source

Pattern: ^integration:[^:]+$

or

string · enumOptional

Builtin sources

Possible values:

connectionstringOptional

Filter context records by connection id.

topicstringOptional

Filter context records by associated site topic ID.

Responses

200

OK

application/json

countnumberOptional

Total count of objects in the list

get/orgs/{organizationId}/sites/{siteId}/context-records

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/context-records HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "context-record",
      "id": "text",
      "title": "text",
      "description": "text",
      "type": "ticket",
      "createdAt": "2026-07-21T22:04:28.251Z",
      "processedAt": "2026-07-21T22:04:28.251Z",
      "connection": "text",
      "connector": "text",
      "topics": [
        "text"
      ],
      "urls": {
        "location": "https://example.com",
        "source": "https://example.com"
      }
    }
  ]
}