List all integration site installations

get

Authorizations

integration

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

integrationNamestring · max: 100Required

Name of the integration.

Pattern: ^[a-zA-Z0-9-_.]+$

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

externalIdstringOptional

External ID to filter by

extendedbooleanOptional

If true, returns the site object in each items. If false, returns the site ID in each items.

Default: false

Responses

200

OK

application/json

countnumberOptional

Total count of objects in the list

get/integrations/{integrationName}/sites

HTTPcURLJavaScriptPython

GET /v1/integrations/{integrationName}/sites HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "integration": "text",
      "installation": "text",
      "status": "active",
      "configuration": {},
      "externalIds": [
        "text"
      ],
      "urls": {
        "location": "https://example.com",
        "publicEndpoint": "https://example.com",
        "publicContentEndpoint": "https://example.com"
      },
      "site": "text"
    }
  ]
}