> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/developers/gitbook-api/api-reference/docs-sites/site-channels/list-all-gitbook-agent-channels-for-a-site.md).

# 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.

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-channels","description":"Manage the channels used as origins for questions and answers in your site ask data.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"SiteChannel\" grouped=\"false\" %}\n    The SiteChannel object\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]},{"oauth":["site:read"]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"},"oauth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://oauth.gitbook.com/authorize","tokenUrl":"https://oauth.gitbook.com/token","scopes":{"user:read":"Read your GitBook user profile.","organization:read":"Read the organizations you belong to, their settings and metadata, and their AI agent conversations.","organization:write":"Create organizations, and update organization settings and AI agent conversations.","organization:members:read":"Read organization members, teams, invites and link invites.","organization:members:write":"Manage organization members, teams, invites and link invites.","organization:ask":"Ask AI questions across an organization's content.","organization:search":"Search across an organization's content.","space:read":"Read spaces and their content, including pages, change requests and their reviews, comments, files and revision history.","space:write":"Create, update and delete spaces and their content, including change requests (create, edit, review), comments, and content imports and exports. Merging a change request also requires change-request:merge.","space:permissions:read":"Read the users and teams who have access to spaces and collections.","space:permissions:write":"Manage who has access to spaces and collections, including inviting users and teams.","change-request:merge":"Merge change requests, publishing their changes to the space. Creating, editing and reviewing change requests only requires space:write.","site:read":"Read sites and their settings, including navigation structure, linked spaces, customization, redirects, topics, AI configuration and documentation issues.","site:write":"Create, update and delete sites and their settings, including navigation structure (sections, linked spaces, external links), customization, redirects, topics and AI configuration.","site:publish":"Publish and unpublish sites, controlling their public exposure.","site:permissions:read":"Read the users and teams who have access to sites.","site:permissions:write":"Manage who has access to sites, including inviting users and teams.","site:auth:read":"Read how visitors authenticate on a site and its security configuration, including private share links.","site:auth:write":"Manage how visitors authenticate on a site and its security configuration, including private share links.","site:insights:read":"Read site analytics and insights, including the questions visitors asked Ask AI and the answers they received.","site:ask":"Ask AI questions across a site's content.","site:search":"Search across a site's content.","integration:read":"Read integrations, their status and where they are installed.","integration:installations:read":"Read integration installations and their configuration, which can include credentials for third-party services.","integration:installations:write":"Install and configure integrations on an organization, its spaces and its sites.","integration:publish":"Publish integrations, which can request their own permissions on your content, and route their events to a development tunnel.","integration:delete":"Unpublish integrations, permanently deleting them and every installation of them.","openapi:read":"Read OpenAPI specifications.","openapi:write":"Create, update and delete OpenAPI specifications."}}}}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"$ref":"#/components/schemas/EntityId"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}},"listPage":{"name":"page","in":"query","description":"Identifier of the page results to fetch.","schema":{"type":"string"}},"listLimit":{"name":"limit","in":"query","description":"The number of results per page","schema":{"type":"number","minimum":0,"maximum":1000}}},"schemas":{"EntityId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"A unique entity identifier"},"List":{"type":"object","properties":{"next":{"type":"object","properties":{"page":{"type":"string","description":"Unique identifier to query the next results page"}},"required":["page"]},"count":{"type":"number","description":"Total count of objects in the list"}}},"SiteChannel":{"allOf":[{"$ref":"#/components/schemas/SiteChannelSetup"},{"type":"object","properties":{"object":{"type":"string","enum":["site-channel"]},"id":{"type":"string","description":"Unique identifier for the site channel."},"status":{"$ref":"#/components/schemas/SiteChannelStatus"},"role":{"$ref":"#/components/schemas/SiteChannelRole"},"answers":{"type":"integer","minimum":0,"description":"Number of answers linked to this channel."},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"urls":{"type":"object","properties":{"location":{"type":"string","format":"uri","description":"URL of the site channel in the API."}},"required":["location"]}},"required":["object","id","status","role","answers","createdAt","urls"]}]},"SiteChannelSetup":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["builtin:slack"]},"setupSettings":{"type":"object","additionalProperties":false,"properties":{"allowedChannels":{"description":"List of allowed Slack channel names or patterns. If empty, all channels are allowed.","type":"array","items":{"$ref":"#/components/schemas/GenericChannelPattern"}}}}},"required":["type","setupSettings"]},{"type":"object","properties":{"type":{"type":"string","enum":["builtin:linear"]},"setupSettings":{"type":"object","additionalProperties":false,"properties":{"allowedTeams":{"description":"List of allowed Linear team keys or patterns. If empty, all teams are allowed.","type":"array","items":{"$ref":"#/components/schemas/GenericChannelPattern"}}}}},"required":["type","setupSettings"]},{"type":"object","properties":{"type":{"type":"string","enum":["builtin:github"]},"setupSettings":{"type":"object","additionalProperties":false,"properties":{"allowedRepositories":{"description":"List of allowed GitHub repository names or patterns. If empty, all repositories are allowed.","type":"array","items":{"$ref":"#/components/schemas/GitHubRepositoryPattern"}}}}},"required":["type","setupSettings"]},{"type":"object","properties":{"type":{"type":"string","enum":["builtin:discord"]},"setupSettings":{"type":"object","additionalProperties":false,"properties":{"allowedChannels":{"description":"List of allowed Discord channel names or patterns. If empty, all channels are allowed.","type":"array","items":{"$ref":"#/components/schemas/GenericChannelPattern"}}}}},"required":["type","setupSettings"]}]},"GenericChannelPattern":{"type":"string","description":"A generic channel name or pattern. For example, \"general\" or \"support-*\".","pattern":"^[a-zA-Z0-9_\\*-]+$"},"GitHubRepositoryPattern":{"type":"string","description":"A GitHub repository name or pattern in the format \"owner/repository\". For example, \"my-org/my-repo\" or \"my-org/*\" to allow all repositories under \"my-org\".","pattern":"^[a-zA-Z0-9._*-]+\\/[a-zA-Z0-9._*-]+$"},"SiteChannelStatus":{"type":"string","enum":["active","pending"]},"SiteChannelRole":{"type":"string","enum":["collaborator","support"]},"Timestamp":{"type":"string","format":"date-time"}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/channels":{"get":{"operationId":"listSiteChannels","summary":"List all GitBook Agent channels for a site","description":"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.","tags":["site-channels"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/listPage"},{"$ref":"#/components/parameters/listLimit"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/List"},{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SiteChannel"}}}}]}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://gitbook.com/docs/developers/gitbook-api/api-reference/docs-sites/site-channels/list-all-gitbook-agent-channels-for-a-site.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.