List all site scans

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

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

topicstringOptional

Filter scans by associated site topic ID.

statusstring · enumOptional

Status of a persisted site scan.

Possible values:

Responses

200

OK

application/json

countnumberOptional

Total count of objects in the list

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

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

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site-scan",
      "id": "text",
      "status": "pending",
      "topic": null,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "startedAt": "2026-01-01T00:00:00.000Z",
      "finishedAt": "2026-01-01T00:00:00.000Z",
      "findings": {
        "low": 1,
        "medium": 1,
        "high": 1
      },
      "failureMessage": "text",
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}