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

Authorizations

user

Path parameters

organizationIdstringRequired

The unique id of the organization

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

spacestringOptional

Identifier of the space to filter the sites by

titlestringOptional

Filter sites by their title

publishedbooleanOptional

Filter sites by their published status

Responses

200

OK

application/json

Responseall of

default

Unexpected Error

application/json

get

/orgs/{organizationId}/sites

HTTPcURLJavaScriptPython

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

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