List available site channel scopes
Lists accessible Linear teams, GitHub repositories, Slack channels or Jira projects. Requires site admin permission. Linear, GitHub and Slack require an already-connected channel belonging to this site and matching the provider. Jira uses either the credentials supplied, verified without saving a connection, or those stored on an existing Jira context connection of this site. Slack includes public channels and accessible private channels, excluding archived channels. To fetch another page, pass the opaque token from next.page as the page query parameter with the same request body. An absent next means there are no more pages; an empty items array alone does not indicate the end of the list.
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
Identifier of the page results to fetch.
Scopes available through the connected provider or supplied Jira credentials
Total count of objects in the list
Linear workspace name, GitHub account name, Slack workspace name (or ID if unavailable), or Jira Cloud hostname.
Bad Request
Unauthorized
Forbidden
Not Found
POST /v1/orgs/{organizationId}/sites/{siteId}/channels/scopes HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"provider": "linear",
"siteChannelId": "text"
}{
"next": {
"page": "text"
},
"count": 1,
"object": "site-channel-scopes",
"connection": "text",
"items": [
{
"key": "text",
"name": "text"
}
]
}Last updated
Was this helpful?