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

GEThttps://api.gitbook.com/v1/orgs/{organizationId}/sites

Authorization

user

Path parameters

organizationId*string

The unique id of the organization

Query parameters

Response

200default

OK

Body

application/json

nextobject

countnumber

Total count of objects in the list

items*array of object

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.gitbook.com/v1/orgs/{organizationId}/sites', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200default

{
  "next": {
    "page": "text"
  },
  "count": 0,
  "items": [
    {
      "object": "site",
      "id": "text",
      "type": "basic",
      "title": "text",
      "hostname": "text",
      "basename": "text",
      "proxy": "text",
      "visibility": "public",
      "published": false,
      "siteSpaces": 0,
      "createdAt": "2025-01-30T14:32:59.103Z",
      "adaptiveContent": {
        "enabled": false
      },
      "ads": {
        "status": "pending",
        "submittable": false
      },
      "urls": {
        "location": "https://example.com",
        "app": "https://example.com",
        "published": "https://example.com"
      }
    }
  ]
}