List all site context findings

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

topicstringOptional

Filter findings by associated site topic ID.

statusstring · enumOptional

Status of a site finding.

• candidate is a finding that has been raised but not yet confirmed. Typically these are not shown to users.
• open is a finding that has been surfaced to users and is still under investigation.
• done is a finding that has been resolved and is no longer under investigation.
• canceled is a finding that has been canceled and is no longer under investigation.

Possible values:

typestring · enumOptional

Classification of a site finding:

• Outdated content: The content was correct but is no longer up to date with external context and may be misleading or incorrect.
• Incorrect content: The content is factually wrong or misleading, leading users astray regardless of whether it was ever correct.
• Content gap: The content is missing important information that should be present to answer user questions effectively.
• Other: Any other type of finding not covered by the above categories.

Possible values:

severitystring · enumOptional

Estimated end-user severity of a site finding.

Possible values:

hasChangeRequestsbooleanOptional

Filter findings that have at least one associated change request.

updatedAfterstring · date-timeOptional

Only return findings last updated at or after this date.

updatedBeforestring · date-timeOptional

Only return findings last updated before this date.

orderBystring · enumOptional

The field to sort site findings by. updatedAt returns the most recently updated findings first. severity returns the most severe findings first. sources returns the findings with the most linked sources (questions plus records) first. Defaults to 'updatedAt'.

Default: updatedAtPossible values:

Responses

200

OK

application/json

countnumberOptional

Total count of objects in the list

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

HTTPcURLJavaScriptPython

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

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site-finding",
      "id": "text",
      "scan": "text",
      "topic": null,
      "title": "text",
      "changeRequests": 1,
      "pages": 1,
      "records": 1,
      "questions": 1,
      "status": "candidate",
      "type": "content-outdated",
      "severity": "low",
      "description": {
        "object": "document",
        "data": {},
        "nodes": [
          {
            "object": "block",
            "type": "paragraph",
            "data": {},
            "nodes": [
              {
                "object": "text",
                "leaves": [
                  {
                    "object": "leaf",
                    "text": "Hello world",
                    "marks": []
                  }
                ]
              }
            ]
          }
        ]
      },
      "autoFixable": true,
      "createdAt": "2026-08-11T00:57:55.581Z",
      "updatedAt": "2026-08-11T00:57:55.581Z",
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}