Get a context record

get

Authorizations

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

siteContextRecordIdstringRequired

The unique id of the context record

Responses

200

OK

application/json

objectstring · enumRequiredPossible values:

idstringRequired

The ID of the record

titlestring · min: 1 · max: 256Required

Title for the context record

descriptionstring · max: 512Optional

Optional short description of the context record

typestring · enumRequiredPossible values:

createdAtstring · date-timeRequired

processedAtstring · date-timeOptional

connectionstringRequired

The connection ID associated with the record

connectorone ofRequired

The connector type associated with the record

stringOptional

Integration source

Pattern: ^integration:[^:]+$

or

string · enumOptional

Builtin sources

Possible values:

topicsstring[]Optional

The associated topics of the record

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

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

200

OK

{
  "object": "context-record",
  "id": "text",
  "title": "text",
  "description": "text",
  "type": "ticket",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "processedAt": "2026-01-01T00:00:00.000Z",
  "connection": "text",
  "connector": "text",
  "topics": [
    "text"
  ],
  "urls": {
    "location": "https://example.com",
    "source": "https://example.com"
  }
}