Site channels

Configure site channels for your docs site.

Manage the channels used as origins for questions and answers in your site ask data.

The SiteChannel object

Attributes

anyOptional

or

and

The SiteChannel object

{
  "type": "builtin:slack",
  "setupSettings": {},
  "object": "site-channel",
  "id": "text",
  "answers": 1,
  "usageSettings": {},
  "createdAt": "2026-03-18T12:39:39.397Z",
  "urls": {
    "location": "https://example.com"
  }
}

List all site channels for a site

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

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

siteIdstringRequired

The unique id of the site

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

get

/orgs/{organizationId}/sites/{siteId}/channels

HTTPcURLJavaScriptPython

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

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "type": "builtin:slack",
      "setupSettings": {}
    },
    {
      "object": "site-channel",
      "id": "text",
      "answers": 1,
      "usageSettings": {},
      "createdAt": "2026-03-18T12:39:39.397Z",
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Create a site channel

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

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

siteIdstringRequired

The unique id of the site

Body

application/json

anyOptional

or

and

Responses

201

Site channel created

application/json

post

/orgs/{organizationId}/sites/{siteId}/channels

HTTPcURLJavaScriptPython

POST /v1/orgs/{organizationId}/sites/{siteId}/channels HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "type": "builtin:slack",
  "setupSettings": {},
  "usageSettings": {}
}

201

Site channel created

{
  "type": "builtin:slack",
  "setupSettings": {},
  "object": "site-channel",
  "id": "text",
  "answers": 1,
  "usageSettings": {},
  "createdAt": "2026-03-18T12:39:39.397Z",
  "urls": {
    "location": "https://example.com"
  }
}

Get a site channel

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

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

siteIdstringRequired

The unique id of the site

siteChannelIdstringRequired

The unique id of the site channel

Responses

200

OK

application/json

anyOptional

or

and

get

/orgs/{organizationId}/sites/{siteId}/channels/{siteChannelId}

HTTPcURLJavaScriptPython

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

200

OK

{
  "type": "builtin:slack",
  "setupSettings": {},
  "object": "site-channel",
  "id": "text",
  "answers": 1,
  "usageSettings": {},
  "createdAt": "2026-03-18T12:39:39.397Z",
  "urls": {
    "location": "https://example.com"
  }
}

Delete a site channel

delete

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

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

siteIdstringRequired

The unique id of the site

siteChannelIdstringRequired

The unique id of the site channel

Responses

204

Site channel did not exist

205

Site channel deleted

delete

/orgs/{organizationId}/sites/{siteId}/channels/{siteChannelId}

HTTPcURLJavaScriptPython

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

No content