# GitBook Sites API

**Canonical:** https://apis.io/apis/gitbook/gitbook-sites-api/  
**Provider:** GitBook — https://apis.io/providers/gitbook/  
**Documentation:** https://docs.gitbook.com/developers

GitBook Sites API is one of 65 APIs that [GitBook](https://apis.io/providers/gitbook/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. This API exposes 7 JSON Schema definitions. Tagged areas include Sites. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, and 7 JSON Schemas.

The Docs Sites API lets you programmatically manage published documentation sites within your organization. You can list and update all sites created under a specific organization, making it easy to audit or interact with site metadata at scale. {% openapi-schemas spec="gitbook" schemas="Site" grouped="false" %} The Site object {% endopenapi-schemas %}

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| GET | `/orgs/{organizationId}/sites` | List all documentation sites in an organization |
| POST | `/orgs/{organizationId}/sites` | Create a new documentation site in an organization |
| GET | `/orgs/{organizationId}/sites/{siteId}` | Get a documentation site by its ID |
| PATCH | `/orgs/{organizationId}/sites/{siteId}` | Update the properties of a documentation site |
| DELETE | `/orgs/{organizationId}/sites/{siteId}` | Delete a site |
| GET | `/orgs/{organizationId}/sites/{siteId}/adaptive-schema` | Get the visitor attributes JSON schema for an adaptive content site |
| PUT | `/orgs/{organizationId}/sites/{siteId}/adaptive-schema` | Update the visitor attributes JSON schema for an adaptive content site |
| GET | `/orgs/{organizationId}/sites/{siteId}/adaptive-schema/template-conditions` | List condition templates for adaptive content expressions in a site |
| GET | `/orgs/{organizationId}/sites/{siteId}/published` | Get the full published profile of a site including structure and customization |
| POST | `/orgs/{organizationId}/sites/{siteId}/publish` | Publish a site to make it publicly accessible |
| GET | `/orgs/{organizationId}/sites/{siteId}/setup` | Get the setup steps of a site |
| POST | `/orgs/{organizationId}/sites/{siteId}/unpublish` | Take a site offline by unpublishing it |
| PATCH | `/orgs/{organizationId}/sites/{siteId}/structure/sort` | Move a site structure item to a new position |
| GET | `/orgs/{organizationId}/sites/{siteId}/integration-scripts` | List custom scripts injected into a site's published pages |
| GET | `/orgs/{organizationId}/sites/{siteId}/integrations` | List third-party integrations enabled on a site |
| POST | `/orgs/{organizationId}/sites/{siteId}/search` | Full-text search across all content in a site |
| POST | `/orgs/{organizationId}/sites/{siteId}/search/prewarm` | Prewarm a site's search cache |
| POST | `/orgs/{organizationId}/sites/{siteId}/template` | Apply the default documentation template to a site |
| POST | `/orgs/{organizationId}/sites/{siteId}/styleguide` | Create or retrieve the style guide space for a site |
| POST | `/orgs/{organizationId}/sites/{siteId}/styleguide/runs` | Start a style guide check run for a site |
| GET | `/orgs/{organizationId}/sites/{siteId}/styleguide/runs` | List the style guide check runs of a site |

## Machine-readable artifacts (11)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/openapi/gitbook-sites-api-openapi.yml
- **Documentation** — https://docs.gitbook.com/developers
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/asyncapi/gitbook-gitbook-api-asyncapi.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/organization.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/space.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/page.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/user.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/change-request.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/docs-site.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/collection.json
- **JSONLD** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-ld/gitbook-context.jsonld

## Other GitBook APIs (12)

- [GitBook Change Request Content API](https://apis.io/apis/gitbook/gitbook-change-request-content-api/)
- [GitBook Change Request Reviewers API](https://apis.io/apis/gitbook/gitbook-change-request-reviewers-api/)
- [GitBook Change Requests API](https://apis.io/apis/gitbook/gitbook-change-requests-api/)
- [GitBook Collections API](https://apis.io/apis/gitbook/gitbook-collections-api/)
- [GitBook Custom Hostnames API](https://apis.io/apis/gitbook/gitbook-custom-hostnames-api/)
- [GitBook Imports API](https://apis.io/apis/gitbook/gitbook-imports-api/)
- [GitBook Integrations API](https://apis.io/apis/gitbook/gitbook-integrations-api/)
- [GitBook Organization Members API](https://apis.io/apis/gitbook/gitbook-organization-members-api/)
- [GitBook Organizations API](https://apis.io/apis/gitbook/gitbook-organizations-api/)
- [GitBook Site Spaces API](https://apis.io/apis/gitbook/gitbook-site-spaces-api/)
- [GitBook Space Content API](https://apis.io/apis/gitbook/gitbook-space-content-api/)
- [GitBook Spaces API](https://apis.io/apis/gitbook/gitbook-spaces-api/)

## Tags

Sites

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/gitbook/gitbook-sites-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/gitbook/.