GET
/admin.conversations.restrictAccess.listGroupsList identity-provider groups for a channel
Lists the identity-provider groups linked to a channel. Supply channel_id to identify the channel and include team_id when the channel exists only in one workspace. Use a token with the administrative read scope.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
tokenstringrequired
Authentication token with the `admin.conversations:read` scope.
channel_idstringrequired
Identifier of the channel whose linked identity-provider groups to list.
team_idstringoptional
Workspace containing the channel; include this for channels tied to one workspace and omit it for organization-shared channels.
200Returns a successful response containing the `ok` flag and the available linked-group information when provided.
okbooleanrequired
defaultReturned when the linked groups cannot be listed successfully; the response contains `ok: false`.
okbooleanrequired
Error handling
token must provide the admin.conversations:read scope, and channel_id must identify the channel. Include team_id for channels tied to one workspace; omit it only when the channel is shared across an organization.