List all GitBook Agent channels for a site
Returns a paginated list of channels configured for the site. Channels are integrations that allow GitBook Agent to operate within external tools your team already uses, bringing documentation assistance directly into existing workflows. Each channel has a role that determines whether the Agent answers questions from the site's documentation or actively collaborates by opening and managing content changes. Use this to inspect or manage the Agent channel integrations for a site.
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
A unique entity identifier
^[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
countnumberOptional
Total count of objects in the list
get/orgs/{organizationId}/sites/{siteId}/channels
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": {
"allowedChannels": [
"text"
]
}
},
{
"object": "site-channel",
"id": "text",
"status": "active",
"role": "collaborator",
"answers": 1,
"createdAt": "2026-01-01T00:00:00.000Z",
"urls": {
"location": "https://example.com"
}
}
]
}Last updated
Was this helpful?