List change requests linked to a site finding

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

siteFindingIdstringRequired

The unique id of the site finding

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

List of change requests linked to the site finding

application/json

countnumberOptional

Total count of objects in the list

get/orgs/{organizationId}/sites/{siteId}/findings/{siteFindingId}/change-requests

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

200

List of change requests linked to the site finding

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "change-request",
      "id": "text",
      "number": 1,
      "status": "draft",
      "subject": "text",
      "description": {
        "object": "document",
        "data": {},
        "nodes": [
          {
            "object": "block",
            "type": "paragraph",
            "data": {},
            "nodes": [
              {
                "object": "text",
                "leaves": [
                  {
                    "object": "leaf",
                    "text": "Hello world",
                    "marks": []
                  }
                ]
              }
            ]
          }
        ]
      },
      "createdBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "mergedBy": {
        "object": "user",
        "id": "text",
        "displayName": "text",
        "email": "text",
        "photoURL": "text",
        "urls": {
          "location": "https://example.com"
        }
      },
      "mergedAt": "2026-01-01T00:00:00.000Z",
      "space": "text",
      "revision": "text",
      "revisionInitial": "text",
      "revisionMergedAncestor": "text",
      "revisionMerged": "text",
      "comments": 1,
      "siteTopic": {
        "site": "text",
        "topic": "text",
        "finding": "text"
      },
      "outdated": true,
      "imports": [
        {
          "object": "import-run",
          "id": "text",
          "startedAt": "2026-01-01T00:00:00.000Z",
          "completedAt": "2026-01-01T00:00:00.000Z",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "updatedAt": "2026-01-01T00:00:00.000Z",
          "status": "pending",
          "reason": "text",
          "source": {
            "type": "website",
            "url": "https://example.com"
          },
          "target": {
            "space": "text",
            "changeRequest": "text",
            "page": "text"
          },
          "site": "text",
          "createdBy": "text",
          "urls": {
            "location": "https://example.com"
          },
          "pages": [
            {
              "id": "text",
              "sourceURL": "text",
              "type": "page",
              "status": "complete"
            }
          ]
        }
      ],
      "links": [
        {
          "id": "text",
          "ref": {
            "kind": "url",
            "url": "text"
          },
          "title": "text",
          "expanded": {
            "kind": "external-ticket",
            "provider": "jira",
            "state": "connected",
            "key": "text",
            "url": "https://example.com",
            "status": {
              "id": "text",
              "name": "text"
            },
            "summary": "text"
          }
        }
      ],
      "urls": {
        "app": "https://example.com",
        "location": "https://example.com"
      }
    }
  ]
}