Docs sites

A site in GitBook - also called a docs site - is your published content.

We're still building out the API around sites. If you're trying to do something with our API and you can't find the endpoint, please get in touch!

List all the sites created in an organization

get

/orgs/{organizationId}/sites

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Query parameters

pagestring

Identifier of the page results to fetch.

limitnumber

The number of results per page

spacestring

Identifier of the space to filter the sites by

titlestring

Filter sites by their title

publishedboolean

Filter sites by their published status

typeenum[]

Filter by site type

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/sites' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

{
  "count": 1,
  "next": {
    "page": "text"
  },
  "items": [
    {
      "type": "basic",
      "title": "text",
      "hostname": "text",
      "basename": "text",
      "proxy": "text",
      "visibility": "public",
      "siteSpaces": 1,
      "createdAt": "2025-02-19T07:38:47.586Z",
      "adaptiveContent": {
        "enabled": true
      },
      "ads": {
        "status": "pending",
        "submittable": true
      },
      "object": "site",
      "id": "text",
      "published": true,
      "urls": {
        "location": "https://example.com",
        "app": "https://example.com",
        "published": "https://example.com"
      }
    }
  ]
}

OK