Get a GitBook Agent channel for a site by its ID
Retrieves the configuration of a specific GitBook Agent channel integration, including its connected platform type and role. Use this to inspect or verify the channel's setup before updating it.
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
siteChannelIdstringRequired
The unique id of the site channel
Responses
200
OK
application/json
anyOptional
or
or
or
get/orgs/{organizationId}/sites/{siteId}/channels/{siteChannelId}
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": {
"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?