Get a site scan by ID

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

siteScanIdstringRequired

The unique id of the site scan

Responses

200

OK

application/json

objectstring · enumRequiredPossible values:

idstringRequired

The ID of the scan

statusstring · enumRequired

Status of a persisted site scan.

Possible values:

topicstring · nullableRequired

The site topic ID associated with the scan. It is null for scans that are not associated with a current topic in the site.

createdAtstring · date-timeRequired

startedAtstring · date-timeOptional

finishedAtstring · date-timeOptional

failureMessagestringOptional

Failure message for failed scans

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

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

200

OK

{
  "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"
  }
}