List all topics

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

Query parameters

fromstring · date-timeOptional

Filter stats to answers created at or after this timestamp.

tostring · date-timeOptional

Filter stats to answers created at or before this timestamp.

Responses

200

OK

application/json

get/orgs/{organizationId}/sites/{siteId}/topics

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

200

OK

{
  "items": [
    {
      "object": "context-topic",
      "id": "text",
      "label": "text",
      "parent": {
        "id": "text",
        "label": "text"
      },
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "icon": "gear",
      "summary": {
        "object": "document",
        "data": {},
        "nodes": [
          {
            "object": "block",
            "type": "paragraph",
            "data": {},
            "nodes": [
              {
                "object": "text",
                "leaves": [
                  {
                    "object": "leaf",
                    "text": "Hello world",
                    "marks": []
                  }
                ]
              }
            ]
          }
        ]
      },
      "usageSettings": {
        "changeRequests": true
      },
      "pages": 1,
      "records": 1,
      "findings": {
        "open": 1,
        "total": 1
      },
      "questions": {
        "total": 1,
        "answers": 1,
        "feedback": {
          "positive": 1,
          "negative": 1,
          "unrated": 1
        },
        "answered": {
          "yes": 1,
          "partially": 1,
          "no": 1
        },
        "relevance": {
          "relevant": 1,
          "spam": 1,
          "off-topic": 1,
          "unclear": 1
        },
        "types": {
          "exploring": 1,
          "how-to": 1,
          "troubleshooting": 1,
          "reference": 1,
          "unknown": 1
        },
        "channelTypes": {
          "ANY_ADDITIONAL_PROPERTY": 1
        },
        "channels": {
          "ANY_ADDITIONAL_PROPERTY": 1
        },
        "weeklyPulse": [
          1
        ]
      },
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}