Get Slack channels
GET/projects/{projectId}/entities/{entityId}/assistants/{assistantId}/slackChannels
Base URL: https://api.tinkermode.com
Get a list of Slack channels associated with the assistant instance. This endpoint is available only the chatPlatform of the specified assistant is Slack. This API only returns the unarchived public channels. NOTE: We are getting the channels list from the Slack conversations.list API. Unlike most of other MODE API endpoints, the pagination style of this API is cursor-based. It's because the above Slack API is cursor-based.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain the key of a user or service account with permissions to read assistant instances, or a project API key.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
projectId | integer | Yes | The unique ID for a specified project. | |
entityId | string | Yes | Entity ID (unique within project) | |
assistantId | integer | Yes | The unique ID for a specific assistant. |
Query parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
cursor | string | No | You can paginate through the list of channels by providing a cursor.
You are supposed to set the cursor to the value of the response's next_cursor field.
| |
limit | integer | No | default: 25; min: 1; max: 1000 | Maximum number of items to return. |
Responses
200 Successfully retrieved the Slack channels.
Content type: application/json
A Slack channel associated with an Assistant instance.
An array of objects with the following shape:
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
id | string | Yes | read-only (server-generated) | The unique identifier for the Slack Channel. |
name | string | Yes | read-only (server-generated) | The name of the Slack Channel. |
401 Authorization is required to access this resource.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
403 The client doesn't have the permission to access the specified assistant or the chatPlatform of the specified assistant is not Slack.
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |