Slack API Methods

https://docs.slack.dev/reference/methods
Admin
This section provides a comprehensive reference for all available Slack API methods, enabling...
Tokens:863,721
Snippets:5,904
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example request body for apps.datastore.get

Source: https://docs.slack.dev/reference/methods/apps.datastore.get

Example JSON payload to get an item with id "4" from the datastore "good_tunes". The datastore and id are required arguments.

```json
{
		"datastore": "good_tunes",
		"id": "4"
	}
```

--------------------------------

### team.info method access examples

Source: https://docs.slack.dev/reference/methods/team.info

Shows the method access examples for team.info across HTTP, Slack CLI, and the Bolt SDKs for JavaScript, Python, and Java. Each example invokes the team.info method using the respective client or CLI.

```HTTP
GET https://slack.com/api/team.info
```

```Slack CLI
slack api team.info
```

```JavaScript
app.client.team.info
```

```Python
app.client.team_info
```

```Java
app.client().teamInfo
```

--------------------------------

### Example response with reminders array

Source: https://docs.slack.dev/reference/methods/reminders.list

Shows a full example response from reminders.list, including a list of reminders. Only non-recurring reminders have 'time' and 'complete_ts' fields.

```json
	{		"ok": true,		"reminders": [			{				"id": "Rm12345678",				"creator": "U18888888",				"user": "U18888888",				"text": "eat a banana",				"recurring": false,				"time": 1458678068,				"complete_ts": 0			},			{				"id": "Rm23456789",				"creator": "U18888888",				"user": "U18888888",				"text": "drink water",				"recurring": true			}		]	}
```

--------------------------------

### Example profile hash

Source: https://docs.slack.dev/reference/methods/users.profile.set

Example profile JSON hash for the profile argument.

```json
{ first_name: "John", ... }
```

--------------------------------

### Example request for workflows.featured.set

Source: https://docs.slack.dev/reference/methods/workflows.featured.set

A JSON payload example showing how to specify the channel_id and a list of trigger_ids to set as featured.

```json
{
    "channel_id": "C1234567890",
    "trigger_ids": [
        "Ft012345",
        "Ft02468"
    ]
}
```

--------------------------------

### Example request for workflows.featured.list

Source: https://docs.slack.dev/reference/methods/workflows.featured.list

Example request body for the workflows.featured.list method. It includes the required channel_ids array with up to 100 channel IDs.

```json
{
    "channel_ids": [
        "C012345678",
        "C987654321"
    ]
}
```

--------------------------------

### Example call to admin.users.session.reset

Source: https://docs.slack.dev/reference/methods/admin.users.session.reset

Example JSON payload for the admin.users.session.reset method. It includes the token, user_id, and mobile_only parameters.

```json
{  "token": "xoxp-xxxxxxxx-xxxxxxxx",  "user_id": "U1234",  "mobile_only": true}
```

--------------------------------

### Example request body for apps.datastore.bulkPut

Source: https://docs.slack.dev/reference/methods/apps.datastore.bulkPut

Example request body for the apps.datastore.bulkPut method. It includes the datastore name and an array of items to create or replace.

```json
{
  "datastore": "delicious_meals",
  "items": [
    {
      "id": "12462",
      "meal": "Shawarma"
    }
  ]
}
```

--------------------------------

### Example request body for apps.datastore.bulkGet

Source: https://docs.slack.dev/reference/methods/apps.datastore.bulkGet

Example request body for apps.datastore.bulkGet. It retrieves two items from the 'good_tunes' datastore by their IDs.

```json
	{		"datastore": "good_tunes",		"ids": ["4", "6"]	}
```

--------------------------------

### Example Response JSON

Source: https://docs.slack.dev/reference/methods/admin.audit.anomaly.allow.getItem

Example response from the admin.audit.anomaly.allow.getItem API. Shows the ok field and the trusted_cidr and trusted_asns arrays.

```json
{
		"ok":true,
		"trusted_cidr":["8.8.8.8/24","8.8.4.4/22"],
		"trusted_asns":[12345,12344]
	}
```

--------------------------------

### Typical success response for admin.users.session.getSettings

Source: https://docs.slack.dev/reference/methods/admin.users.session.getSettings

Example response showing session settings for a user, including desktop_app_browser_quit and duration. Users without settings are omitted from the response.

```json
{  "ok": true,  "session_settings": [    {      "user_id": "U1234",      "desktop_app_browser_quit": true,      "duration": 315569520    }  ],  "no_settings_applied": []}
```

--------------------------------

### GET rtm.connect

Source: https://docs.slack.dev/reference/methods/rtm.connect

Starts a Real Time Messaging session. The method is called using an HTTP GET request to the Slack API.

```APIDOC
## GET rtm.connect

### Description
Starts a Real Time Messaging session.

### Method
GET

### Endpoint
`https://slack.com/api/rtm.connect`

### Parameters
#### Required Arguments
- **token** (string) - Required - Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

#### Optional Arguments
- **batch_presence_aware** (boolean) - Optional - Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events.
- **presence_sub** (boolean) - Optional - Only deliver presence events when requested by subscription.

### Request Example
No request body is required; parameters are sent as query parameters or POST parameters.

### Response
No response schema is documented.

### Rate Limits
Tier 1: 1+ per minute

### Scopes
No scopes required

### Content Types
`application/x-www-form-urlencoded`
`application/json`

```

--------------------------------

### Response example

Source: https://docs.slack.dev/reference/methods/files.remote.info

Shows a sample JSON response from the files.remote.info method, including the file object with fields like id, name, and external_url.

```json
{"ok": true,"file": {
    "id": "F08EAQ813FW",
    "created": 1740062388,
    "timestamp": 1740062388,
    "name": "Test",
    "title": "Test",
    "mimetype": "application/vnd.slack-remote",
    "filetype": "remote",
    "pretty_type": "Remote",
    "user": "U123A4BCDE5",
    "user_team": "T123A4BC5DE",
    "editable": false,
    "size": 0,
    "mode": "external",
    "is_external": true,
    "external_type": "app",
    "is_public": false,
    "public_url_shared": false,
    "display_as_bot": false,
    "username": "",
    "url_private": "https://docs.google.com/document/d/1e8LtkvCSe_NH0UU0RyLgssmUQLT8G_3RMCGzyPWcx58/edit?tab=t.0",
    "media_display_type": "unknown",
    "permalink": "https://thetestenv.slack.com/files/U123A4BCDE5/F08EAQ813FW/test",
    "comments_count": 0,
    "is_starred": false,
    "shares": {},
    "channels": [],
    "groups": [],
    "ims": [],
    "has_more_shares": false,
    "external_id": "1234",
    "external_url": "https://docs.google.com/document/d/1e8LtkvCSe_NH0UU0RyLgssmUQLT8G_3RMCGzyPWcx58/edit?tab=t.0",
    "has_rich_preview": false,
    "file_access": "visible"
  }
}
```

--------------------------------

### Create an editable text file

Source: https://docs.slack.dev/reference/methods/files.upload

Creates an editable text file containing the text 'launch plan' by sending the content as a form field.

```bash
curl -F "content=launch plan" -H "Authorization: Bearer xoxb-xxxxxxxxx-xxxx" https://slack.com/api/files.upload
```

--------------------------------

### GET rtm.start

Source: https://docs.slack.dev/reference/methods/rtm.start

Starts a Real Time Messaging session. This method is deprecated; use rtm.connect instead.

```APIDOC
## [GET] rtm.start

### Description
Deprecated: Starts a Real Time Messaging session. Use rtm.connect instead.

### Method
GET

### Endpoint
https://slack.com/api/rtm.start

### Parameters
#### Required Arguments
- **token** (string) - Required - Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

#### Optional Arguments
- **simple_latest** (boolean) - Optional - Return timestamp only for latest message object of each channel (improves performance).
- **no_unreads** (boolean) - Optional - Skip unread counts for each channel (improves performance).
- **mpim_aware** (boolean) - Optional - Returns MPIMs to the client in the API response.
- **presence_sub** (boolean) - Optional - Only deliver presence events when requested by subscription. See presence subscriptions. Default: `true`
- **batch_presence_aware** (boolean) - Optional - Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See batch presence. Default: `false`
- **no_latest** (boolean) - Optional - Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets `no_unreads` to `1`. Default: `0`
- **include_locale** (boolean) - Optional - Set this to `true` to receive the locale for users and channels. Defaults to `false`

### Request Example
```
GET https://slack.com/api/rtm.start
```

### Response
No response schema is provided in the source documentation.

### Error Handling
No error handling information is provided in the source documentation.

```

--------------------------------

### POST slackLists.download.start

Source: https://docs.slack.dev/reference/methods/slackLists.download.start

Initiates a job to export List contents. This method is accessible via HTTP, Slack CLI, and various SDKs.

```APIDOC
## POST slackLists.download.start

### Description
Initiates a job to export List contents.

### Method
POST

### Endpoint
https://slack.com/api/slackLists.download.start

### Parameters
#### Scopes
- **Bot token** (string) - Required - Scope: `lists:read`
- **User token** (string) - Required - Scope: `lists:read`

### Content Types
- `application/x-www-form-urlencoded`
- `application/json`

### Rate Limits
Tier 2: 20+ per minute

### Access Methods
- **HTTP**: `POST https://slack.com/api/slackLists.download.start`
- **Slack CLI**: `slack api slackLists.download.start`
- **JavaScript**: `app.client.slackLists.download.start`
- **Python**: `app.client.slackLists_download_start`
- **Java**: `app.client().slackListsDownloadStart`

### Request Example
(No request body parameters are documented in the source.)

### Response
(No response schema is documented in the source.)
```

--------------------------------

### Example Request for admin.audit.anomaly.allow.updateItem

Source: https://docs.slack.dev/reference/methods/admin.audit.anomaly.allow.updateItem

Example request body for the admin.audit.anomaly.allow.updateItem API. The token must be a session token (xoxc- or xoxp-) created by an org admin with a user token scope of admin, and the app must be installed at the org level. Include all previously added IP ranges and ASNs to avoid overwriting them.

```json
	{	"token":"xoxp-...",	 "trusted_cidr":["8.8.8.8/24","8.8.4.4/22"],	 "trusted_asn":[34245,8530]	 }
```

--------------------------------

### admin.apps.approved.list

Source: https://docs.slack.dev/reference/methods/admin.apps.approved.list

This snippet documents the admin.apps.approved.list method, which lists apps approved for installation for a workspace or an entire Enterprise organization. It includes required and optional arguments, usage notes, and example request/response structures.

```APIDOC
## [POST] admin.apps.approved.list

### Description
Lists apps approved for installation for a workspace or an entire Enterprise organization. This method requires an `admin.*` scope and is used to manage app approvals in an admin app.

### Method
POST

### Endpoint
admin.apps.approved.list

### Parameters
#### Required Arguments
- **token** (string) - Required - Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

#### Optional Arguments
- **limit** (integer) - Optional - The maximum number of items to return. Must be between 1 - 1000 both inclusive. Default: `100`.
- **cursor** (string) - Optional - Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
- **team_id** (string) - Optional - The workspace ID to list approved apps for. Cannot be used together with `enterprise_id`.
- **enterprise_id** (string) - Optional - The Enterprise organization ID to list org-wide approved apps for. Cannot be used together with `team_id`.
- **certified** (boolean) - Optional - Limit the results to only include certified apps. When false, no certified apps will appear in the result. Default: `false`.

### Request Example
```json
{
  "token": "xxxx-xxxxxxxxx-xxxx",
  "limit": 100,
  "cursor": "5c3e53d5",
  "team_id": "T0HFE6EBT",
  "enterprise_id": "E0AS553RN",
  "certified": false
}
```

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates success.
- **approved_apps** (array) - List of approved apps.
- **response_metadata** (object) - Contains `next_cursor` for pagination.

#### Response Example
```json
{
  "ok": true,
  "approved_apps": [
    {
      "app_id": "A123",
      "scopes": ["read", "write"]
    }
  ],
  "response_metadata": {
    "next_cursor": "dGVhbTpDMEY5RkNOTVQ="
  }
}
```
```

--------------------------------

### POST apps.event.authorizations.list

Source: https://docs.slack.dev/reference/methods/apps.event.authorizations.list

Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to. This method is accessible via HTTP, Slack CLI, and the Bolt SDKs for JavaScript, Python, and Java.

```APIDOC
## POST apps.event.authorizations.list

### Description
Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to.

### Method
POST

### Endpoint
https://slack.com/api/apps.event.authorizations.list

### Parameters
No parameters are documented in the source.

### Request Example
No request example is provided in the source.

### Response
No response schema is documented in the source.

### Response Example
No response example is provided in the source.

### Scopes
No scopes required.

### Content Types
- application/x-www-form-urlencoded
- application/json

### Rate Limits
Special rate limits apply.

### Access Methods
- HTTP: POST https://slack.com/api/apps.event.authorizations.list
- Slack CLI: slack api apps.event.authorizations.list
- JavaScript (Bolt): app.client.apps.event.authorizations.list
- Python (Bolt): app.client.apps_event_authorizations_list
- Java (Bolt): app.client().appsEventAuthorizationsList
```

--------------------------------

### apps.manifest.create

Source: https://docs.slack.dev/reference/methods?family=apps

Create an app from an app manifest.

```APIDOC
## apps.manifest.create

### Description
Create an app from an app manifest.

### Method
POST

### Endpoint
/apps.manifest.create

```

--------------------------------

### HTTP GET request for reactions.get

Source: https://docs.slack.dev/reference/methods/reactions.get

Sends a GET request to the Slack Web API to get reactions for an item. Requires a token with the reactions:read scope.

```http
GET https://slack.com/api/reactions.get
```

--------------------------------

### GET reminders.info

Source: https://docs.slack.dev/reference/methods/reminders.info

HTTP method to get information about a reminder.

```APIDOC
## GET https://slack.com/api/reminders.info

### Description
Gets information about a reminder.

### Method
GET

### Endpoint
https://slack.com/api/reminders.info

### Parameters
#### Required Arguments
- **token** (string) - Required - Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.
- **reminder** (string) - Required - The ID of the reminder

#### Optional Arguments
- **team_id** (string) - Optional - Encoded team id, required if org token is passed

### Scopes
User token: `reminders:read`

### Content Types
`application/x-www-form-urlencoded`
`application/json`

### Rate Limits
Tier 2: 20+ per minute
```

--------------------------------

### Success example using a workspace app produces a very different kind of response

Source: https://docs.slack.dev/reference/methods/oauth.access

Response for workspace apps includes ok, token_type, app_id, app_user_id, authorizing_user, installer_user, and scopes object with per-context scope lists.

```json
{  "ok": true,  "access_token": "xoxa-access-token-string",  "token_type": "app",  "app_id": "A012345678",  "app_user_id": "U0NKHRW57",  "team_name": "Subarachnoid Workspace",  "team_id": "T061EG9R6",  "enterprise_id": null,  "authorizing_user": {    "user_id": "U061F7AUR",    "app_home": "D0PNCRP9N"  },  "installer_user": {    "user_id": "U061F7AUR",    "app_home": "D0PNCRP9N"  },  "scopes": {    "app_home": [      "chat:write",      "im:history",      "im:read"    ],    "team": [],    "channel": [      "channels:history",      "channels:read",      "chat:write"    ],    "group": [      "chat:write"    ],    "mpim": [      "chat:write"    ],    "im": [      "chat:write"    ],    "user": []  }}
```

--------------------------------

### GET request to conversations.replies API

Source: https://docs.slack.dev/reference/methods/conversations.replies

HTTP GET request to retrieve a thread of messages.

```http
GET https://slack.com/api/conversations.replies
```

--------------------------------

### views.publish method access examples

Source: https://docs.slack.dev/reference/methods/views.publish

Shows the HTTP endpoint and the Slack CLI, Bolt JavaScript, Bolt Python, and Bolt Java method calls for publishing a view.

```http
POST https://slack.com/api/views.publish
```

```bash
slack api views.publish
```

```javascript
app.client.views.publish
```

```python
app.client.views_publish
```

```java
app.client().viewsPublish
```

--------------------------------

### POST /api/admin.users.session.getSettings

Source: https://docs.slack.dev/reference/methods/admin.users.session.getSettings

HTTP API documentation for the admin.users.session.getSettings method.

```APIDOC
## POST /api/admin.users.session.getSettings

### Description
Get user-specific session settings—the session duration and what happens when the client closes—given a list of users.

### Method
POST

### Endpoint
https://slack.com/api/admin.users.session.getSettings

### Parameters
#### Request Body
- **user_ids** (array of strings) - Required - The list of user IDs to retrieve session settings for.

### Request Example
```json
{
  "user_ids": ["U1234ABCD"]
}
```

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates success.
- **session_settings** (object) - Contains the session settings for each user.

#### Response Example
```json
{
  "ok": true,
  "session_settings": {
    "U1234ABCD": {
      "desktop_app_session_duration": 43200,
      "mobile_app_session_duration": 43200,
      "web_app_session_duration": 43200,
      "client_close_action": "terminate"
    }
  }
}
```

### Error Handling
- **400** - Bad request, e.g., missing required parameters.
- **403** - Access denied, e.g., missing required scope.
- **429** - Rate limit exceeded.

### Scopes
User token: `admin.users:read`

### Content Types
`application/x-www-form-urlencoded`, `application/json`

### Rate Limits
Tier 4: 100+ per minute
```

--------------------------------

### HTTP GET request for conversations.list

Source: https://docs.slack.dev/reference/methods/conversations.list

The standard HTTP GET request to list conversations.

```http
GET https://slack.com/api/conversations.list
```

--------------------------------

### HTTP GET request for admin.analytics.messages.metadata

Source: https://docs.slack.dev/reference/methods/admin.analytics.messages.metadata

The base HTTP GET request endpoint for the method.

```http
GET https://slack.com/api/admin.analytics.messages.metadata
```

--------------------------------

### HTTP GET request for users.deletePhoto

Source: https://docs.slack.dev/reference/methods/users.deletePhoto

The standard HTTP GET request to invoke the users.deletePhoto method.

```http
GET https://slack.com/api/users.deletePhoto
```

--------------------------------

### Java (Bolt) call to users.list

Source: https://docs.slack.dev/reference/methods/users.list

Java example using Slack SDK's client to call usersList. Requires an initialized Slack client with the users:read scope.

```java
app.client().usersList
```

--------------------------------

### HTTP GET request for usergroups.users.list

Source: https://docs.slack.dev/reference/methods/usergroups.users.list

The standard HTTP GET request format for the usergroups.users.list method.

```http
GET https://slack.com/api/usergroups.users.list
```

--------------------------------

### HTTP GET request for team.profile.get

Source: https://docs.slack.dev/reference/methods/team.profile.get

The standard HTTP GET request to retrieve the team profile.

```http
GET https://slack.com/api/team.profile.get
```

--------------------------------

### Create list with description and schema

Source: https://docs.slack.dev/reference/methods/slackLists.create

Creates a list with both a rich text description and a schema definition.

```json
{  "token": "***",  "name": "Favorite Shows",  "description_blocks": [    {      "type": "rich_text",      "elements": [        {          "type": "rich_text_section",          "elements": [            {              "type": "text",              "text": "The Rise and Fall of Sanctuary Moon"            }          ]        }      ]    }  ],  "schema": [    {      "key": "title",      "name": "Title",      "type": "text",      "is_primary_column": true    }  ]}
```

--------------------------------

### Call functions.distributions.permissions.list via HTTP, Slack CLI, Bolt JS, Python, and Java

Source: https://docs.slack.dev/reference/methods/functions.distributions.permissions.list

Shows the method access examples for the functions.distributions.permissions.list API method across HTTP, Slack CLI, Bolt for JavaScript, Bolt for Python, and Bolt for Java. Use the appropriate call for your development environment.

```http
POST https://slack.com/api/functions.distributions.permissions.list
```

```bash
slack api functions.distributions.permissions.list
```

```javascript
app.client.functions.distributions.permissions.list
```

```python
app.client.functions_distributions_permissions_list
```

```java
app.client().functionsDistributionsPermissionsList
```

--------------------------------

### HTTP GET request for rtm.start

Source: https://docs.slack.dev/reference/methods/rtm.start

The standard HTTP GET request format for the rtm.start method.

```http
GET https://slack.com/api/rtm.start
```

--------------------------------

### HTTP GET request for reminders.info

Source: https://docs.slack.dev/reference/methods/reminders.info

The standard HTTP GET request to retrieve reminder information.

```http
GET https://slack.com/api/reminders.info
```

--------------------------------

### slack api apps.manifest.create

Source: https://docs.slack.dev/reference/methods/apps.manifest.create

Slack CLI command to create an app from an app manifest. Requires the same arguments as the HTTP method.

```APIDOC
## [CLI] slack api apps.manifest.create

### Description
Invoke the apps.manifest.create method via the Slack CLI to create an app from an app manifest.

### Command
`slack api apps.manifest.create`

### Arguments
Same as the HTTP method: `token` (required), `manifest` (required), optional `team_id`.

### Rate Limits
Tier 1
```

--------------------------------

### HTTP GET request for files.remote.share

Source: https://docs.slack.dev/reference/methods/files.remote.share

The standard HTTP GET request format for the files.remote.share method.

```http
GET https://slack.com/api/files.remote.share
```

--------------------------------

### slackLists.create

Source: https://docs.slack.dev/reference/methods/slackLists.create

Documentation for the slackLists.create method, which creates a new standalone List owned by the acting user. It includes the schema definition, schema-specific values, and usage notes.

```APIDOC
## [POST] slackLists.create

### Description
Creates a new standalone List owned by the acting user. The List is created with only one text column if no optional parameters are specified. When `todo_mode` is set to true, the List is created with additional fields for task tracking: Completed, Assignee, and Due date.

### Method
POST

### Endpoint
slackLists.create

### Parameters
#### Request Body
- **schema** (array) - Optional - The schema definition for the List columns. Each column object has the following fields:
  - **key** (string) - Required - Key of the column.
  - **name** (string) - Required - Name of the column to be displayed in the List.
  - **type** (string) - Required - Type of the column. See schema-specific values below.
  - **is_primary_column** (boolean) - Optional - Whether the column is the primary column. Only one column can be the primary column, and it must be a text column. Cannot be reassigned.
  - **options** (object) - Optional - Column options.
    - **choices** (array) - Optional - Used by select columns to specify options. Each choice has:
      - **value** (string) - Required - Value for the option.
      - **label** (string) - Required - Label of the option to be displayed in the List.
      - **color** (string) - Required - Color type. See schema-specific values below.
    - **format** (string) - Optional - Used by some columns (such as select) to specify options/formatting. See schema-specific values below.
    - **precision** (integer) - Optional - Used by numeric columns to specify number of decimal places.
    - **date_format** (string) - Optional - Used by date columns to specify the format of the date. See schema-specific values below.
    - **emoji** (string) - Optional - The emoji to be displayed e.g., ":smile:". Used by rating and vote columns.
    - **emoji_team_id** (string) - Optional - The team ID the emoji belongs to. Used by rating columns.
    - **max** (integer) - Optional - Used by rating columns to specify the maximum rate value.
    - **default_value_typed** (object) - Optional - Default value for some columns.
      - **user** (array of string) - Optional - Default user values (encoded user ids) for the people column.
      - **channel** (array of string) - Optional - Default channel values (encoded channel ids) for the channel column.
      - **select** (array of string) - Optional - Default select values for the select column. These values should be the same ones used in the choices value. When defining a select column, you can add up to 100 options, but only up to 50 for a single cell.
    - **show_member_name** (boolean) - Optional - Used by people, channel, and canvas columns to specify whether the entity name should be shown. Default is true.
    - **notify_users** (boolean) - Optional - Used by people columns to specify whether the users should be notified when the column is updated.
- **todo_mode** (boolean) - Optional - When set to true, the List is created with additional fields for task tracking: Completed, Assignee, and Due date.

### Schema-specific values
#### schema.type
- text
- message
- number
- select
- date
- user
- attachment
- checkbox
- email
- phone
- channel
- rating
- created_by
- last_edited_by
- created_time
- last_edited_time
- vote
- canvas
- reference
- link

#### schema.options.format
- single_select: format used by select columns to select a single option
- multi_select: format used by select columns to allow multiple selections
- single_entity: format used by user and channel columns to allow only one entity in the cell
- multi_entity: format used by user and channel columns to allow multiple entities in the cell

#### schema.options.date_format
- default
- DD/MM/YYYY
- MM/DD/YYYY
- YYYY/MM/DD
- MMMM DD, YYYY
- DD MMMM YYYY

#### schema.options.choices.color
- indigo
- blue
- cyan
- pink
- yellow
- green
- gray
- red
- purple
- orange
- brown

### Request Example
```json
{
  "schema": [
    {
      "key": "column_key",
      "name": "Column Name",
      "type": "text",
      "is_primary_column": true,
      "options": {
        "format": "single_select",
        "choices": [
          {
            "value": "option_value",
            "label": "Option Label",
            "color": "blue"
          }
        ]
      }
    }
  ],
  "todo_mode": true
}
```

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates if the request was successful.
- **list** (object) - The created List object.

#### Response Example
```json
{
  "ok": true,
  "list": {
    "id": "list_id",
    "name": "List Name",
    "columns": [
      {
        "key": "column_key",
        "name": "Column Name",
        "type": "text"
      }
    ]
  }
}
```
```

--------------------------------

### HTTP GET request for dnd.info

Source: https://docs.slack.dev/reference/methods/dnd.info

The standard HTTP GET request to retrieve Do Not Disturb status.

```http
GET https://slack.com/api/dnd.info
```

--------------------------------

### HTTP GET request for admin.barriers.list

Source: https://docs.slack.dev/reference/methods/admin.barriers.list

The standard HTTP GET request format for the admin.barriers.list method.

```http
GET https://slack.com/api/admin.barriers.list
```

--------------------------------

### HTTP GET request for users.conversations

Source: https://docs.slack.dev/reference/methods/users.conversations

Makes a GET request to the Slack API endpoint for the users.conversations method.

```http
GET https://slack.com/api/users.conversations
```

--------------------------------

### slackLists.create

Source: https://docs.slack.dev/reference/methods/slackLists.create

Documentation for the slackLists.create method, which creates a new list by copying an existing list and its records.

```APIDOC
## slackLists.create

### Description
Creates a new list in Slack. The response includes the list ID and metadata describing the list's schema, including columns and their types.

### Method
POST

### Endpoint
slackLists.create

### Parameters
#### Request Body
- **list_id** (string) - Required - The ID of an existing list to copy from, including its records.

### Request Example
```json
{
  "list_id": "F1234ABCD"
}
```

### Response
#### Success Response (200)
- **ok** (boolean) - Indicates success.
- **list_id** (string) - The ID of the newly created list.
- **list_metadata** (object) - Metadata describing the list's schema.
  - **schema** (array) - Array of column definitions.
    - **key** (string) - The column key.
    - **name** (string) - The column name.
    - **is_primary_column** (boolean) - Whether this is the primary column.
    - **type** (string) - The column type (e.g., text, rich_text, message, number, select, multi_select, date, user, attachment, checkbox, email, phone, channel, rating, vote, assignee, due_date, completed, canvas, link).
    - **id** (string) - The column ID.
    - **options** (object) - Optional column-specific options (e.g., precision, choices, format, emoji, max, show_member_name).
  - **subtask_schema** (array) - Array of subtask column definitions (same structure as schema).

#### Response Example
```json
{
  "ok": true,
  "list_id": "F1234ABCD",
  "list_metadata": {
    "schema": [
      {
        "key": "title",
        "name": "Title",
        "is_primary_column": true,
        "type": "text",
        "id": "Col012A3BCDE4"
      }
    ],
    "subtask_schema": [
      {
        "key": "title",
        "name": "Title",
        "is_primary_column": true,
        "type": "text",
        "id": "Col654A3BCDE2"
      }
    ]
  }
}
```
```

--------------------------------

### admin.conversations.bulkSetProperties method access examples

Source: https://docs.slack.dev/reference/methods/admin.conversations.bulkSetProperties

Shows the method access patterns for admin.conversations.bulkSetProperties across HTTP, Slack CLI, and Slack SDKs (JavaScript, Python, Java).

```http
POST https://slack.com/api/admin.conversations.bulkSetProperties
```

```bash
slack api admin.conversations.bulkSetProperties
```

```javascript
app.client.admin.conversations.bulkSetProperties
```

```python
app.client.admin_conversations_bulkSetProperties
```

```java
app.client().adminConversationsBulkSetProperties
```

--------------------------------

### markdown_text chunk example

Source: https://docs.slack.dev/reference/methods/chat.appendStream

Example of a markdown_text chunk for streaming text content with markdown formatting support.

```json
{  "type": "markdown_text",  "text": "We love Sandra"}
```

--------------------------------

### admin.conversations.lookup response example

Source: https://docs.slack.dev/reference/methods/admin.conversations.lookup

Example response showing a successful lookup with an array of encoded channel IDs.

```json
{
		"ok": true,
		"channels": ['encoded_id_1', 'encoded_id_2']
	}
```

--------------------------------

### POST /api/apps.manifest.create

Source: https://docs.slack.dev/reference/methods/apps.manifest.create

Creates a Slack app from an app manifest. Requires an app configuration token and a valid app manifest as a string. Available via HTTP and Slack SDKs.

```APIDOC
## [POST] https://slack.com/api/apps.manifest.create

### Description
Create an app from an app manifest.

### Method
POST

### Endpoint
https://slack.com/api/apps.manifest.create

### Parameters
#### Required Arguments
- **token** (string) - Required - An app configuration access token.
- **manifest** (string) - Required - A JSON app manifest encoded as a string. Must use a valid app manifest schema.

#### Optional Arguments
- **team_id** (string) - Optional - When called with an org token, which specific team to create app on.

### Content Types
`application/x-www-form-urlencoded`

`application/json`

### Rate Limits
Tier 1: 1+ per minute

### Scopes
`app_configurations:write`

### Request Example
POST https://slack.com/api/apps.manifest.create
Content-Type: application/json
{
  "token": "xxxx-xxxxxxxxx-xxxx",
  "manifest": "{\"display_information\":{\"name\":\"My App\"}}",
  "team_id": "T12345678"
}
```
Tokens:
Raw