Skip to content

Instantly share code, notes, and snippets.

@kmahorker

kmahorker/slacktest

Created February 14, 2025 07:52
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save kmahorker/b4018399a1e9d1cb163ff22b695f6325 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save kmahorker/b4018399a1e9d1cb163ff22b695f6325 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
slacktest
This file has been truncated, but you can view the full file.
openapi: 3.0.0
servers:
- url: https://slack.com/api
info:
contact:
name: Slack developer relations
url: https://api.slack.com/support
description: The Slack Web API allows you to interact with the Slack platform, including sending messages, managing channels and users, and integrating workspace features.
title: Slack Web API
version: 1.7.0
x-apisguru-categories:
- collaboration
- messaging
x-logo:
url: https://api.apis.guru/v2/cache/logo/http_static.tumblr.com_wvuzcz9_LlKncfhmp_slack_logo_240.png
x-origin:
- format: openapi
url: https://raw.githubusercontent.com/slackapi/slack-api-specs/master/web-api/slack_web_openapi_v2.json
version: '3.0'
x-providerName: slack.com
summary: Send messages, manage channels and users, and integrate workspace features.
x-api-uuid: 006927c6-110b-44af-b502-40a800af0b91
externalDocs:
description: Learn more about the Slack Web API
url: https://api.slack.com/web
tags: []
paths:
/admin.apps.approve:
post:
description: This allows administrators to approve an application for installation within a Slack workspace. Once approved, the app can be used by members of the workspace, enabling its features and integrations.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.apps.approve
operationId: slack_web_api_admin_apps_approve
parameters:
- description: 'Authentication token. Requires scope: `admin.apps:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
app_id:
description: The id of the app to approve.
type: string
request_id:
description: The id of the request to approve.
type: string
team_id:
type: string
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.apps:write
tags:
- admin.apps
- admin
summary: Approve app for workspace use
x-uuid: 2d988273-3c02-4dbb-80ce-eda9397186b0
/admin.apps.approved.list:
get:
description: Retrieve a list of all applications that have been approved for use within a specific organization or workspace. This helps administrators keep track of which apps are available to users.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.apps.approved.list
operationId: slack_web_api_admin_apps_approved_list
parameters:
- description: 'Authentication token. Requires scope: `admin.apps:read`'
in: query
name: token
required: true
schema:
type: string
- description: The maximum number of items to return. Must be between 1 - 1000 both inclusive.
in: query
name: limit
schema:
type: integer
- description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
in: query
name: cursor
schema:
type: string
- in: query
name: team_id
schema:
type: string
- in: query
name: enterprise_id
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
approved_apps:
- app:
additional_info: ''
app_directory_url: https://myteam.enterprise.slack.com/apps/A0W7UKG8E-my-test-app
app_homepage_url: https://www.slack.com
description: test app
help_url: https://www.slack.com
icons:
image_1024: https://3026743124446w96_2bd4ea1ad1f89a23c242_1024.png
image_128: https://30267341249446w6_2bd4ea1ad1f89a23c242_128.png
image_192: https://30267431249446w6_2bd4ea1ad1f89a23c242_192.png
image_32: https://302674312496446w_2bd4ea1ad1f89a23c242_32.png
image_36: https://302674312496446w_2bd4ea1ad1f89a23c242_36.png
image_48: https://302674312496446w_2bd4ea1ad1f89a23c242_48.png
image_512: https://30267431249446w6_2bd4ea1ad1f89a23c242_512.png
image_64: https://302674312496446w_2bd4ea1ad1f89a23c242_64.png
image_72: https://302674312496446w_2bd4ea1ad1f89a23c242_72.png
image_96: https://302674312496446w_2bd4ea1ad1f89a23c242_96.png
image_original: https://302674446w12496_2bd4ea1ad1f89a23c242_original.png
id: A0W7UKG8E
is_app_directory_approved: false
is_internal: false
name: My Test App
privacy_policy_url: https://www.slack.com
date_updated: 1574296707
last_resolved_by:
actor_id: W0G82F4FD
actor_type: user
scopes:
- description: Add the ability for people to direct message or mention @my_test_app
is_sensitive: true
name: bot
token_type: bot
ok: true
response_metadata:
next_cursor: ''
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.apps:read
tags:
- admin.apps.approved
- admin
summary: List approved apps
x-uuid: ea49d928-212c-47d5-a95a-5bdb554d68ad
/admin.apps.requests.list:
get:
description: This endpoint provides a list of all app installation requests made by members of a team or workspace. Administrators can review these requests to decide whether to approve or deny them.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.apps.requests.list
operationId: slack_web_api_admin_apps_requests_list
parameters:
- description: 'Authentication token. Requires scope: `admin.apps:read`'
in: query
name: token
required: true
schema:
type: string
- description: The maximum number of items to return. Must be between 1 - 1000 both inclusive.
in: query
name: limit
schema:
type: integer
- description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
in: query
name: cursor
schema:
type: string
- in: query
name: team_id
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
app_requests:
- app:
additional_info: ''
app_directory_url: https://acmecorp.slack.com/apps/A061BL8RQ0-test-app
app_homepage_url: ''
description: ''
help_url: ''
icons:
image_1024: /cdn/15258203/img/testapp/service_1024.png
image_128: /cdn/157258203/img/testapp/service_128.png
image_192: /cdn/157258203/img/testapp/service_192.png
image_32: /cdn/157658203/img/testapp/service_32.png
image_36: /cdn/157658203/img/testapp/service_36.png
image_48: /cdn/157658203/img/testapp/service_48.png
image_512: /cdn/15758203/img/testapp/service_512.png
image_64: /cdn/157658203/img/testapp/service_64.png
image_72: /cdn/157658203/img/testapp/service_72.png
image_96: /cdn/157658203/img/testapp/service_96.png
id: A061BL8RQ0
is_app_directory_approved: true
is_internal: false
name: Test App
privacy_policy_url: https://testapp.com/privacy
date_created: 1578956327
id: Ar0XJGFLMLS
message: test test again
previous_resolution: null
scopes:
- description: Post messages to specific channels in Slack
is_sensitive: false
name: incoming-webhook
token_type: user
team:
domain: acmecorp
id: T0M94LNUCR
name: Acme Corp
user:
email: janedoe@example.com
id: W08RA9G5HR
name: Jane Doe
ok: true
response_metadata:
next_cursor: ''
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: missing_scope
needed: admin.apps:read
ok: false
provided: read,client,admin,identify,post,apps
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.apps:read
tags:
- admin.apps.requests
- admin
summary: List app installation requests
x-uuid: 209e5d1f-de3b-4e62-8ccf-fffe630df927
/admin.apps.restrict:
post:
description: Restrict an application from being installed in a Slack workspace. This endpoint is used by administrators to prevent certain apps from being used by workspace members.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.apps.restrict
operationId: slack_web_api_admin_apps_restrict
parameters:
- description: 'Authentication token. Requires scope: `admin.apps:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
app_id:
description: The id of the app to restrict.
type: string
request_id:
description: The id of the request to restrict.
type: string
team_id:
type: string
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.apps:write
tags:
- admin.apps
- admin
summary: Restrict app installation
x-uuid: d40c1ba3-9f0e-4617-9096-6f12298c36d5
/admin.apps.restricted.list:
get:
description: Retrieve a list of applications that have been restricted from use within a specific organization or workspace. This helps administrators monitor which apps are not allowed.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.apps.restricted.list
operationId: slack_web_api_admin_apps_restricted_list
parameters:
- description: 'Authentication token. Requires scope: `admin.apps:read`'
in: query
name: token
required: true
schema:
type: string
- description: The maximum number of items to return. Must be between 1 - 1000 both inclusive.
in: query
name: limit
schema:
type: integer
- description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
in: query
name: cursor
schema:
type: string
- in: query
name: team_id
schema:
type: string
- in: query
name: enterprise_id
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
response_metadata:
next_cursor: ''
restricted_apps:
- app:
additional_info: ''
app_directory_url: https://myteam.enterprise.slack.com/apps/A0FDLP8M2L-my-test-app
app_homepage_url: https://example.com
description: A fun test app for Slack
help_url: https://example.com
icons:
image_1024: https://1433265338rl878408_eb57dbc818daa4ba15d6_1024.png
image_128: https://4332653438rl87808_eb57dbc818daa4ba15d6_128.png
image_192: https://4332653438rl87808_eb57dbc818daa4ba15d6_192.png
image_32: https://143326534038rl8788_eb57dbc818daa4ba15d6_32.png
image_36: https://143326534038rl8788_eb57dbc818daa4ba15d6_36.png
image_48: https://143326534038rl8788_eb57dbc818daa4ba15d6_48.png
image_512: https://4332653438rl87808_eb57dbc818daa4ba15d6_512.png
image_64: https://143326534038rl8788_eb57dbc818daa4ba15d6_64.png
image_72: https://143326534038rl8788_eb57dbc818daa4ba15d6_72.png
image_96: https://143326534038rl8788_eb57dbc818daa4ba15d6_96.png
image_original: https://143338rl8782653408_eb57dbc818daa4ba15d6_original.png
id: A0FDLP8M2L
is_app_directory_approved: true
is_internal: false
name: My Test App
privacy_policy_url: https://example.com
date_updated: 1574296721
last_resolved_by:
actor_id: W0G82LMFD
actor_type: user
scopes:
- description: Upload, edit, and delete files on the user‟s behalf
is_sensitive: true
name: files:write:user
token_type: user
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.apps:read
tags:
- admin.apps.restricted
- admin
summary: List restricted apps
x-uuid: 4c43b355-520d-4063-a475-193f3e22e7b7
/admin.conversations.archive:
post:
description: Archive a channel, whether public or private, within a Slack workspace. Archiving a channel hides it from the channel list but retains its history for future reference.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.archive
operationId: slack_web_api_admin_conversations_archive
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_id:
description: The channel to archive.
type: string
required:
- channel_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response of admin.conversations.archive
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: admin.conversations.archive schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from admin.conversations.archive
properties:
error:
enum:
- feature_not_enabled
- channel_not_found
- channel_type_not_supported
- default_org_wide_channel
- already_archived
- cant_archive_general
- restricted_action
- could_not_archive_channel
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: admin.conversations.archive error schema
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:write
tags:
- admin.conversations
- admin
summary: Archive a channel
x-uuid: 897574c1-55d4-467b-8157-53ca58a6d240
/admin.conversations.convertToPrivate:
post:
description: Convert a public channel into a private one. This action restricts access to the channel, making it visible only to invited members.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.convertToPrivate
operationId: slack_web_api_admin_conversations_convert_to_private
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_id:
description: The channel to convert to private.
type: string
required:
- channel_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response of admin.conversations.convertToPrivate
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: admin.conversations.convertToPrivate schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from admin.conversations.convertToPrivate
properties:
error:
enum:
- feature_not_enabled
- restricted_action
- name_taken
- channel_not_found
- channel_type_not_supported
- default_org_wide_channel
- method_not_supported_for_channel_type
- could_not_convert_channel
- external_channel_migrating
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: admin.conversations.convertToPrivate error schema
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:write
tags:
- admin.conversations
- admin
summary: Convert channel to private
x-uuid: db3b8356-269b-4a8e-a4b4-ca07270d3137
/admin.conversations.create:
post:
description: Create a new conversation channel in Slack, which can be either public or private. This allows administrators to set up new spaces for team communication.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.create
operationId: slack_web_api_admin_conversations_create
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
description:
description: Description of the public or private channel to create.
type: string
is_private:
description: When `true`, creates a private channel instead of a public channel
type: boolean
name:
description: Name of the public or private channel to create.
type: string
org_wide:
description: 'When `true`, the channel will be available org-wide. Note: if the channel is not `org_wide=true`, you must specify a `team_id` for this channel'
type: boolean
team_id:
description: 'The workspace to create the channel in. Note: this argument is required unless you set `org_wide=true`.'
type: string
required:
- name
- is_private
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
channel_id: C12345
ok: true
schema:
additionalProperties: false
description: Schema for successful response of admin.conversations.create
properties:
channel_id:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: admin.conversations.create schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from admin.conversations.create
properties:
error:
enum:
- feature_not_enabled
- name_taken
- restricted_action
- team_not_found
- invalid_team
- invalid_name
- could_not_create_channel
- team_id_or_org_required
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: admin.conversations.create error schema
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:write
tags:
- admin.conversations
- admin
summary: Create a new channel
x-uuid: 455b1d34-18ce-45f7-af24-91ffcecc4b48
/admin.conversations.delete:
post:
description: Permanently delete a channel, whether public or private, from a Slack workspace. This action removes the channel and its history completely.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.delete
operationId: slack_web_api_admin_conversations_delete
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_id:
description: The channel to delete.
type: string
required:
- channel_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response of admin.conversations.delete
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: admin.conversations.delete schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from admin.conversations.delete
properties:
error:
enum:
- feature_not_enabled
- not_an_admin
- channel_not_found
- channel_type_not_supported
- default_org_wide_channel
- restricted_action
- could_not_delete_channel
- missing_scope
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: admin.conversations.delete error schema
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:write
tags:
- admin.conversations
- admin
summary: Delete a channel
x-uuid: 9e909ead-4734-4060-afd4-1aafcc24ce5c
/admin.conversations.disconnectShared:
post:
description: Disconnect a shared channel from one or more workspaces. This action removes the channel's connection to other workspaces while retaining its content in the original workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.disconnectShared
operationId: slack_web_api_admin_conversations_disconnect_shared
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_id:
description: The channel to be disconnected from some workspaces.
type: string
leaving_team_ids:
description: The team to be removed from the channel. Currently only a single team id can be specified.
type: string
required:
- channel_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response of admin.conversations.disconnectShared
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: admin.conversations.rename schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from admin.conversations.disconnectShared
properties:
error:
enum:
- feature_not_enabled
- not_an_admin
- not_an_enterprise
- channel_not_found
- not_supported
- team_not_found
- restricted_action
- missing_scope
- leaving_team_not_in_channel
- no_teams_to_disconnect
- leaving_team_required
- cannot_kick_team
- cannot_kick_home_team
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: admin.conversations.disconnectShared error schema
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:write
tags:
- admin.conversations
- admin
summary: Disconnect shared channel
x-uuid: 0e6bb466-5c0a-4401-bc0b-b3b5ac86aa57
/admin.conversations.ekm.listOriginalConnectedChannelInfo:
get:
description: List all channels that were once connected to other workspaces but have since been disconnected. This includes the original channel IDs, useful for key revocation with Enterprise Key Management (EKM).
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo
operationId: slack_web_api_admin_conversations_ekm_list_original_connected_channel_info
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:read`'
in: query
name: token
required: true
schema:
type: string
- description: A comma-separated list of channels to filter to.
in: query
name: channel_ids
schema:
type: string
- description: A comma-separated list of the workspaces to which the channels you would like returned belong.
in: query
name: team_ids
schema:
type: string
- description: The maximum number of items to return. Must be between 1 - 1000 both inclusive.
in: query
name: limit
schema:
type: integer
- description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
in: query
name: cursor
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
channels:
- id: string
internal_team_ids: array
original_connected_channel_id: string
original_connected_host_id: string
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:read
tags:
- admin.conversations.ekm
- admin
summary: List disconnected channels with EKM info
x-uuid: 41ded63c-7f88-47fd-8083-1d0b4c6e6888
/admin.conversations.getConversationPrefs:
get:
description: Retrieve the preferences and settings for a specific channel, whether public or private. This includes information on posting permissions and other channel-specific configurations.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.getConversationPrefs
operationId: slack_web_api_admin_conversations_get_conversation_prefs
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:read`'
in: header
name: token
required: true
schema:
type: string
- description: The channel to get preferences for.
in: query
name: channel_id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response of admin.conversations.getConversationPrefs
properties:
ok:
enum:
- true
title: default success response
type: boolean
prefs:
properties:
can_thread:
properties:
type:
items:
type: string
type: array
user:
items:
type: string
type: array
type: object
who_can_post:
properties:
type:
items:
type: string
type: array
user:
items:
type: string
type: array
type: object
type: object
required:
- ok
title: admin.conversations.getConversationPrefs schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from admin.conversations.getConversationPrefs
properties:
error:
enum:
- feature_not_enabled
- not_an_admin
- not_an_enterprise
- restricted_action
- missing_scope
- channel_not_found
- channel_type_not_supported
- could_not_get_conversation_prefs
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: admin.conversations.unarchive error schema
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:read
tags:
- admin.conversations
- admin
summary: Get channel preferences
x-uuid: 8ca55dec-27a2-4ff8-af9e-fbd2dca6d3c4
/admin.conversations.getTeams:
get:
description: Retrieve a list of all workspaces that a specific channel, public or private, is connected to within an Enterprise organization. This helps in managing channel access across multiple workspaces.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.getTeams
operationId: slack_web_api_admin_conversations_get_teams
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:read`'
in: header
name: token
required: true
schema:
type: string
- description: The channel to determine connected workspaces within the organization for.
in: query
name: channel_id
required: true
schema:
type: string
- description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
in: query
name: cursor
schema:
type: string
- description: The maximum number of items to return. Must be between 1 - 1000 both inclusive.
in: query
name: limit
schema:
type: integer
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
teams:
- T1234
- T5678
schema:
additionalProperties: false
description: Schema for successful response of admin.conversations.getTeams
properties:
ok:
enum:
- true
title: default success response
type: boolean
response_metadata:
additionalProperties: false
properties:
next_cursor:
type: string
required:
- next_cursor
type: object
team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
type: array
required:
- ok
- team_ids
title: admin.conversations.getTeams schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from admin.conversations.getTeams
properties:
error:
enum:
- feature_not_enabled
- channel_not_found
- channel_type_not_supported
- unsupported_team_type
- restricted_action
- could_not_get_teams
- invalid_cursor
- invalid_limit
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: admin.conversations.getTeams error schema
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:read
tags:
- admin.conversations
- admin
summary: Get channel-connected workspaces
x-uuid: a963ecec-2927-4b4a-a77d-f8f05b488e3b
/admin.conversations.invite:
post:
description: Invite a user to join a specific channel, whether public or private, within a Slack workspace. This allows administrators to manage channel membership.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.invite
operationId: slack_web_api_admin_conversations_invite
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_id:
description: The channel that the users will be invited to.
type: string
user_ids:
description: The users to invite.
type: string
required:
- user_ids
- channel_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response of admin.conversations.invite
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: admin.conversations.invite schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: Schema for error response from admin.conversations.invite
properties:
error:
enum:
- feature_not_enabled
- channel_not_found
- channel_type_not_supported
- default_org_wide_channel
- restricted_action
- user_must_be_admin
- failed_for_some_users
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: admin.conversations.invite error schema
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:write
tags:
- admin.conversations
- admin
summary: Invite user to channel
x-uuid: 66936658-6388-47c4-9c4a-fe922f0a6641
/admin.conversations.rename:
post:
description: Change the name of a channel, whether public or private, within a Slack workspace. This helps in keeping channel names relevant and up-to-date.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.rename
operationId: slack_web_api_admin_conversations_rename
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_id:
description: The channel to rename.
type: string
name:
type: string
required:
- channel_id
- name
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response of admin.conversations.rename
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: admin.conversations.rename schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from admin.conversations.rename
properties:
error:
enum:
- feature_not_enabled
- channel_not_found
- channel_type_not_supported
- restricted_action
- could_not_rename_channel
- default_org_wide_channel
- name_taken
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: admin.conversations.unarchive error schema
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:write
tags:
- admin.conversations
- admin
summary: Rename a channel
x-uuid: 4b0ce9cb-0386-40d8-aee2-cf9114693284
/admin.conversations.restrictAccess.addGroup:
post:
description: Add an allowlist of Identity Provider (IDP) groups that are permitted to access a specific channel. This helps in managing access control for sensitive channels.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup
operationId: slack_web_api_admin_conversations_restrict_access_add_group
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_id:
description: The channel to link this group to.
type: string
group_id:
description: The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to be an allowlist for the private channel.
type: string
team_id:
description: The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.
type: string
token:
description: 'Authentication token. Requires scope: `admin.conversations:write`'
type: string
required:
- token
- group_id
- channel_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:write
tags:
- admin.conversations.restrictAccess
- admin
summary: Add IDP group allowlist to channel
x-uuid: c1b2c5d0-e9d0-4dea-8703-57849098abc6
/admin.conversations.restrictAccess.listGroups:
get:
description: List all Identity Provider (IDP) groups that have been linked to a specific channel. This helps administrators review and manage group-based access to channels.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups
operationId: slack_web_api_admin_conversations_restrict_access_list_groups
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:read`'
in: query
name: token
required: true
schema:
type: string
- in: query
name: channel_id
required: true
schema:
type: string
- description: The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.
in: query
name: team_id
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
group_ids:
- YOUR_GROUP_ID
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:read
tags:
- admin.conversations.restrictAccess
- admin
summary: List IDP groups for channel
x-uuid: 7305201a-72c4-4df2-a3f1-f604ae94a896
/admin.conversations.restrictAccess.removeGroup:
post:
description: Remove an Identity Provider (IDP) group from the allowlist of a private channel. This action revokes the group's access to the channel.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.restrictAccess.removeGroup
operationId: slack_web_api_admin_conversations_restrict_access_remove_group
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_id:
description: The channel to remove the linked group from.
type: string
group_id:
description: The [IDP Group](https://slack.com/help/articles/115001435788-Connect-identity-provider-groups-to-your-Enterprise-Grid-org) ID to remove from the private channel.
type: string
team_id:
description: The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization.
type: string
token:
description: 'Authentication token. Requires scope: `admin.conversations:write`'
type: string
required:
- token
- team_id
- group_id
- channel_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:write
tags:
- admin.conversations.restrictAccess
- admin
summary: Remove IDP group from channel
x-uuid: f54bc5a3-cb3b-4c66-a077-419f2c1be685
/admin.conversations.search:
get:
description: Search for channels, both public and private, within an Enterprise organization. This endpoint helps administrators locate specific channels based on various criteria.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.search
operationId: slack_web_api_admin_conversations_search
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:read`'
in: header
name: token
required: true
schema:
type: string
- description: Comma separated string of team IDs, signifying the workspaces to search through.
in: query
name: team_ids
schema:
type: string
- description: Name of the the channel to query by.
in: query
name: query
schema:
type: string
- description: Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10.
in: query
name: limit
schema:
type: integer
- description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
in: query
name: cursor
schema:
type: string
- description: The type of channel to include or exclude in the search. For example `private` will search private channels, while `private_exclude` will exclude them. For a full list of types, check the [Types section](#types).
in: query
name: search_channel_types
schema:
type: string
- description: 'Possible values are `relevant` (search ranking based on what we think is closest), `name` (alphabetical), `member_count` (number of users in the channel), and `created` (date channel was created). You can optionally pair this with the `sort_dir` arg to change how it is sorted '
in: query
name: sort
schema:
type: string
- description: Sort direction. Possible values are `asc` for ascending order like (1, 2, 3) or (a, b, c), and `desc` for descending order like (3, 2, 1) or (c, b, a)
in: query
name: sort_dir
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
channels:
- created: 1449252889
creator: U012A3CDE
id: C012AB3CD
is_archived: false
is_channel: true
is_ext_shared: false
is_general: true
is_group: false
is_im: false
is_member: true
is_mpim: false
is_org_shared: false
is_pending_ext_shared: false
is_private: false
is_shared: false
name: general
name_normalized: general
num_members: 4
pending_shared: []
previous_names: []
purpose:
creator: ''
last_set: 0
value: This channel is for team-wide communication and announcements. All team members are in this channel.
topic:
creator: ''
last_set: 0
value: Company-wide announcements and work-based matters
unlinked: 0
ok: true
response_metadata:
next_cursor: dGVhbTpDMDYxRkE1UEI=
schema:
additionalProperties: false
description: Schema for successful response of admin.conversations.search
properties:
channels:
items:
additionalProperties: false
properties:
accepted_user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
created:
type: integer
creator:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
id:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
is_archived:
type: boolean
is_channel:
type: boolean
is_frozen:
type: boolean
is_general:
type: boolean
is_member:
type: boolean
is_moved:
type: integer
is_mpim:
type: boolean
is_non_threadable:
type: boolean
is_org_shared:
type: boolean
is_pending_ext_shared:
type: boolean
is_private:
type: boolean
is_read_only:
type: boolean
is_shared:
type: boolean
is_thread_only:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest:
items:
anyOf:
- additionalProperties: false
properties:
attachments:
items:
additionalProperties: false
properties:
fallback:
type: string
id:
type: integer
image_bytes:
type: integer
image_height:
type: integer
image_url:
type: string
image_width:
type: integer
required:
- id
type: object
minItems: 1
type: array
uniqueItems: true
blocks:
description: This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace.
items:
additionalProperties: true
properties:
type:
type: string
required:
- type
type: object
title: Block Kit blocks
type: array
bot_id:
items:
anyOf:
- pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
- nullable: true
title: Nil bot_id set when display_as_bot is false
bot_profile:
additionalProperties: false
properties:
app_id:
pattern: ^A[A-Z0-9]{1,}$
title: App ID
type: string
deleted:
type: boolean
icons:
additionalProperties: false
properties:
image_36:
format: uri
type: string
image_48:
format: uri
type: string
image_72:
format: uri
type: string
required:
- image_36
- image_48
- image_72
type: object
id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
name:
type: string
team_id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
updated:
type: integer
required:
- id
- deleted
- name
- updated
- app_id
- icons
- team_id
title: Bot Profile Object
type: object
client_msg_id:
type: string
comment:
additionalProperties: false
properties:
comment:
type: string
created:
type: integer
id:
pattern: ^Fc[A-Z0-9]{8,}$
title: File Comment ID
type: string
is_intro:
type: boolean
is_starred:
type: boolean
num_stars:
type: integer
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
timestamp:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- id
- created
- timestamp
- user
- is_intro
- comment
title: File Comment Object
type: object
display_as_bot:
type: boolean
file:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
files:
items:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
minItems: 1
type: array
uniqueItems: true
icons:
additionalProperties: false
properties:
emoji:
type: string
image_64:
format: uri
type: string
type: object
inviter:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_delayed_message:
type: boolean
is_intro:
type: boolean
is_starred:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest_reply:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
name:
type: string
old_name:
type: string
parent_user_id:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
permalink:
format: uri
type: string
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
purpose:
type: string
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
reply_count:
type: integer
reply_users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 1
type: array
uniqueItems: true
reply_users_count:
type: integer
source_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
subscribed:
type: boolean
subtype:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
text:
type: string
thread_ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
topic:
type: string
ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
type:
type: string
unread_count:
type: integer
upload:
type: boolean
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
user_profile:
additionalProperties: false
properties:
avatar_hash:
type: string
display_name:
type: string
display_name_normalized:
type: string
first_name:
nullable: true
type: string
image_72:
format: uri
type: string
is_restricted:
type: boolean
is_ultra_restricted:
type: boolean
name:
type: string
real_name:
type: string
real_name_normalized:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
required:
- avatar_hash
- image_72
- first_name
- real_name
- display_name
- team
- name
- is_restricted
- is_ultra_restricted
type: object
user_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
username:
type: string
required:
- text
- type
- ts
title: Message object
type: object
- nullable: true
members:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 0
type: array
uniqueItems: true
name:
type: string
name_normalized:
type: string
num_members:
type: integer
pending_shared:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
previous_names:
items:
title: Name of a channel
type: string
minItems: 0
type: array
uniqueItems: true
priority:
type: number
purpose:
additionalProperties: false
properties:
creator:
pattern: ^[UW][A-Z0-9]{8,}$|^$
title: User ID or empty string, used for topic and purpose creation
type: string
last_set:
type: integer
value:
type: string
required:
- value
- creator
- last_set
type: object
topic:
additionalProperties: false
properties:
creator:
pattern: ^[UW][A-Z0-9]{8,}$|^$
title: User ID or empty string, used for topic and purpose creation
type: string
last_set:
type: integer
value:
type: string
required:
- value
- creator
- last_set
type: object
unlinked:
title: Field to determine whether a channel has ever been shared/disconnected in the past
type: integer
unread_count:
type: integer
unread_count_display:
type: integer
required:
- id
- name
- created
- creator
- is_channel
- is_org_shared
- is_private
- is_mpim
- is_shared
- name_normalized
- members
- topic
- purpose
title: Channel Object
type: object
type: array
next_cursor:
type: string
required:
- channels
- next_cursor
title: admin.conversations.search schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: not_an_enterprise
ok: false
schema:
additionalProperties: false
description: Schema for error response from admin.conversations.search
properties:
error:
enum:
- feature_not_enabled
- not_an_admin
- not_an_enterprise
- team_not_found
- not_allowed
- invalid_auth
- invalid_cursor
- invalid_search_channel_type
- invalid_sort
- invalid_sort_dir
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: admin.conversations.search error schema
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:read
tags:
- admin.conversations
- admin
summary: Search for channels in organization
x-uuid: d62f3d11-da1e-4744-ba46-f970ad89fc29
/admin.conversations.setConversationPrefs:
post:
description: Set or update the posting permissions and other preferences for a specific channel, whether public or private. This helps in managing how users interact within the channel.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.setConversationPrefs
operationId: slack_web_api_admin_conversations_set_conversation_prefs
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_id:
description: The channel to set the prefs for
type: string
prefs:
description: The prefs for this channel in a stringified JSON format.
type: string
required:
- channel_id
- prefs
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response of admin.conversations.setConversationPrefs
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: admin.conversations.setConversationPrefs schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from admin.conversations.setConversationPrefs
properties:
error:
enum:
- feature_not_enabled
- not_an_admin
- channel_not_found
- channel_type_not_supported
- restricted_action
- missing_scope
- could_not_set_channel_pref
- default_org_wide_channel
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: admin.conversations.setConversationPrefs error schema
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:write
tags:
- admin.conversations
- admin
summary: Set channel posting permissions
x-uuid: f67c6bfc-cbac-4701-b892-47bd74bb3df1
/admin.conversations.setTeams:
post:
description: Configure which workspaces within an Enterprise grid organization are connected to a specific channel, whether public or private. This helps in managing channel access across multiple workspaces.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.setTeams
operationId: slack_web_api_admin_conversations_set_teams
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_id:
description: The encoded `channel_id` to add or remove to workspaces.
type: string
org_channel:
description: True if channel has to be converted to an org channel
type: boolean
target_team_ids:
description: A comma-separated list of workspaces to which the channel should be shared. Not required if the channel is being shared org-wide.
type: string
team_id:
description: The workspace to which the channel belongs. Omit this argument if the channel is a cross-workspace shared channel.
type: string
required:
- channel_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:write
tags:
- admin.conversations
- admin
summary: Set channel-connected workspaces
x-uuid: 12f199e5-84f9-4963-8cde-6a6b9cd7e008
/admin.conversations.unarchive:
post:
description: Unarchive a channel, whether public or private, making it active and visible again in the channel list. This restores the channel for ongoing communication.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.conversations.unarchive
operationId: slack_web_api_admin_conversations_unarchive
parameters:
- description: 'Authentication token. Requires scope: `admin.conversations:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_id:
description: The channel to unarchive.
type: string
required:
- channel_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response of admin.conversations.unarchive
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: admin.conversations.unarchive schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from admin.conversations.unarchive
properties:
error:
enum:
- feature_not_enabled
- channel_not_found
- channel_not_archived
- channel_type_not_supported
- restricted_action
- could_not_unarchive_channel
- default_org_wide_channel
- missing_scope
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: admin.conversations.unarchive error schema
type: object
description: Typical error response
security:
- slackAuth:
- admin.conversations:write
tags:
- admin.conversations
- admin
summary: Unarchive a channel
x-uuid: 15caaacb-a1e5-4500-a048-3c5e8f7dc6ee
/admin.emoji.add:
post:
description: Add a new emoji to the Slack workspace. Emojis are small icons used to express emotions or ideas in messages.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.emoji.add
operationId: slack_web_api_admin_emoji_add
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
name:
description: The name of the emoji to be removed. Colons (`:myemoji:`) around the value are not required, although they may be included.
type: string
token:
description: 'Authentication token. Requires scope: `admin.teams:write`'
type: string
url:
description: The URL of a file to use as an image for the emoji. Square images under 128KB and with transparent backgrounds work best.
type: string
required:
- token
- name
- url
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:write
tags:
- admin.emoji
- admin
summary: Add a new emoji
x-uuid: 1dff1f42-44f5-47ab-b985-b7f2deb28daf
/admin.emoji.addAlias:
post:
description: Create an alias for an existing emoji. This allows users to use a different name to represent the same emoji icon.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.emoji.addAlias
operationId: slack_web_api_admin_emoji_add_alias
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
alias_for:
description: The alias of the emoji.
type: string
name:
description: The name of the emoji to be aliased. Colons (`:myemoji:`) around the value are not required, although they may be included.
type: string
token:
description: 'Authentication token. Requires scope: `admin.teams:write`'
type: string
required:
- token
- name
- alias_for
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:write
tags:
- admin.emoji
- admin
summary: Add emoji alias
x-uuid: 93dd10d8-74df-461b-933c-d5f594a86bc1
/admin.emoji.list:
get:
description: Retrieve a list of all emojis available within an Enterprise Grid organization. This helps administrators manage and review the emoji set.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.emoji.list
operationId: slack_web_api_admin_emoji_list
parameters:
- description: 'Authentication token. Requires scope: `admin.teams:read`'
in: query
name: token
required: true
schema:
type: string
- description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
in: query
name: cursor
schema:
type: string
- description: The maximum number of items to return. Must be between 1 - 1000 both inclusive.
in: query
name: limit
schema:
type: integer
responses:
'200':
content:
application/json:
examples:
response:
value:
cache_ts: '1575283387.000000'
categories:
- emoji_names:
- grinning
- grin
- joy
- etc etc ...
name: Smileys & People
categories_version: '5'
emoji:
black_square: alias:black_large_square
bowtie: https://emoji.slack-edge.com/T9TK3CUKW/bowtie/f3ec6f2bb0.png
cubimal_chick: https://emoji.slack-edge.com/T9TK3CUKW/cubimal_chick/85961c43d7.png
dusty_stick: https://emoji.slack-edge.com/T9TK3CUKW/dusty_stick/6177a62312.png
glitch_crab: https://emoji.slack-edge.com/T9TK3CUKW/glitch_crab/db049f1f9c.png
piggy: https://emoji.slack-edge.com/T9TK3CUKW/piggy/b7762ee8cd.png
pride: https://emoji.slack-edge.com/T9TK3CUKW/pride/56b1bd3388.png
shipit: alias:squirrel
simple_smile:
apple: https://a.slack-edge.com/80588/img/emoji_2017_12_06/apple/simple_smile.png
google: https://a.slack-edge.com/80588/img/emoji_2017_12_06/google/simple_smile.png
slack: https://emoji.slack-edge.com/T9TK3CUKW/slack/7d462d2443.png
slack_call: https://emoji.slack-edge.com/T9TK3CUKW/slack_call/b81fffd6dd.png
squirrel: https://emoji.slack-edge.com/T9TK3CUKW/squirrel/465f40c0e0.png
thumbsup_all: https://emoji.slack-edge.com/T9TK3CUKW/thumbsup_all/50096a1020.gif
white_square: alias:white_large_square
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:read
tags:
- admin.emoji
- admin
summary: List all emojis
x-uuid: 9868d68e-49e8-437a-8b97-eab44b639460
/admin.emoji.remove:
post:
description: Remove an emoji from use across an Enterprise Grid organization. This action deletes the emoji, making it unavailable for future use.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.emoji.remove
operationId: slack_web_api_admin_emoji_remove
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
name:
description: The name of the emoji to be removed. Colons (`:myemoji:`) around the value are not required, although they may be included.
type: string
token:
description: 'Authentication token. Requires scope: `admin.teams:write`'
type: string
required:
- token
- name
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:write
tags:
- admin.emoji
- admin
summary: Remove an emoji
x-uuid: 9c46890f-4876-451d-b329-b967bdb2beaf
/admin.emoji.rename:
post:
description: Rename an existing emoji. This allows administrators to update the name of an emoji to better reflect its use or meaning.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.emoji.rename
operationId: slack_web_api_admin_emoji_rename
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
name:
description: The name of the emoji to be renamed. Colons (`:myemoji:`) around the value are not required, although they may be included.
type: string
new_name:
description: The new name of the emoji.
type: string
token:
description: 'Authentication token. Requires scope: `admin.teams:write`'
type: string
required:
- token
- name
- new_name
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:write
tags:
- admin.emoji
- admin
summary: Rename an emoji
x-uuid: 97c9bf07-0910-4f23-a61d-10e0a38a7829
/admin.inviteRequests.approve:
post:
description: Approve a pending request for a user to join a Slack workspace. This action allows the user to become a member of the workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.inviteRequests.approve
operationId: slack_web_api_admin_invite_requests_approve
parameters:
- description: 'Authentication token. Requires scope: `admin.invites:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
invite_request_id:
description: ID of the request to invite.
type: string
team_id:
description: ID for the workspace where the invite request was made.
type: string
required:
- invite_request_id
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.invites:write
tags:
- admin.inviteRequests
- admin
summary: Approve invite request
x-uuid: 47ab7560-7b1d-48e7-b05d-481830bf7f62
/admin.inviteRequests.approved.list:
get:
description: Retrieve a list of all workspace invite requests that have been approved. This helps administrators track who has been granted access to the workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.inviteRequests.approved.list
operationId: slack_web_api_admin_invite_requests_approved_list
parameters:
- description: 'Authentication token. Requires scope: `admin.invites:read`'
in: header
name: token
required: true
schema:
type: string
- description: ID for the workspace where the invite requests were made.
in: query
name: team_id
schema:
type: string
- description: Value of the `next_cursor` field sent as part of the previous API response
in: query
name: cursor
schema:
type: string
- description: The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive
in: query
name: limit
schema:
type: integer
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.invites:read
tags:
- admin.inviteRequests.approved
- admin
summary: List approved invite requests
x-uuid: 8afa24bb-7c1f-41f6-9125-c80498fa73b6
/admin.inviteRequests.denied.list:
get:
description: Retrieve a list of all workspace invite requests that have been denied. This helps administrators review decisions on workspace access.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.inviteRequests.denied.list
operationId: slack_web_api_admin_invite_requests_denied_list
parameters:
- description: 'Authentication token. Requires scope: `admin.invites:read`'
in: header
name: token
required: true
schema:
type: string
- description: ID for the workspace where the invite requests were made.
in: query
name: team_id
schema:
type: string
- description: Value of the `next_cursor` field sent as part of the previous api response
in: query
name: cursor
schema:
type: string
- description: The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive
in: query
name: limit
schema:
type: integer
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.invites:read
tags:
- admin.inviteRequests.denied
- admin
summary: List denied invite requests
x-uuid: 67593af7-9c0f-4de9-b170-0413cb51c547
/admin.inviteRequests.deny:
post:
description: This endpoint allows administrators to deny a pending request for joining a Slack workspace. It is used to manage and control who can join the workspace by rejecting specific invite requests.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.inviteRequests.deny
operationId: slack_web_api_admin_invite_requests_deny
parameters:
- description: 'Authentication token. Requires scope: `admin.invites:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
invite_request_id:
description: ID of the request to invite.
type: string
team_id:
description: ID for the workspace where the invite request was made.
type: string
required:
- invite_request_id
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.invites:write
tags:
- admin.inviteRequests
- admin
summary: Deny a workspace invite request
x-uuid: b5edc6c1-41e7-491d-a1cd-7fdb283af1d0
/admin.inviteRequests.list:
get:
description: Retrieve a list of all pending requests to join a Slack workspace. This endpoint helps administrators view and manage incoming requests from users who wish to become part of the workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.inviteRequests.list
operationId: slack_web_api_admin_invite_requests_list
parameters:
- description: 'Authentication token. Requires scope: `admin.invites:read`'
in: header
name: token
required: true
schema:
type: string
- description: ID for the workspace where the invite requests were made.
in: query
name: team_id
schema:
type: string
- description: Value of the `next_cursor` field sent as part of the previous API response
in: query
name: cursor
schema:
type: string
- description: The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive
in: query
name: limit
schema:
type: integer
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.invites:read
tags:
- admin.inviteRequests
- admin
summary: List pending invite requests
x-uuid: ad8fb2e9-957f-4810-842d-75a9c36e7009
/admin.teams.admins.list:
get:
description: Fetch a list of all administrators within a specific Slack workspace. This endpoint is useful for identifying users with administrative privileges and managing admin roles.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.teams.admins.list
operationId: slack_web_api_admin_teams_admins_list
parameters:
- description: 'Authentication token. Requires scope: `admin.teams:read`'
in: query
name: token
required: true
schema:
type: string
- description: The maximum number of items to return.
in: query
name: limit
schema:
type: integer
- description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
in: query
name: cursor
schema:
type: string
- in: query
name: team_id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
admin_ids:
- U1234
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:read
tags:
- admin.teams.admins
- admin
summary: List workspace admins
x-uuid: a178015c-8023-4b03-a210-b24bf542303f
/admin.teams.create:
post:
description: Create a new team within an Enterprise Grid organization on Slack. This endpoint is used to establish new workspaces under the umbrella of an enterprise organization, allowing for better management and organization of teams.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.teams.create
operationId: slack_web_api_admin_teams_create
parameters:
- description: 'Authentication token. Requires scope: `admin.teams:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
team_description:
description: Description for the team.
type: string
team_discoverability:
description: Who can join the team. A team's discoverability can be `open`, `closed`, `invite_only`, or `unlisted`.
type: string
team_domain:
description: Team domain (for example, slacksoftballteam).
type: string
team_name:
description: Team name (for example, Slack Softball Team).
type: string
required:
- team_domain
- team_name
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
team: T12345
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:write
tags:
- admin.teams
- admin
summary: Create a new Enterprise team
x-uuid: 3aa1f92e-4fa6-449a-ba10-47dceb1df8ec
/admin.teams.list:
get:
description: Retrieve a list of all teams within an Enterprise Grid organization. This endpoint helps in managing and overseeing multiple workspaces that are part of a larger enterprise structure.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.teams.list
operationId: slack_web_api_admin_teams_list
parameters:
- description: 'Authentication token. Requires scope: `admin.teams:read`'
in: header
name: token
required: true
schema:
type: string
- description: The maximum number of items to return. Must be between 1 - 100 both inclusive.
in: query
name: limit
schema:
type: integer
- description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
in: query
name: cursor
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
teams:
- discoverability: hidden
id: T1234
name: My Team
primary_owner:
email: bront@slack.com
user_id: W1234
team_url: https://subarachnoid.slack.com/
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:read
tags:
- admin.teams
- admin
summary: List all Enterprise teams
x-uuid: 3c3370fc-9a09-4f9c-bfbb-b02d51e0c010
/admin.teams.owners.list:
get:
description: Fetch a list of all owners within a specific Slack workspace. Workspace owners have the highest level of control and permissions, and this endpoint helps identify them.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.teams.owners.list
operationId: slack_web_api_admin_teams_owners_list
parameters:
- description: 'Authentication token. Requires scope: `admin.teams:read`'
in: query
name: token
required: true
schema:
type: string
- in: query
name: team_id
required: true
schema:
type: string
- description: The maximum number of items to return. Must be between 1 - 1000 both inclusive.
in: query
name: limit
schema:
type: integer
- description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
in: query
name: cursor
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
owner_ids:
- U1234
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:read
tags:
- admin.teams.owners
- admin
summary: List workspace owners
x-uuid: 76aa4296-e834-48ca-a0d5-f3bbbadd86af
/admin.teams.settings.info:
get:
description: Retrieve detailed information about the settings of a specific Slack workspace. This includes various configuration options and preferences set for the workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.teams.settings.info
operationId: slack_web_api_admin_teams_settings_info
parameters:
- description: 'Authentication token. Requires scope: `admin.teams:read`'
in: header
name: token
required: true
schema:
type: string
- in: query
name: team_id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
team:
default_channels: array
domain: string
email_domain: string
enterprise_id: string
enterprise_name: string
icon: array
id: string
name: string
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:read
tags:
- admin.teams.settings
- admin
summary: Get workspace settings info
x-uuid: 8ca8f1ec-7358-4e99-a0a7-3dbc8e57a8ec
/admin.teams.settings.setDefaultChannels:
post:
description: Set the default channels that new members will automatically join when they become part of a Slack workspace. This helps streamline onboarding by ensuring all members have access to essential channels.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.teams.settings.setDefaultChannels
operationId: slack_web_api_admin_teams_settings_set_default_channels
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_ids:
description: An array of channel IDs.
type: string
team_id:
description: ID for the workspace to set the default channel for.
type: string
token:
description: 'Authentication token. Requires scope: `admin.teams:write`'
type: string
required:
- token
- team_id
- channel_ids
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:write
tags:
- admin.teams.settings
- admin
summary: Set default workspace channels
x-uuid: a59cf694-b587-44ef-8d8e-0bb0ed3ab4d4
/admin.teams.settings.setDescription:
post:
description: Update the description of a specific Slack workspace. This description provides context and information about the workspace's purpose and can be viewed by its members.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.teams.settings.setDescription
operationId: slack_web_api_admin_teams_settings_set_description
parameters:
- description: 'Authentication token. Requires scope: `admin.teams:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
description:
description: The new description for the workspace.
type: string
team_id:
description: ID for the workspace to set the description for.
type: string
required:
- team_id
- description
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:write
tags:
- admin.teams.settings
- admin
summary: Set workspace description
x-uuid: c538ce06-0eb5-4666-b188-71c21da521d8
/admin.teams.settings.setDiscoverability:
post:
description: Configure the discoverability settings of a Slack workspace, determining how easily it can be found by others. This setting affects whether the workspace is visible in search results and who can join.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.teams.settings.setDiscoverability
operationId: slack_web_api_admin_teams_settings_set_discoverability
parameters:
- description: 'Authentication token. Requires scope: `admin.teams:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
discoverability:
description: This workspace's discovery setting. It must be set to one of `open`, `invite_only`, `closed`, or `unlisted`.
type: string
team_id:
description: The ID of the workspace to set discoverability on.
type: string
required:
- team_id
- discoverability
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:write
tags:
- admin.teams.settings
- admin
summary: Set workspace discoverability
x-uuid: ac9306a5-fd74-4d05-87e2-7cc59bc04ef9
/admin.teams.settings.setIcon:
post:
description: Update the icon of a Slack workspace. The workspace icon is a visual identifier that appears in various parts of the Slack interface, helping users quickly recognize the workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.teams.settings.setIcon
operationId: slack_web_api_admin_teams_settings_set_icon
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
image_url:
description: Image URL for the icon
type: string
team_id:
description: ID for the workspace to set the icon for.
type: string
token:
description: 'Authentication token. Requires scope: `admin.teams:write`'
type: string
required:
- token
- image_url
- team_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:write
tags:
- admin.teams.settings
- admin
summary: Set workspace icon
x-uuid: 7d8fa47f-16d4-4aa3-b087-f16726040b47
/admin.teams.settings.setName:
post:
description: Change the name of a specific Slack workspace. The workspace name is a key identifier and is displayed prominently to all members.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.teams.settings.setName
operationId: slack_web_api_admin_teams_settings_set_name
parameters:
- description: 'Authentication token. Requires scope: `admin.teams:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
name:
description: The new name of the workspace.
type: string
team_id:
description: ID for the workspace to set the name for.
type: string
required:
- team_id
- name
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:write
tags:
- admin.teams.settings
- admin
summary: Set workspace name
x-uuid: 8d17e673-1ff8-4fc5-80ec-583a800453f0
/admin.usergroups.addChannels:
post:
description: Add one or more default channels to an Identity Provider (IDP) group within an organization. This helps ensure that members of the group have access to essential communication channels.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.usergroups.addChannels
operationId: slack_web_api_admin_usergroups_add_channels
parameters:
- description: 'Authentication token. Requires scope: `admin.usergroups:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_ids:
description: Comma separated string of channel IDs.
type: string
team_id:
description: The workspace to add default channels in.
type: string
usergroup_id:
description: ID of the IDP group to add default channels for.
type: string
required:
- usergroup_id
- channel_ids
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: not_an_admin
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response if the token provided is not associated with an Org Admin or Owner
security:
- slackAuth:
- admin.usergroups:write
tags:
- admin.usergroups
- admin
summary: Add channels to IDP group
x-uuid: e98cc7e6-8805-4946-af9e-57c85e300bd2
/admin.usergroups.addTeams:
post:
description: Associate one or more default workspaces with an organization-wide Identity Provider (IDP) group. This facilitates centralized management of group access across multiple workspaces.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.usergroups.addTeams
operationId: slack_web_api_admin_usergroups_add_teams
parameters:
- description: 'Authentication token. Requires scope: `admin.teams:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
auto_provision:
description: When `true`, this method automatically creates new workspace accounts for the IDP group members.
type: boolean
team_ids:
description: A comma separated list of encoded team (workspace) IDs. Each workspace *MUST* belong to the organization associated with the token.
type: string
usergroup_id:
description: An encoded usergroup (IDP Group) ID.
type: string
required:
- usergroup_id
- team_ids
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.teams:write
tags:
- admin.usergroups
- admin
summary: Add workspaces to IDP group
x-uuid: b710819c-50b6-463f-97da-ec27f1e3464b
/admin.usergroups.listChannels:
get:
description: Retrieve a list of channels associated with an organization-level Identity Provider (IDP) group. This endpoint helps in managing and auditing channel access for the group.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.usergroups.listChannels
operationId: slack_web_api_admin_usergroups_list_channels
parameters:
- description: 'Authentication token. Requires scope: `admin.usergroups:read`'
in: header
name: token
required: true
schema:
type: string
- description: ID of the IDP group to list default channels for.
in: query
name: usergroup_id
required: true
schema:
type: string
- description: ID of the the workspace.
in: query
name: team_id
schema:
type: string
- description: Flag to include or exclude the count of members per channel.
in: query
name: include_num_members
schema:
type: boolean
responses:
'200':
content:
application/json:
examples:
response:
value:
channels:
- id: C024BE91L
name: fun
num_members: 34
team_id: T024BE911
- id: C024BE91K
name: more fun
team_id: T024BE912
- id: C024BE91M
is_redacted: true
name: public-channel
num_members: 34
team_id: T024BE911
- id: C024BE91N
name: some more fun
team_id: T024BE921
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: not_an_admin
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response if the token provided is not associated with an Org Admin or Owner
security:
- slackAuth:
- admin.usergroups:read
tags:
- admin.usergroups
- admin
summary: List IDP group channels
x-uuid: 6ad0c86f-06ab-44dc-b619-55a98d029cec
/admin.usergroups.removeChannels:
post:
description: Remove one or more default channels from an organization-level Identity Provider (IDP) group. This is used to adjust channel access for the group members.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.usergroups.removeChannels
operationId: slack_web_api_admin_usergroups_remove_channels
parameters:
- description: 'Authentication token. Requires scope: `admin.usergroups:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_ids:
description: Comma-separated string of channel IDs
type: string
usergroup_id:
description: ID of the IDP Group
type: string
required:
- usergroup_id
- channel_ids
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: not_an_admin
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response if the token provided is not associated with an Org Admin or Owner
security:
- slackAuth:
- admin.usergroups:write
tags:
- admin.usergroups
- admin
summary: Remove channels from IDP group
x-uuid: fdd693aa-8c03-43a8-93bd-1ab2d5c5eca9
/admin.users.assign:
post:
description: Assign an Enterprise user to a specific Slack workspace. This endpoint is used to manage user membership across different workspaces within an enterprise.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.users.assign
operationId: slack_web_api_admin_users_assign
parameters:
- description: 'Authentication token. Requires scope: `admin.users:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_ids:
description: Comma separated values of channel IDs to add user in the new workspace.
type: string
is_restricted:
description: True if user should be added to the workspace as a guest.
type: boolean
is_ultra_restricted:
description: True if user should be added to the workspace as a single-channel guest.
type: boolean
team_id:
description: The ID (`T1234`) of the workspace.
type: string
user_id:
description: The ID of the user to add to the workspace.
type: string
required:
- team_id
- user_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.users:write
tags:
- admin.users
- admin
summary: Assign user to workspace
x-uuid: e308f6ce-22ab-40ce-8a72-9f6e4ff9e073
/admin.users.invite:
post:
description: Send an invitation to a user to join a Slack workspace. This endpoint facilitates the onboarding process by allowing administrators to invite new members.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.users.invite
operationId: slack_web_api_admin_users_invite
parameters:
- description: 'Authentication token. Requires scope: `admin.users:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel_ids:
description: A comma-separated list of `channel_id`s for this user to join. At least one channel is required.
type: string
custom_message:
description: An optional message to send to the user in the invite email.
type: string
email:
description: The email address of the person to invite.
type: string
guest_expiration_ts:
description: Timestamp when guest account should be disabled. Only include this timestamp if you are inviting a guest user and you want their account to expire on a certain date.
type: string
is_restricted:
description: 'Is this user a multi-channel guest user? (default: false)'
type: boolean
is_ultra_restricted:
description: 'Is this user a single channel guest user? (default: false)'
type: boolean
real_name:
description: Full name of the user.
type: string
resend:
description: 'Allow this invite to be resent in the future if a user has not signed up yet. (default: false)'
type: boolean
team_id:
description: The ID (`T1234`) of the workspace.
type: string
required:
- team_id
- email
- channel_ids
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.users:write
tags:
- admin.users
- admin
summary: Invite user to workspace
x-uuid: d6538e33-6c1f-41db-87be-17f33399c108
/admin.users.list:
get:
description: Retrieve a list of all users within a specific Slack workspace. This endpoint is useful for managing user accounts and roles within the workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.users.list
operationId: slack_web_api_admin_users_list
parameters:
- description: 'Authentication token. Requires scope: `admin.users:read`'
in: header
name: token
required: true
schema:
type: string
- description: The ID (`T1234`) of the workspace.
in: query
name: team_id
required: true
schema:
type: string
- description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page.
in: query
name: cursor
schema:
type: string
- description: Limit for how many users to be retrieved per page
in: query
name: limit
schema:
type: integer
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
users:
- email: bront@slack.com
id: T1234
is_admin: false
is_bot: false
is_owner: false
is_primary_owner: false
is_restricted: false
is_ultra_restricted: false
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.users:read
tags:
- admin.users
- admin
summary: List workspace users
x-uuid: d704e492-b26a-458d-816c-ddb3f716a2e4
/admin.users.remove:
post:
description: Remove a user from a specific Slack workspace. This endpoint is used to manage user membership and ensure that only authorized users have access to the workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.users.remove
operationId: slack_web_api_admin_users_remove
parameters:
- description: 'Authentication token. Requires scope: `admin.users:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
team_id:
description: The ID (`T1234`) of the workspace.
type: string
user_id:
description: The ID of the user to remove.
type: string
required:
- team_id
- user_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.users:write
tags:
- admin.users
- admin
summary: Remove user from workspace
x-uuid: e8b18bd8-7aa2-46ea-af6f-80cd4103bc37
/admin.users.session.invalidate:
post:
description: Invalidate a specific session for a user by using the session ID. This endpoint is useful for managing user sessions and ensuring security by terminating unauthorized or inactive sessions.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.users.session.invalidate
operationId: slack_web_api_admin_users_session_invalidate
parameters:
- description: 'Authentication token. Requires scope: `admin.users:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
session_id:
type: integer
team_id:
description: ID of the team that the session belongs to
type: string
required:
- team_id
- session_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.users:write
tags:
- admin.users.session
- admin
summary: Invalidate user session
x-uuid: c1d3bd32-0bd8-4430-91ca-31403782e4ac
/admin.users.session.reset:
post:
description: Reset all active sessions for a given user across all devices. This endpoint is used to enhance security by logging the user out from all devices, requiring them to log in again.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.users.session.reset
operationId: slack_web_api_admin_users_session_reset
parameters:
- description: 'Authentication token. Requires scope: `admin.users:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
mobile_only:
description: 'Only expire mobile sessions (default: false)'
type: boolean
user_id:
description: The ID of the user to wipe sessions for
type: string
web_only:
description: 'Only expire web sessions (default: false)'
type: boolean
required:
- user_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.users:write
tags:
- admin.users.session
- admin
summary: Reset all user sessions
x-uuid: d28fd650-1745-4115-ad43-48b5590fe6e5
/admin.users.setAdmin:
post:
description: Promote an existing guest, regular user, or owner to an admin role within a Slack workspace. Admins have elevated permissions to manage the workspace and its members.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.users.setAdmin
operationId: slack_web_api_admin_users_set_admin
parameters:
- description: 'Authentication token. Requires scope: `admin.users:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
team_id:
description: The ID (`T1234`) of the workspace.
type: string
user_id:
description: The ID of the user to designate as an admin.
type: string
required:
- team_id
- user_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.users:write
tags:
- admin.users
- admin
summary: Promote user to admin
x-uuid: 7d7cf8ee-c1e0-4ee0-b18a-49bec22d2142
/admin.users.setExpiration:
post:
description: Set an expiration date for a guest user in a Slack workspace. This endpoint helps manage temporary access by automatically removing the user after the specified date.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.users.setExpiration
operationId: slack_web_api_admin_users_set_expiration
parameters:
- description: 'Authentication token. Requires scope: `admin.users:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
expiration_ts:
description: Timestamp when guest account should be disabled.
type: integer
team_id:
description: The ID (`T1234`) of the workspace.
type: string
user_id:
description: The ID of the user to set an expiration for.
type: string
required:
- team_id
- user_id
- expiration_ts
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.users:write
tags:
- admin.users
- admin
summary: Set guest user expiration
x-uuid: f6514f00-cda1-4a27-beef-e4426d18a527
/admin.users.setOwner:
post:
description: Promote an existing guest, regular user, or admin to a workspace owner. Owners have the highest level of control and permissions within a Slack workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.users.setOwner
operationId: slack_web_api_admin_users_set_owner
parameters:
- description: 'Authentication token. Requires scope: `admin.users:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
team_id:
description: The ID (`T1234`) of the workspace.
type: string
user_id:
description: Id of the user to promote to owner.
type: string
required:
- team_id
- user_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.users:write
tags:
- admin.users
- admin
summary: Promote user to owner
x-uuid: a6e69430-0f87-46f8-b673-597f9816d584
/admin.users.setRegular:
post:
description: Demote an existing guest user, admin, or owner to a regular user within a Slack workspace. Regular users have standard permissions and access within the workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/admin.users.setRegular
operationId: slack_web_api_admin_users_set_regular
parameters:
- description: 'Authentication token. Requires scope: `admin.users:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
team_id:
description: The ID (`T1234`) of the workspace.
type: string
user_id:
description: The ID of the user to designate as a regular user.
type: string
required:
- team_id
- user_id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- admin.users:write
tags:
- admin.users
- admin
summary: Demote user to regular
x-uuid: 1f311687-72e4-4b55-b258-574388984807
/api.test:
get:
description: Test the API calling code to ensure it is functioning correctly. This endpoint is useful for developers to verify that their API requests are being processed as expected.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/api.test
operationId: slack_web_api_api_test
parameters:
- description: Error response to return
in: query
name: error
schema:
type: string
- description: example property to return
in: query
name: foo
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties:
type: object
description: Schema for successful response api.test method
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: api.test success schema
type: object
description: Standard success response
default:
content:
application/json:
examples:
response:
value:
args:
error: my_error
error: my_error
ok: false
schema:
additionalProperties:
type: object
description: Schema for error response api.test method
properties:
error:
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: api.test error schema
type: object
description: Artificial error response
security:
- slackAuth:
- none
tags:
- api
summary: Test API calling code
x-uuid: f8f14d03-81ab-4ba0-8ac1-dce1ca2939f1
/apps.event.authorizations.list:
get:
description: Retrieve a list of app authorizations for a specific event context. Each authorization indicates an app installation that can access the event, helping manage app visibility and permissions.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/apps.event.authorizations.list
operationId: slack_web_api_apps_event_authorizations_list
parameters:
- description: 'Authentication token. Requires scope: `authorizations:read`'
in: header
name: token
required: true
schema:
type: string
- in: query
name: event_context
required: true
schema:
type: string
- in: query
name: cursor
schema:
type: string
- in: query
name: limit
schema:
type: integer
responses:
'200':
content:
application/json:
examples:
response:
value:
authorizations:
enterprise_id: string
is_bot: string
team_id: string
user_id: string
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- authorizations:read
tags:
- apps.event.authorizations
- apps
summary: List event authorizations
x-uuid: 8658bdba-da20-4b4b-98a1-77ca88d15830
/apps.permissions.info:
get:
description: Retrieve a list of permissions that a specific app has within a Slack team. This endpoint helps in understanding the scope of app capabilities and managing app permissions.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/apps.permissions.info
operationId: slack_web_api_apps_permissions_info
parameters:
- description: 'Authentication token. Requires scope: `none`'
in: query
name: token
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
info:
app_home:
resources:
ids:
- D0C0NU1Q8
- D0BH95DLH
scopes:
- chat:write
- im:history
- im:read
channel:
resources:
excluded_ids: []
ids:
- C061FA5PB
wildcard: false
scopes:
- channels:read
group:
resources:
ids: []
scopes: []
im:
resources:
ids: []
scopes: []
mpim:
resources:
ids: []
scopes: []
team:
resources:
ids: []
scopes: []
ok: true
schema:
additionalProperties: false
description: Schema for successful response from apps.permissions.info method
properties:
info:
properties:
app_home:
properties:
resources:
additionalProperties: false
properties:
excluded_ids:
items:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
type: array
ids:
items:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
type: array
wildcard:
type: boolean
required:
- ids
title: resources in info from apps.permissions.info
type: object
scopes:
items:
title: Named OAuth scopes
type: string
x-examples:
- chat:write
- im:history
- im:read
type: array
type: object
channel:
properties:
resources:
additionalProperties: false
properties:
excluded_ids:
items:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
type: array
ids:
items:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
type: array
wildcard:
type: boolean
required:
- ids
title: resources in info from apps.permissions.info
type: object
scopes:
items:
title: Named OAuth scopes
type: string
x-examples:
- chat:write
- im:history
- im:read
type: array
type: object
group:
properties:
resources:
additionalProperties: false
properties:
excluded_ids:
items:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
type: array
ids:
items:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
type: array
wildcard:
type: boolean
required:
- ids
title: resources in info from apps.permissions.info
type: object
scopes:
items:
title: Named OAuth scopes
type: string
x-examples:
- chat:write
- im:history
- im:read
type: array
type: object
im:
properties:
resources:
additionalProperties: false
properties:
excluded_ids:
items:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
type: array
ids:
items:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
type: array
wildcard:
type: boolean
required:
- ids
title: resources in info from apps.permissions.info
type: object
scopes:
items:
title: Named OAuth scopes
type: string
x-examples:
- chat:write
- im:history
- im:read
type: array
type: object
mpim:
properties:
resources:
additionalProperties: false
properties:
excluded_ids:
items:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
type: array
ids:
items:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
type: array
wildcard:
type: boolean
required:
- ids
title: resources in info from apps.permissions.info
type: object
scopes:
items:
title: Named OAuth scopes
type: string
x-examples:
- chat:write
- im:history
- im:read
type: array
type: object
team:
properties:
resources:
additionalProperties: false
properties:
excluded_ids:
items:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
type: array
ids:
items:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
type: array
wildcard:
type: boolean
required:
- ids
title: resources in info from apps.permissions.info
type: object
scopes:
items:
title: Named OAuth scopes
type: string
x-examples:
- chat:write
- im:history
- im:read
type: array
required:
- scopes
- resources
type: object
required:
- team
- channel
- group
- mpim
- im
- app_home
type: object
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
- info
title: apps.permissions.info schema
type: object
description: Standard success response when used with a user token
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from apps.permissions.info method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- org_login_required
- user_is_bot
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: apps.permissions.info error schema
type: object
description: Standard failure response when used with an invalid token
security:
- slackAuth:
- none
tags:
- apps.permissions
- apps
summary: Get app permissions info
x-uuid: 8e9b3729-4c4d-4ae6-8306-2614f7d479e6
/apps.permissions.request:
get:
description: Allow an app to request additional permissions or scopes within a Slack team. This endpoint is used to expand the app's capabilities by obtaining necessary permissions.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/apps.permissions.request
operationId: slack_web_api_apps_permissions_request
parameters:
- description: 'Authentication token. Requires scope: `none`'
in: query
name: token
required: true
schema:
type: string
- description: A comma separated list of scopes to request for
in: query
name: scopes
required: true
schema:
type: string
- description: Token used to trigger the permissions API
in: query
name: trigger_id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response from apps.permissions.request method
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: apps.permissions.request schema
type: object
description: Standard success response when used with a user token
default:
content:
application/json:
examples:
response:
value:
error: invalid_trigger_id
ok: false
schema:
additionalProperties: false
description: Schema for error response from apps.permissions.request method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- invalid_trigger
- trigger_exchanged
- invalid_scope
- invalid_user
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- org_login_required
- user_is_bot
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: apps.permissions.request error schema
type: object
description: Standard failure response when trigger_id is invalid
security:
- slackAuth:
- none
tags:
- apps.permissions
- apps
summary: Request additional app scopes
x-uuid: 0086e09d-b934-47a4-9cde-ab07be638a39
/apps.permissions.resources.list:
get:
description: Retrieve a list of resource permissions granted to this app within a Slack team. This endpoint helps you understand what resources your app can access, such as channels or files, based on the permissions granted by the team.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/apps.permissions.resources.list
operationId: slack_web_api_apps_permissions_resources_list
parameters:
- description: 'Authentication token. Requires scope: `none`'
in: query
name: token
required: true
schema:
type: string
- description: Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
in: query
name: cursor
schema:
type: string
- description: The maximum number of items to return.
in: query
name: limit
schema:
type: integer
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
resources:
- id: T0DES3UAN
type: team
- id: D024BFF1M
type: app_home
- id: C024BE91L
type: channel
response_metadata:
next_cursor: dGVhbTpDMUg5UkVTR0w=
schema:
additionalProperties: true
description: Schema for successful response apps.permissions.resources.list method
properties:
ok:
enum:
- true
title: default success response
type: boolean
resources:
items:
properties:
id:
title: An ID for a resource
type: string
x-examples:
- T0DES3UAN
- C0ABC1ABC
type:
title: The type of resource the `id` corresponds to
type: string
x-examples:
- team
- channel
- mpim
type: object
type: array
response_metadata:
additionalProperties: false
properties:
next_cursor:
type: string
x-examples:
- dGVhbTpDMUg5UkVTR0w=
required:
- next_cursor
type: object
required:
- ok
- resources
title: apps.permissions.resources.list success schema
type: object
description: Typical successful paginated response
default:
content:
application/json:
examples:
response:
value:
error: invalid_cursor
ok: false
schema:
additionalProperties: false
description: Schema for error response from apps.permissions.resources.list method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- invalid_cursor
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- org_login_required
- user_is_bot
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: apps.permissions.resources.list error schema
type: object
description: Typical error response
security:
- slackAuth:
- none
tags:
- apps.permissions.resources
- apps
summary: List app resource permissions
x-uuid: 0a88214d-c35a-4a74-8ef3-3e422357d2f4
/apps.permissions.scopes.list:
get:
description: Retrieve a list of permission scopes that this app has been granted within a Slack team. Scopes define the level of access the app has, such as reading messages or managing channels.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/apps.permissions.scopes.list
operationId: slack_web_api_apps_permissions_scopes_list
parameters:
- description: 'Authentication token. Requires scope: `none`'
in: query
name: token
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
scopes:
app_home:
- chat:write
- im:history
- im:read
channel:
- channels:history
- chat:write
group:
- chat:write
im:
- chat:write
mpim:
- chat:write
team:
- users:read
user: []
schema:
additionalProperties: true
description: Schema for successful response api.permissions.scopes.list method
properties:
ok:
enum:
- true
title: default success response
type: boolean
scopes:
additionalProperties: true
properties:
app_home:
items:
title: Named OAuth scopes
type: string
x-examples:
- chat:write
- im:history
- im:read
type: array
channel:
items:
title: Named OAuth scopes
type: string
x-examples:
- chat:write
- im:history
- im:read
type: array
group:
items:
title: Named OAuth scopes
type: string
x-examples:
- chat:write
- im:history
- im:read
type: array
im:
items:
title: Named OAuth scopes
type: string
x-examples:
- chat:write
- im:history
- im:read
type: array
mpim:
items:
title: Named OAuth scopes
type: string
x-examples:
- chat:write
- im:history
- im:read
type: array
team:
items:
title: Named OAuth scopes
type: string
x-examples:
- chat:write
- im:history
- im:read
type: array
user:
items:
title: Named OAuth scopes
type: string
x-examples:
- chat:write
- im:history
- im:read
type: array
type: object
required:
- ok
- scopes
title: api.permissions.scopes.list success schema
type: object
description: Typical successful paginated response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from apps.permissions.scopes.list method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- org_login_required
- user_is_bot
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: apps.permissions.scopes.list error schema
type: object
description: Typical error response
security:
- slackAuth:
- none
tags:
- apps.permissions.scopes
- apps
summary: List app permission scopes
x-uuid: d4edc09d-dfe5-4671-a7e6-1f01645df57c
/apps.permissions.users.list:
get:
description: Retrieve a list of user-specific permissions and scopes granted to this app within a Slack team. This endpoint provides details on what user data the app can access based on individual user permissions.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/apps.permissions.users.list
operationId: slack_web_api_apps_permissions_users_list
parameters:
- description: 'Authentication token. Requires scope: `none`'
in: query
name: token
required: true
schema:
type: string
- description: Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
in: query
name: cursor
schema:
type: string
- description: The maximum number of items to return.
in: query
name: limit
schema:
type: integer
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
resources:
- id: U0DES3UAN
scopes:
- dnd:write:user
- reminders:write:user
- id: U024BFF1M
scopes:
- reminders:write:user
response_metadata:
next_cursor: dGVhbTdPMUg5UkFTT0w=
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical successful paginated response
default:
content:
application/json:
examples:
response:
value:
error: invalid_cursor
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- none
tags:
- apps.permissions.users
- apps
summary: List user-specific app permissions
x-uuid: 510a09c9-28ac-42eb-b5bc-39bcdd61a9f4
/apps.permissions.users.request:
get:
description: Trigger a permissions modal to request additional user access scopes for your app. This allows users to grant or deny specific permissions directly through an interactive Slack interface.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/apps.permissions.users.request
operationId: slack_web_api_apps_permissions_users_request
parameters:
- description: 'Authentication token. Requires scope: `none`'
in: query
name: token
required: true
schema:
type: string
- description: A comma separated list of user scopes to request for
in: query
name: scopes
required: true
schema:
type: string
- description: Token used to trigger the request
in: query
name: trigger_id
required: true
schema:
type: string
- description: The user this scope is being requested for
in: query
name: user
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Standard success response when used with a user token
default:
content:
application/json:
examples:
response:
value:
error: invalid_trigger_id
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Standard failure response when trigger_id is invalid
security:
- slackAuth:
- none
tags:
- apps.permissions.users
- apps
summary: Request user permissions
x-uuid: a9dbd01c-5b3b-40be-8b4c-0b95c03e2b9d
/apps.uninstall:
get:
description: Remove your app from a Slack workspace. This endpoint is used when you want to completely uninstall your app, revoking all permissions and access within the workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/apps.uninstall
operationId: slack_web_api_apps_uninstall
parameters:
- description: 'Authentication token. Requires scope: `none`'
in: query
name: token
schema:
type: string
- description: Issued when you created your application.
in: query
name: client_id
schema:
type: string
- description: Issued when you created your application.
in: query
name: client_secret
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response from apps.uninstall method
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: apps.uninstall schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from apps.uninstall method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- invalid_client_id
- bad_client_secret
- client_id_token_mismatch
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- org_login_required
- user_is_bot
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: apps.uninstall error schema
type: object
description: Typical error response
security:
- slackAuth:
- none
tags:
- apps
summary: Uninstall app from workspace
x-uuid: 6a40f668-8860-4855-b535-5c3fbb22d10b
/auth.revoke:
get:
description: Revoke an OAuth token, effectively disconnecting the app from the Slack workspace. This is useful for security purposes or when you want to terminate the app's access.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/auth.revoke
operationId: slack_web_api_auth_revoke
parameters:
- description: 'Authentication token. Requires scope: `none`'
in: query
name: token
required: true
schema:
type: string
- description: Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked.
in: query
name: test
schema:
type: boolean
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
revoked: true
schema:
additionalProperties: false
description: Schema for successful response from auth.revoke method
properties:
ok:
enum:
- true
title: default success response
type: boolean
revoked:
type: boolean
required:
- ok
- revoked
title: auth.revoke schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from auth.revoke method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- org_login_required
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: auth.revoke error schema
type: object
description: Typical error response
security:
- slackAuth:
- none
tags:
- auth
summary: Revoke OAuth token
x-uuid: 7554134d-b3b0-47e1-9d17-fbb8ca979bb3
/auth.test:
get:
description: Verify the authentication and identity of the current user or bot token. This endpoint helps confirm that the token is valid and provides basic information about the authenticated entity.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/auth.test
operationId: slack_web_api_auth_test
parameters:
- description: 'Authentication token. Requires scope: `none`'
in: header
name: token
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
team: Subarachnoid Workspace
team_id: T12345678
url: https://subarachnoid.slack.com/
user: grace
user_id: W12345678
schema:
additionalProperties: false
description: Schema for successful response auth.test method
properties:
bot_id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
is_enterprise_install:
type: boolean
ok:
enum:
- true
title: default success response
type: boolean
team:
type: string
team_id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
url:
type: string
user:
type: string
user_id:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- ok
- url
- team
- user
- team_id
- user_id
title: auth.test success schema
type: object
description: Standard success response when used with a user token
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response auth.test method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- not_authed
- invalid_auth
- token_revoked
- account_inactive
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: auth.test error schema
type: object
description: Standard failure response when used with an invalid token
security:
- slackAuth:
- none
tags:
- auth
summary: Test authentication and identity
x-uuid: 6eac46a5-3f13-4fc6-96c4-401c6271f43b
/bots.info:
get:
description: Retrieve detailed information about a bot user in your Slack workspace. This includes the bot's user ID, name, and other relevant metadata.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/bots.info
operationId: slack_web_api_bots_info
parameters:
- description: 'Authentication token. Requires scope: `users:read`'
in: query
name: token
required: true
schema:
type: string
- description: Bot user to get info on
in: query
name: bot
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
bot:
app_id: A161CLERW
deleted: false
icons:
image_36: https://...
image_48: https://...
image_72: https://...
id: B061F7JD2
name: beforebot
updated: 1449272004
user_id: U012ABCDEF
ok: true
schema:
additionalProperties: false
description: Schema for successful response from bots.info method
properties:
bot:
additionalProperties: false
properties:
app_id:
pattern: ^A[A-Z0-9]{1,}$
title: App ID
type: string
deleted:
type: boolean
icons:
additionalProperties: false
properties:
image_36:
format: uri
type: string
image_48:
format: uri
type: string
image_72:
format: uri
type: string
required:
- image_36
- image_48
- image_72
type: object
id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
name:
type: string
updated:
type: integer
user_id:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- id
- deleted
- name
- updated
- app_id
- icons
type: object
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
- bot
title: bots.info schema
type: object
description: When successful, returns bot info by bot ID.
default:
content:
application/json:
examples:
response:
value:
error: bot_not_found
ok: false
schema:
additionalProperties: false
description: Schema for error response from bots.info method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- bot_not_found
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- org_login_required
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: bots.info error schema
type: object
description: When no bot can be found, it returns an error.
security:
- slackAuth:
- users:read
tags:
- bots
summary: Get bot user information
x-uuid: 56724622-4a06-471f-9852-e5c5f9305b99
/calls.add:
post:
description: Register a new call within Slack, allowing you to initiate a voice or video call. This endpoint is used to create a call entry that can be managed and tracked within the workspace.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/calls.add
operationId: slack_web_api_calls_add
parameters:
- description: 'Authentication token. Requires scope: `calls:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
created_by:
description: The valid Slack user ID of the user who created this Call. When this method is called with a user token, the `created_by` field is optional and defaults to the authed user of the token. Otherwise, the field is required.
type: string
date_start:
description: Call start time in UTC UNIX timestamp format
type: integer
desktop_app_join_url:
description: When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
type: string
external_display_id:
description: An optional, human-readable ID supplied by the 3rd-party Call provider. If supplied, this ID will be displayed in the Call object.
type: string
external_unique_id:
description: An ID supplied by the 3rd-party Call provider. It must be unique across all Calls from that service.
type: string
join_url:
description: The URL required for a client to join the Call.
type: string
title:
description: The name of the Call.
type: string
users:
description: The list of users to register as participants in the Call. [Read more on how to specify users here](/apis/calls#users).
type: string
required:
- external_unique_id
- join_url
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- calls:write
tags:
- calls
summary: Register a new call
x-uuid: 561130a3-abf3-4b7a-96dc-262c9f33fe6a
/calls.end:
post:
description: Terminate an ongoing call in Slack. This endpoint is used to officially end a call session, updating its status and notifying participants.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/calls.end
operationId: slack_web_api_calls_end
parameters:
- description: 'Authentication token. Requires scope: `calls:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
duration:
description: Call duration in seconds
type: integer
id:
description: '`id` returned when registering the call using the [`calls.add`](/methods/calls.add) method.'
type: string
required:
- id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- calls:write
tags:
- calls
summary: End an ongoing call
x-uuid: 696d63f8-dcd4-41b7-b563-c87efa017f5c
/calls.info:
get:
description: Retrieve detailed information about a specific call in Slack. This includes the call's status, participants, and other metadata.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/calls.info
operationId: slack_web_api_calls_info
parameters:
- description: 'Authentication token. Requires scope: `calls:read`'
in: header
name: token
required: true
schema:
type: string
- description: '`id` of the Call returned by the [`calls.add`](/methods/calls.add) method.'
in: query
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- calls:read
tags:
- calls
summary: Get call information
x-uuid: 205ec1ab-f828-41d2-88cc-436677608461
/calls.participants.add:
post:
description: Add new participants to an existing call in Slack. This endpoint allows you to update the call's participant list by including additional users.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/calls.participants.add
operationId: slack_web_api_calls_participants_add
parameters:
- description: 'Authentication token. Requires scope: `calls:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
id:
description: '`id` returned by the [`calls.add`](/methods/calls.add) method.'
type: string
users:
description: The list of users to add as participants in the Call. [Read more on how to specify users here](/apis/calls#users).
type: string
required:
- id
- users
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- calls:write
tags:
- calls.participants
- calls
summary: Add participants to a call
x-uuid: 091679a4-554d-47c0-ace5-ef80b136f4fc
/calls.participants.remove:
post:
description: Remove participants from an ongoing call in Slack. This endpoint updates the call's participant list by excluding specified users.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/calls.participants.remove
operationId: slack_web_api_calls_participants_remove
parameters:
- description: 'Authentication token. Requires scope: `calls:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
id:
description: '`id` returned by the [`calls.add`](/methods/calls.add) method.'
type: string
users:
description: The list of users to remove as participants in the Call. [Read more on how to specify users here](/apis/calls#users).
type: string
required:
- id
- users
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- calls:write
tags:
- calls.participants
- calls
summary: Remove participants from a call
x-uuid: 9f8b5e14-0478-4e2b-bf36-b6673bb95bf7
/calls.update:
post:
description: Update the details of an existing call in Slack. This can include changes to the call's status, participants, or other relevant information.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/calls.update
operationId: slack_web_api_calls_update
parameters:
- description: 'Authentication token. Requires scope: `calls:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
desktop_app_join_url:
description: When supplied, available Slack clients will attempt to directly launch the 3rd-party Call with this URL.
type: string
id:
description: '`id` returned by the [`calls.add`](/methods/calls.add) method.'
type: string
join_url:
description: The URL required for a client to join the Call.
type: string
title:
description: The name of the Call.
type: string
required:
- id
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: true
description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: Default success template
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: true
description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
properties:
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
title: Default error template
type: object
description: Typical error response
security:
- slackAuth:
- calls:write
tags:
- calls
summary: Update call details
x-uuid: 3912525f-7bc2-4cc9-9efd-80af484dfc89
/chat.delete:
post:
description: Delete a specific message from a Slack channel. This endpoint allows you to remove messages that are no longer needed or were sent in error.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/chat.delete
operationId: slack_web_api_chat_delete
parameters:
- description: 'Authentication token. Requires scope: `chat:write`'
in: header
name: token
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
as_user:
description: Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](/bot-users) in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope.
type: boolean
channel:
description: Channel containing the message to be deleted.
type: string
ts:
description: Timestamp of the message to be deleted.
type: number
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
channel: C024BE91L
ok: true
ts: '1401383885.000061'
schema:
additionalProperties: false
description: Schema for successful response of chat.delete method
properties:
channel:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
ok:
enum:
- true
title: default success response
type: boolean
ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
required:
- ok
- channel
- ts
title: chat.delete success schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: message_not_found
ok: false
schema:
additionalProperties: false
description: Schema for error response from chat.delete method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- message_not_found
- channel_not_found
- cant_delete_message
- compliance_exports_prevent_deletion
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: chat.delete error schema
type: object
description: Typical error response
security:
- slackAuth:
- chat:write:user
- chat:write:bot
tags:
- chat
summary: Delete a message
x-uuid: a47a84b7-29fb-4b40-9f37-0dc396ce7d85
/chat.deleteScheduledMessage:
post:
description: Remove a scheduled message from the queue before it is sent. This endpoint is useful for managing and canceling messages that were planned for future delivery.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/chat.deleteScheduledMessage
operationId: slack_web_api_chat_delete_scheduled_message
parameters:
- description: 'Authentication token. Requires scope: `chat:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
as_user:
description: Pass true to delete the message as the authed user with `chat:write:user` scope. [Bot users](/bot-users) in this context are considered authed users. If unused or false, the message will be deleted with `chat:write:bot` scope.
type: boolean
channel:
description: The channel the scheduled_message is posting to
type: string
scheduled_message_id:
description: '`scheduled_message_id` returned from call to chat.scheduleMessage'
type: string
required:
- channel
- scheduled_message_id
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response from chat.deleteScheduledMessage method
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: chat.deleteScheduledMessage schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_scheduled_message_id
ok: false
schema:
additionalProperties: false
description: Schema for error response from chat.deleteScheduledMessage method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- invalid_scheduled_message_id
- channel_not_found
- bad_token
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- org_login_required
- ekm_access_denied
- missing_scope
- invalid_arguments
- invalid_arg_name
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: chat.deleteScheduledMessage error schema
type: object
description: Typical error response if no message is found
security:
- slackAuth:
- chat:write:user
- chat:write:bot
tags:
- chat
summary: Delete scheduled message
x-uuid: 44e4e59d-501f-4dc6-a9e8-038777ba8c1c
/chat.getPermalink:
get:
description: Retrieve a permanent URL link for a specific message in a Slack channel. This permalink can be used to reference the message directly in other communications or applications.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/chat.getPermalink
operationId: slack_web_api_chat_get_permalink
parameters:
- description: 'Authentication token. Requires scope: `none`'
in: query
name: token
required: true
schema:
type: string
- description: The ID of the conversation or channel containing the message
in: query
name: channel
required: true
schema:
type: string
- description: A message's `ts` value, uniquely identifying it within a channel
in: query
name: message_ts
required: true
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
channel: C1H9RESGA
ok: true
permalink: https://ghostbusters.slack.com/archives/C1H9RESGA/p135854651500008
schema:
additionalProperties: false
description: Schema for successful response chat.getPermalink
properties:
channel:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
ok:
enum:
- true
title: default success response
type: boolean
permalink:
format: uri
type: string
required:
- ok
- channel
- permalink
title: chat.getPermalink success schema
type: object
description: Standard success response
default:
content:
application/json:
examples:
response:
value:
error: channel_not_found
ok: false
schema:
additionalProperties: false
description: Schema for error response from chat.getPermalink method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- channel_not_found
- message_not_found
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- org_login_required
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: chat.getPermalink error schema
type: object
description: Error response when channel cannot be found
security:
- slackAuth:
- none
tags:
- chat
summary: Get message permalink
x-uuid: 80c6cace-de35-4091-b069-b26561302258
/chat.meMessage:
post:
description: Send a 'me' message to a Slack channel, which is a special type of message that appears as an action performed by the user, rather than a regular message.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/chat.meMessage
operationId: slack_web_api_chat_me_message
parameters:
- description: 'Authentication token. Requires scope: `chat:write`'
in: header
name: token
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel:
description: Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
type: string
text:
description: Text of the message to send.
type: string
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
channel: C024BE7LR
ok: true
ts: '1417671948.000006'
schema:
additionalProperties: false
description: Schema for successful response from chat.meMessage method
properties:
channel:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
ok:
enum:
- true
title: default success response
type: boolean
ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
required:
- ok
title: chat.meMessage schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_auth
ok: false
schema:
additionalProperties: false
description: Schema for error response from chat.meMessage method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- channel_not_found
- not_in_channel
- is_archived
- msg_too_long
- no_text
- rate_limited
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- org_login_required
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: chat.meMessage error schema
type: object
description: Typical error response
security:
- slackAuth:
- chat:write:user
- chat:write:bot
tags:
- chat
summary: Send a 'me' message
x-uuid: e1246f3a-d308-4cf0-b52f-aeaaff2546f8
/chat.postEphemeral:
post:
description: Send an ephemeral message to a user in a Slack channel. Ephemeral messages are temporary and only visible to the specified user, making them ideal for private notifications.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/chat.postEphemeral
operationId: slack_web_api_chat_post_ephemeral
parameters:
- description: 'Authentication token. Requires scope: `chat:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
as_user:
description: Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.
type: boolean
attachments:
description: A JSON-based array of structured attachments, presented as a URL-encoded string.
type: string
blocks:
description: A JSON-based array of structured blocks, presented as a URL-encoded string.
type: string
channel:
description: Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.
type: string
icon_emoji:
description: Emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to `false`, otherwise ignored. See [authorship](#authorship) below.
type: string
icon_url:
description: URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.
type: string
link_names:
description: Find and link channel names and usernames.
type: boolean
parse:
description: Change how messages are treated. Defaults to `none`. See [below](#formatting).
type: string
text:
description: How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail.
type: string
thread_ts:
description: Provide another message's `ts` value to post this message in a thread. Avoid using a reply's `ts` value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.
type: string
user:
description: '`id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument.'
type: string
username:
description: Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.
type: string
required:
- channel
- user
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
message_ts: '1502210682.580145'
ok: true
schema:
additionalProperties: false
description: Schema for successful response from chat.postEphemeral method
properties:
message_ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
- message_ts
title: chat.postEphemeral success schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: user_not_in_channel
ok: false
schema:
additionalProperties: false
description: Schema for error response from chat.postEphemeral method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- channel_not_found
- is_archived
- msg_too_long
- no_text
- restricted_action
- too_many_attachments
- user_not_in_channel
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- org_login_required
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: chat.postEphemeral error schema
type: object
description: Typical error response
security:
- slackAuth:
- chat:write:user
- chat:write:bot
tags:
- chat
summary: Send ephemeral message to user
x-uuid: 60267f29-bccf-47e9-a2ce-7d66cdf3cf50
/chat.postMessage:
post:
description: Send a message to a Slack channel. This endpoint is used for posting regular messages that are visible to all members of the channel.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/chat.postMessage
operationId: slack_web_api_chat_post_message
parameters:
- description: 'Authentication token. Requires scope: `chat:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
as_user:
description: Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below.
type: string
attachments:
description: A JSON-based array of structured attachments, presented as a URL-encoded string.
type: string
blocks:
description: A JSON-based array of structured blocks, presented as a URL-encoded string.
type: string
channel:
description: Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.
type: string
icon_emoji:
description: Emoji to use as the icon for this message. Overrides `icon_url`. Must be used in conjunction with `as_user` set to `false`, otherwise ignored. See [authorship](#authorship) below.
type: string
icon_url:
description: URL to an image to use as the icon for this message. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.
type: string
link_names:
description: Find and link channel names and usernames.
type: boolean
mrkdwn:
description: Disable Slack markup parsing by setting to `false`. Enabled by default.
type: boolean
parse:
description: Change how messages are treated. Defaults to `none`. See [below](#formatting).
type: string
reply_broadcast:
description: Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.
type: boolean
text:
description: How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail.
type: string
thread_ts:
description: Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.
type: string
unfurl_links:
description: Pass true to enable unfurling of primarily text-based content.
type: boolean
unfurl_media:
description: Pass false to disable unfurling of media content.
type: boolean
username:
description: Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.
type: string
required:
- channel
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
channel: C1H9RESGL
message:
attachments:
- fallback: This is an attachment's fallback
id: 1
text: This is an attachment
bot_id: B19LU7CSY
subtype: bot_message
text: Here's a message for you
ts: '1503435956.000247'
type: message
username: ecto1
ok: true
ts: '1503435956.000247'
schema:
additionalProperties: false
description: Schema for successful response of chat.postMessage method
properties:
channel:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
message:
additionalProperties: false
properties:
attachments:
items:
additionalProperties: false
properties:
fallback:
type: string
id:
type: integer
image_bytes:
type: integer
image_height:
type: integer
image_url:
type: string
image_width:
type: integer
required:
- id
type: object
minItems: 1
type: array
uniqueItems: true
blocks:
description: This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace.
items:
additionalProperties: true
properties:
type:
type: string
required:
- type
type: object
title: Block Kit blocks
type: array
bot_id:
items:
anyOf:
- pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
- nullable: true
title: Nil bot_id set when display_as_bot is false
bot_profile:
additionalProperties: false
properties:
app_id:
pattern: ^A[A-Z0-9]{1,}$
title: App ID
type: string
deleted:
type: boolean
icons:
additionalProperties: false
properties:
image_36:
format: uri
type: string
image_48:
format: uri
type: string
image_72:
format: uri
type: string
required:
- image_36
- image_48
- image_72
type: object
id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
name:
type: string
team_id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
updated:
type: integer
required:
- id
- deleted
- name
- updated
- app_id
- icons
- team_id
title: Bot Profile Object
type: object
client_msg_id:
type: string
comment:
additionalProperties: false
properties:
comment:
type: string
created:
type: integer
id:
pattern: ^Fc[A-Z0-9]{8,}$
title: File Comment ID
type: string
is_intro:
type: boolean
is_starred:
type: boolean
num_stars:
type: integer
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
timestamp:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- id
- created
- timestamp
- user
- is_intro
- comment
title: File Comment Object
type: object
display_as_bot:
type: boolean
file:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
files:
items:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
minItems: 1
type: array
uniqueItems: true
icons:
additionalProperties: false
properties:
emoji:
type: string
image_64:
format: uri
type: string
type: object
inviter:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_delayed_message:
type: boolean
is_intro:
type: boolean
is_starred:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest_reply:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
name:
type: string
old_name:
type: string
parent_user_id:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
permalink:
format: uri
type: string
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
purpose:
type: string
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
reply_count:
type: integer
reply_users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 1
type: array
uniqueItems: true
reply_users_count:
type: integer
source_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
subscribed:
type: boolean
subtype:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
text:
type: string
thread_ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
topic:
type: string
ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
type:
type: string
unread_count:
type: integer
upload:
type: boolean
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
user_profile:
additionalProperties: false
properties:
avatar_hash:
type: string
display_name:
type: string
display_name_normalized:
type: string
first_name:
nullable: true
type: string
image_72:
format: uri
type: string
is_restricted:
type: boolean
is_ultra_restricted:
type: boolean
name:
type: string
real_name:
type: string
real_name_normalized:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
required:
- avatar_hash
- image_72
- first_name
- real_name
- display_name
- team
- name
- is_restricted
- is_ultra_restricted
type: object
user_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
username:
type: string
required:
- text
- type
- ts
title: Message object
type: object
ok:
enum:
- true
title: default success response
type: boolean
ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
required:
- ok
- channel
- ts
- message
title: chat.postMessage success schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: too_many_attachments
ok: false
schema:
additionalProperties: false
description: Schema for error response chat.postMessage method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- channel_not_found
- not_in_channel
- is_archived
- msg_too_long
- no_text
- too_many_attachments
- rate_limited
- not_authed
- invalid_auth
- account_inactive
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: chat.postMessage error schema
type: object
description: Typical error response if too many attachments are included
security:
- slackAuth:
- chat:write:user
- chat:write:bot
tags:
- chat
summary: Send message to channel
x-uuid: 03745bdc-8751-40e7-88e0-6af6ca99e2b8
/chat.scheduleMessage:
post:
description: Schedule a message to be sent to a Slack channel at a later time. This endpoint allows you to plan messages in advance, ensuring timely communication.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/chat.scheduleMessage
operationId: slack_web_api_chat_schedule_message
parameters:
- description: 'Authentication token. Requires scope: `chat:write`'
in: header
name: token
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
as_user:
description: Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [chat.postMessage](chat.postMessage#authorship).
type: boolean
attachments:
description: A JSON-based array of structured attachments, presented as a URL-encoded string.
type: string
blocks:
description: A JSON-based array of structured blocks, presented as a URL-encoded string.
type: string
channel:
description: Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.
type: string
link_names:
description: Find and link channel names and usernames.
type: boolean
parse:
description: Change how messages are treated. Defaults to `none`. See [chat.postMessage](chat.postMessage#formatting).
type: string
post_at:
description: Unix EPOCH timestamp of time in future to send the message.
type: string
reply_broadcast:
description: Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.
type: boolean
text:
description: How this field works and whether it is required depends on other fields you use in your API call. [See below](#text_usage) for more detail.
type: string
thread_ts:
description: Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.
type: number
unfurl_links:
description: Pass true to enable unfurling of primarily text-based content.
type: boolean
unfurl_media:
description: Pass false to disable unfurling of media content.
type: boolean
type: object
required:
- channel
- post_at
responses:
'200':
content:
application/json:
examples:
response:
value:
channel: C1H9RESGL
message:
attachments:
- fallback: This is an attachment's fallback
id: 1
text: This is an attachment
bot_id: B19LU7CSY
subtype: bot_message
text: Here's a message for you in the future
type: delayed_message
username: ecto1
ok: true
post_at: '1562180400'
scheduled_message_id: Q1298393284
schema:
additionalProperties: false
description: Schema for successful response of chat.scheduleMessage method
properties:
channel:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
message:
additionalProperties: false
properties:
bot_id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
bot_profile:
additionalProperties: false
properties:
app_id:
pattern: ^A[A-Z0-9]{1,}$
title: App ID
type: string
deleted:
type: boolean
icons:
additionalProperties: false
properties:
image_36:
format: uri
type: string
image_48:
format: uri
type: string
image_72:
format: uri
type: string
required:
- image_36
- image_48
- image_72
type: object
id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
name:
type: string
team_id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
updated:
type: integer
required:
- id
- deleted
- name
- updated
- app_id
- icons
- team_id
title: Bot Profile Object
type: object
team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
text:
type: string
type:
type: string
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
username:
type: string
required:
- type
- text
- bot_id
- user
- team
type: object
ok:
enum:
- true
title: default success response
type: boolean
post_at:
pattern: ^\d{10}$
type: integer
scheduled_message_id:
pattern: ^[Q][A-Z0-9]{8,}$
title: Scheduled Message ID
type: string
required:
- ok
- channel
- post_at
- scheduled_message_id
- message
title: chat.scheduleMessage success schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: time_in_past
ok: false
schema:
additionalProperties: false
description: Schema for error response chat.scheduleMessage method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- invalid_time
- time_in_past
- time_too_far
- channel_not_found
- not_in_channel
- is_archived
- msg_too_long
- no_text
- restricted_action
- restricted_action_read_only_channel
- restricted_action_thread_only_channel
- restricted_action_non_threadable_channel
- too_many_attachments
- rate_limited
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- org_login_required
- ekm_access_denied
- missing_scope
- invalid_arguments
- invalid_arg_name
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: chat.scheduleMessage error schema
type: object
description: Typical error response if the `post_at` is invalid (ex. in the past or too far into the future)
security:
- slackAuth:
- chat:write:user
- chat:write:bot
tags:
- chat
summary: Schedule message to channel
x-uuid: 420a4fee-330c-4701-92fa-4792860fef8d
/chat.scheduledMessages.list:
get:
description: Retrieve a list of all messages that have been scheduled for future delivery in Slack. This endpoint helps you manage and review upcoming communications.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/chat.scheduledMessages.list
operationId: slack_web_api_chat_scheduled_messages_list
parameters:
- description: 'Authentication token. Requires scope: `none`'
in: header
name: token
schema:
type: string
- description: The channel of the scheduled messages
in: query
name: channel
schema:
type: string
- description: A UNIX timestamp of the latest value in the time range
in: query
name: latest
schema:
type: number
- description: A UNIX timestamp of the oldest value in the time range
in: query
name: oldest
schema:
type: number
- description: Maximum number of original entries to return.
in: query
name: limit
schema:
type: integer
- description: For pagination purposes, this is the `cursor` value returned from a previous call to `chat.scheduledmessages.list` indicating where you want to start this call from.
in: query
name: cursor
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
response_metadata:
next_cursor: ''
scheduled_messages:
- channel_id: C1H9RESGL
date_created: 1551891734
id: 1298393284
post_at: 1551991428
text: Here's a message for you in the future
schema:
additionalProperties: false
description: Schema for successful response from chat.scheduledMessages.list method
properties:
ok:
enum:
- true
title: default success response
type: boolean
response_metadata:
additionalProperties: false
properties:
next_cursor:
type: string
required:
- next_cursor
type: object
scheduled_messages:
items:
additionalProperties: false
properties:
channel_id:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
date_created:
pattern: ^\d{10}$
type: integer
id:
pattern: ^[Q][A-Z0-9]{8,}$
type: string
post_at:
pattern: ^\d{10}$
type: integer
text:
type: string
required:
- id
- channel_id
- post_at
- date_created
type: object
type: array
required:
- ok
- scheduled_messages
- response_metadata
title: chat.scheduledMessages.list schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: invalid_channel
ok: false
schema:
additionalProperties: false
description: Schema for error response from chat.scheduledMessages.list method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- invalid_channel
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- org_login_required
- ekm_access_denied
- missing_scope
- invalid_arguments
- invalid_arg_name
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: chat.scheduledMessages.list error schema
type: object
description: Typical error response if the channel passed is invalid
security:
- slackAuth:
- none
tags:
- chat.scheduledMessages
- chat
summary: List scheduled messages
x-uuid: d3e036c5-68da-4963-9be2-bf46a61bb312
/chat.unfurl:
post:
description: Provide custom unfurl behavior for URLs posted by users in Slack. This endpoint allows you to control how links are expanded and displayed within the chat.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/chat.unfurl
operationId: slack_web_api_chat_unfurl
parameters:
- description: 'Authentication token. Requires scope: `links:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel:
description: Channel ID of the message
type: string
ts:
description: Timestamp of the message to add unfurl behavior to.
type: string
unfurls:
description: URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.
type: string
user_auth_message:
description: Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior
type: string
user_auth_required:
description: Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain
type: boolean
user_auth_url:
description: Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.
type: string
required:
- channel
- ts
type: object
required: true
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response from chat.unfurl method
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: chat.unfurl success schema
type: object
description: Typical, minimal success response
default:
content:
application/json:
examples:
response:
value:
error: cannot_unfurl_url
ok: false
schema:
additionalProperties: false
description: Schema for error response from chat.unfurl method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- cannot_unfurl_url
- cannot_find_service
- missing_unfurls
- cannot_prompt
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- org_login_required
- user_is_bot
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- fatal_error
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: chat.unfurl error schema
type: object
description: Typical error response
security:
- slackAuth:
- links:write
tags:
- chat
summary: Customize URL unfurling
x-uuid: 050054da-36e6-4bba-ba80-d55cb1cc837c
/chat.update:
post:
description: Update an existing message in a Slack channel. This endpoint allows you to modify the content of a message after it has been posted.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/chat.update
operationId: slack_web_api_chat_update
parameters:
- description: 'Authentication token. Requires scope: `chat:write`'
in: header
name: token
required: true
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
as_user:
description: Pass true to update the message as the authed user. [Bot users](/bot-users) in this context are considered authed users.
type: string
attachments:
description: A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting `text`. If you don't include this field, the message's previous `attachments` will be retained. To remove previous `attachments`, include an empty array for this field.
type: string
blocks:
description: A JSON-based array of [structured blocks](/block-kit/building), presented as a URL-encoded string. If you don't include this field, the message's previous `blocks` will be retained. To remove previous `blocks`, include an empty array for this field.
type: string
channel:
description: Channel containing the message to be updated.
type: string
link_names:
description: Find and link channel names and usernames. Defaults to `none`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `none`.
type: string
parse:
description: Change how messages are treated. Defaults to `client`, unlike `chat.postMessage`. Accepts either `none` or `full`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `client`.
type: string
text:
description: New text for the message, using the [default formatting rules](/reference/surfaces/formatting). It's not required when presenting `blocks` or `attachments`.
type: string
ts:
description: Timestamp of the message to be updated.
type: string
required:
- channel
- ts
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
channel: C024BE91L
message:
text: Updated text you carefully authored
user: U34567890
ok: true
text: Updated text you carefully authored
ts: '1401383885.000061'
schema:
additionalProperties: false
description: Schema for successful response of chat.update method
properties:
channel:
type: string
message:
properties:
attachments:
items:
type: object
type: array
blocks:
type: object
text:
type: string
required:
- text
title: Message object
type: object
ok:
enum:
- true
title: default success response
type: boolean
text:
type: string
ts:
type: string
required:
- ok
- channel
- ts
- text
- message
title: chat.update success schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: cant_update_message
ok: false
schema:
additionalProperties: false
description: Schema for error response chat.update method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- message_not_found
- cant_update_message
- channel_not_found
- edit_window_closed
- msg_too_long
- too_many_attachments
- rate_limited
- no_text
- not_authed
- invalid_auth
- account_inactive
- token_revoked
- no_permission
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- request_timeout
- invalid_json
- json_not_object
- upgrade_required
- fatal_error
- is_inactive
type: string
ok:
enum:
- false
title: default failure response
type: boolean
required:
- ok
- error
title: chat.update error schema
type: object
description: Typical error response
security:
- slackAuth:
- chat:write:user
- chat:write:bot
tags:
- chat
summary: Update a message
x-uuid: 904773eb-140d-4065-879d-670492a3a935
/conversations.archive:
post:
description: Archive a conversation in Slack, making it read-only and removing it from the active conversation list. This is useful for closing channels that are no longer needed.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/conversations.archive
operationId: slack_web_api_conversations_archive
parameters:
- description: 'Authentication token. Requires scope: `conversations:write`'
in: header
name: token
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel:
description: ID of conversation to archive
type: string
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response conversations.archive method
properties:
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: conversations.archive success schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: channel_not_found
ok: false
schema:
additionalProperties: false
description: Schema for error response from conversations.archive method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- method_not_supported_for_channel_type
- missing_scope
- not_supported
- channel_not_found
- already_archived
- cant_archive_general
- restricted_action
- not_authed
- invalid_auth
- account_inactive
- user_is_bot
- user_is_restricted
- user_is_ultra_restricted
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
- team_added_to_org
- missing_charset
- superfluous_charset
type: string
needed:
type: string
ok:
enum:
- false
title: default failure response
type: boolean
provided:
type: string
required:
- ok
- error
title: conversations.archive error schema
type: object
description: Typical error response
security:
- slackAuth:
- channels:write
- groups:write
- im:write
- mpim:write
tags:
- conversations
summary: Archive a conversation
x-uuid: a7141f73-b5cf-47a7-ab03-4394626a1fbe
/conversations.close:
post:
description: Close a direct message or multi-person direct message in Slack. This endpoint is used to end a private conversation, removing it from the active list.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/conversations.close
operationId: slack_web_api_conversations_close
parameters:
- description: 'Authentication token. Requires scope: `conversations:write`'
in: header
name: token
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel:
description: Conversation to close.
type: string
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
ok: true
schema:
additionalProperties: false
description: Schema for successful response conversations.close method
properties:
already_closed:
type: boolean
no_op:
type: boolean
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
title: conversations.close success schema
type: object
description: Typical success response
default:
content:
application/json:
examples:
response:
value:
error: channel_not_found
ok: false
schema:
additionalProperties: false
description: Schema for error response from conversations.close method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- method_not_supported_for_channel_type
- channel_not_found
- user_does_not_own_channel
- missing_scope
- not_authed
- invalid_auth
- account_inactive
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
type: string
needed:
type: string
ok:
enum:
- false
title: default failure response
type: boolean
provided:
type: string
required:
- ok
- error
title: conversations.close error schema
type: object
description: Typical error response
security:
- slackAuth:
- channels:write
- groups:write
- im:write
- mpim:write
tags:
- conversations
summary: Close a direct message
x-uuid: 823e5802-3f4a-42d4-a8f8-f7d9b33d4ca3
/conversations.create:
post:
description: Create a new public or private channel-based conversation in Slack. This endpoint allows you to initiate a new space for team communication.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/conversations.create
operationId: slack_web_api_conversations_create
parameters:
- description: 'Authentication token. Requires scope: `conversations:write`'
in: header
name: token
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
is_private:
description: Create a private channel instead of a public one
type: boolean
name:
description: Name of the public or private channel to create
type: string
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
channel:
created: 1504554479
creator: U0123456
id: C0EAQDV4Z
is_archived: false
is_channel: true
is_ext_shared: false
is_general: false
is_group: false
is_im: false
is_member: true
is_mpim: false
is_org_shared: false
is_pending_ext_shared: false
is_private: false
is_shared: false
last_read: '0000000000.000000'
latest: null
name: endeavor
name_normalized: endeavor
pending_shared: []
previous_names: []
priority: 0
purpose:
creator: ''
last_set: 0
value: ''
topic:
creator: ''
last_set: 0
value: ''
unlinked: 0
unread_count: 0
unread_count_display: 0
ok: true
schema:
additionalProperties: false
description: Schema for successful response conversations.create method
properties:
channel:
items:
anyOf:
- additionalProperties: false
properties:
accepted_user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
connected_team_ids:
items:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
minItems: 0
type: array
uniqueItems: true
conversation_host_id:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
created:
type: integer
creator:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
display_counts:
additionalProperties: false
properties:
display_counts:
type: integer
guest_counts:
type: integer
required:
- display_counts
- guest_counts
type: object
enterprise_id:
pattern: ^[E][A-Z0-9]{8,}$
title: Enterprise ID
type: string
has_pins:
type: boolean
id:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
internal_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
is_archived:
type: boolean
is_channel:
type: boolean
is_ext_shared:
type: boolean
is_frozen:
type: boolean
is_general:
type: boolean
is_global_shared:
type: boolean
is_group:
type: boolean
is_im:
type: boolean
is_member:
type: boolean
is_moved:
type: integer
is_mpim:
enum:
- false
type: boolean
is_non_threadable:
type: boolean
is_open:
type: boolean
is_org_default:
type: boolean
is_org_mandatory:
type: boolean
is_org_shared:
type: boolean
is_pending_ext_shared:
type: boolean
is_private:
type: boolean
is_read_only:
type: boolean
is_shared:
type: boolean
is_starred:
type: boolean
is_thread_only:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest:
items:
anyOf:
- additionalProperties: false
properties:
attachments:
items:
additionalProperties: false
properties:
fallback:
type: string
id:
type: integer
image_bytes:
type: integer
image_height:
type: integer
image_url:
type: string
image_width:
type: integer
required:
- id
type: object
minItems: 1
type: array
uniqueItems: true
blocks:
description: This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace.
items:
additionalProperties: true
properties:
type:
type: string
required:
- type
type: object
title: Block Kit blocks
type: array
bot_id:
items:
anyOf:
- pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
- nullable: true
title: Nil bot_id set when display_as_bot is false
bot_profile:
additionalProperties: false
properties:
app_id:
pattern: ^A[A-Z0-9]{1,}$
title: App ID
type: string
deleted:
type: boolean
icons:
additionalProperties: false
properties:
image_36:
format: uri
type: string
image_48:
format: uri
type: string
image_72:
format: uri
type: string
required:
- image_36
- image_48
- image_72
type: object
id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
name:
type: string
team_id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
updated:
type: integer
required:
- id
- deleted
- name
- updated
- app_id
- icons
- team_id
title: Bot Profile Object
type: object
client_msg_id:
type: string
comment:
additionalProperties: false
properties:
comment:
type: string
created:
type: integer
id:
pattern: ^Fc[A-Z0-9]{8,}$
title: File Comment ID
type: string
is_intro:
type: boolean
is_starred:
type: boolean
num_stars:
type: integer
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
timestamp:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- id
- created
- timestamp
- user
- is_intro
- comment
title: File Comment Object
type: object
display_as_bot:
type: boolean
file:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
files:
items:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
minItems: 1
type: array
uniqueItems: true
icons:
additionalProperties: false
properties:
emoji:
type: string
image_64:
format: uri
type: string
type: object
inviter:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_delayed_message:
type: boolean
is_intro:
type: boolean
is_starred:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest_reply:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
name:
type: string
old_name:
type: string
parent_user_id:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
permalink:
format: uri
type: string
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
purpose:
type: string
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
reply_count:
type: integer
reply_users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 1
type: array
uniqueItems: true
reply_users_count:
type: integer
source_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
subscribed:
type: boolean
subtype:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
text:
type: string
thread_ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
topic:
type: string
ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
type:
type: string
unread_count:
type: integer
upload:
type: boolean
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
user_profile:
additionalProperties: false
properties:
avatar_hash:
type: string
display_name:
type: string
display_name_normalized:
type: string
first_name:
nullable: true
type: string
image_72:
format: uri
type: string
is_restricted:
type: boolean
is_ultra_restricted:
type: boolean
name:
type: string
real_name:
type: string
real_name_normalized:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
required:
- avatar_hash
- image_72
- first_name
- real_name
- display_name
- team
- name
- is_restricted
- is_ultra_restricted
type: object
user_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
username:
type: string
required:
- text
- type
- ts
title: Message object
type: object
- nullable: true
members:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 0
type: array
uniqueItems: true
name:
type: string
name_normalized:
type: string
num_members:
type: integer
parent_conversation:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- nullable: true
pending_connected_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
pending_shared:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
pin_count:
type: integer
previous_names:
items:
title: Name of a channel
type: string
minItems: 0
type: array
uniqueItems: true
priority:
type: number
purpose:
additionalProperties: false
properties:
creator:
pattern: ^[UW][A-Z0-9]{8,}$|^$
title: User ID or empty string, used for topic and purpose creation
type: string
last_set:
type: integer
value:
type: string
required:
- value
- creator
- last_set
type: object
shared_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
shares:
items:
additionalProperties: false
properties:
accepted_user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_active:
type: boolean
team:
additionalProperties: false
properties:
archived:
type: boolean
avatar_base_url:
format: uri
type: string
created:
type: integer
date_create:
type: integer
deleted:
type: boolean
description:
nullable: true
type: string
discoverable:
items:
anyOf:
- nullable: true
- type: string
domain:
type: string
email_domain:
type: string
enterprise_id:
pattern: ^[E][A-Z0-9]{8,}$
title: Enterprise ID
type: string
enterprise_name:
title: Name of the enterprise org
type: string
external_org_migrations:
properties:
current:
items:
properties:
date_started:
type: integer
team_id:
type: string
required:
- team_id
- date_started
type: object
type: array
date_updated:
type: integer
required:
- date_updated
- current
title: External Org Migrations
type: object
has_compliance_export:
type: boolean
icon:
properties:
image_102:
type: string
image_132:
type: string
image_230:
type: string
image_34:
type: string
image_44:
type: string
image_68:
type: string
image_88:
type: string
image_default:
type: boolean
type: object
id:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
is_assigned:
type: boolean
is_enterprise:
type: integer
is_over_storage_limit:
type: boolean
limit_ts:
type: integer
locale:
type: string
messages_count:
type: integer
msg_edit_window_mins:
type: integer
name:
type: string
over_integrations_limit:
type: boolean
over_storage_limit:
type: boolean
pay_prod_cur:
type: string
plan:
enum:
- ''
- std
- plus
- compliance
- enterprise
type: string
primary_owner:
properties:
email:
type: string
id:
type: string
required:
- id
- email
type: object
sso_provider:
properties:
label:
type: string
name:
type: string
type:
type: string
type: object
required:
- id
- name
- domain
- email_domain
- icon
title: Team Object
type: object
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- team
- user
- is_active
type: object
minItems: 0
type: array
uniqueItems: true
timezone_count:
type: integer
topic:
additionalProperties: false
properties:
creator:
pattern: ^[UW][A-Z0-9]{8,}$|^$
title: User ID or empty string, used for topic and purpose creation
type: string
last_set:
type: integer
value:
type: string
required:
- value
- creator
- last_set
type: object
unlinked:
title: Field to determine whether a channel has ever been shared/disconnected in the past
type: integer
unread_count:
type: integer
unread_count_display:
type: integer
use_case:
type: string
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
version:
type: integer
required:
- id
- name
- created
- creator
- is_archived
- is_channel
- is_general
- is_mpim
- is_group
- is_org_shared
- is_im
- is_shared
- is_private
- name_normalized
- topic
- purpose
title: Conversation object
type: object
- additionalProperties: false
properties:
accepted_user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
connected_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
conversation_host_id:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
created:
type: integer
creator:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
display_counts:
additionalProperties: false
properties:
display_counts:
type: integer
guest_counts:
type: integer
required:
- display_counts
- guest_counts
type: object
id:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
internal_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
is_archived:
type: boolean
is_channel:
type: boolean
is_ext_shared:
type: boolean
is_frozen:
type: boolean
is_general:
type: boolean
is_group:
type: boolean
is_im:
type: boolean
is_member:
type: boolean
is_moved:
type: integer
is_mpim:
enum:
- true
type: boolean
is_non_threadable:
type: boolean
is_open:
type: boolean
is_org_shared:
type: boolean
is_pending_ext_shared:
type: boolean
is_private:
type: boolean
is_read_only:
type: boolean
is_shared:
type: boolean
is_starred:
type: boolean
is_thread_only:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest:
items:
anyOf:
- additionalProperties: false
properties:
attachments:
items:
additionalProperties: false
properties:
fallback:
type: string
id:
type: integer
image_bytes:
type: integer
image_height:
type: integer
image_url:
type: string
image_width:
type: integer
required:
- id
type: object
minItems: 1
type: array
uniqueItems: true
blocks:
description: This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace.
items:
additionalProperties: true
properties:
type:
type: string
required:
- type
type: object
title: Block Kit blocks
type: array
bot_id:
items:
anyOf:
- pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
- nullable: true
title: Nil bot_id set when display_as_bot is false
bot_profile:
additionalProperties: false
properties:
app_id:
pattern: ^A[A-Z0-9]{1,}$
title: App ID
type: string
deleted:
type: boolean
icons:
additionalProperties: false
properties:
image_36:
format: uri
type: string
image_48:
format: uri
type: string
image_72:
format: uri
type: string
required:
- image_36
- image_48
- image_72
type: object
id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
name:
type: string
team_id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
updated:
type: integer
required:
- id
- deleted
- name
- updated
- app_id
- icons
- team_id
title: Bot Profile Object
type: object
client_msg_id:
type: string
comment:
additionalProperties: false
properties:
comment:
type: string
created:
type: integer
id:
pattern: ^Fc[A-Z0-9]{8,}$
title: File Comment ID
type: string
is_intro:
type: boolean
is_starred:
type: boolean
num_stars:
type: integer
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
timestamp:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- id
- created
- timestamp
- user
- is_intro
- comment
title: File Comment Object
type: object
display_as_bot:
type: boolean
file:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
files:
items:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
minItems: 1
type: array
uniqueItems: true
icons:
additionalProperties: false
properties:
emoji:
type: string
image_64:
format: uri
type: string
type: object
inviter:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_delayed_message:
type: boolean
is_intro:
type: boolean
is_starred:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest_reply:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
name:
type: string
old_name:
type: string
parent_user_id:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
permalink:
format: uri
type: string
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
purpose:
type: string
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
reply_count:
type: integer
reply_users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 1
type: array
uniqueItems: true
reply_users_count:
type: integer
source_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
subscribed:
type: boolean
subtype:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
text:
type: string
thread_ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
topic:
type: string
ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
type:
type: string
unread_count:
type: integer
upload:
type: boolean
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
user_profile:
additionalProperties: false
properties:
avatar_hash:
type: string
display_name:
type: string
display_name_normalized:
type: string
first_name:
nullable: true
type: string
image_72:
format: uri
type: string
is_restricted:
type: boolean
is_ultra_restricted:
type: boolean
name:
type: string
real_name:
type: string
real_name_normalized:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
required:
- avatar_hash
- image_72
- first_name
- real_name
- display_name
- team
- name
- is_restricted
- is_ultra_restricted
type: object
user_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
username:
type: string
required:
- text
- type
- ts
title: Message object
type: object
- nullable: true
members:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 0
type: array
uniqueItems: true
name:
type: string
name_normalized:
type: string
num_members:
type: integer
parent_conversation:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- nullable: true
pending_connected_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
pending_shared:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
pin_count:
type: integer
previous_names:
items:
title: Name of a channel
type: string
minItems: 0
type: array
uniqueItems: true
priority:
type: number
purpose:
additionalProperties: false
properties:
creator:
pattern: ^[UW][A-Z0-9]{8,}$|^$
title: User ID or empty string, used for topic and purpose creation
type: string
last_set:
type: integer
value:
type: string
required:
- value
- creator
- last_set
type: object
shared_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
shares:
items:
additionalProperties: false
properties:
accepted_user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_active:
type: boolean
team:
additionalProperties: false
properties:
archived:
type: boolean
avatar_base_url:
format: uri
type: string
created:
type: integer
date_create:
type: integer
deleted:
type: boolean
description:
nullable: true
type: string
discoverable:
items:
anyOf:
- nullable: true
- type: string
domain:
type: string
email_domain:
type: string
enterprise_id:
pattern: ^[E][A-Z0-9]{8,}$
title: Enterprise ID
type: string
enterprise_name:
title: Name of the enterprise org
type: string
external_org_migrations:
properties:
current:
items:
properties:
date_started:
type: integer
team_id:
type: string
required:
- team_id
- date_started
type: object
type: array
date_updated:
type: integer
required:
- date_updated
- current
title: External Org Migrations
type: object
has_compliance_export:
type: boolean
icon:
properties:
image_102:
type: string
image_132:
type: string
image_230:
type: string
image_34:
type: string
image_44:
type: string
image_68:
type: string
image_88:
type: string
image_default:
type: boolean
type: object
id:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
is_assigned:
type: boolean
is_enterprise:
type: integer
is_over_storage_limit:
type: boolean
limit_ts:
type: integer
locale:
type: string
messages_count:
type: integer
msg_edit_window_mins:
type: integer
name:
type: string
over_integrations_limit:
type: boolean
over_storage_limit:
type: boolean
pay_prod_cur:
type: string
plan:
enum:
- ''
- std
- plus
- compliance
- enterprise
type: string
primary_owner:
properties:
email:
type: string
id:
type: string
required:
- id
- email
type: object
sso_provider:
properties:
label:
type: string
name:
type: string
type:
type: string
type: object
required:
- id
- name
- domain
- email_domain
- icon
title: Team Object
type: object
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- team
- user
- is_active
type: object
minItems: 0
type: array
uniqueItems: true
timezone_count:
type: integer
topic:
additionalProperties: false
properties:
creator:
pattern: ^[UW][A-Z0-9]{8,}$|^$
title: User ID or empty string, used for topic and purpose creation
type: string
last_set:
type: integer
value:
type: string
required:
- value
- creator
- last_set
type: object
unlinked:
title: Field to determine whether a channel has ever been shared/disconnected in the past
type: integer
unread_count:
type: integer
unread_count_display:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
version:
type: integer
required:
- id
- name
- created
- creator
- is_archived
- is_channel
- is_general
- is_mpim
- is_group
- is_org_shared
- is_im
- is_shared
- is_private
- name_normalized
- topic
- purpose
title: Conversation MPIM Object
type: object
- additionalProperties: false
properties:
created:
type: integer
has_pins:
type: boolean
id:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
is_archived:
type: boolean
is_ext_shared:
type: boolean
is_frozen:
type: boolean
is_im:
type: boolean
is_open:
type: boolean
is_org_shared:
type: boolean
is_shared:
type: boolean
is_starred:
type: boolean
is_user_deleted:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest:
items:
anyOf:
- additionalProperties: false
properties:
attachments:
items:
additionalProperties: false
properties:
fallback:
type: string
id:
type: integer
image_bytes:
type: integer
image_height:
type: integer
image_url:
type: string
image_width:
type: integer
required:
- id
type: object
minItems: 1
type: array
uniqueItems: true
blocks:
description: This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace.
items:
additionalProperties: true
properties:
type:
type: string
required:
- type
type: object
title: Block Kit blocks
type: array
bot_id:
items:
anyOf:
- pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
- nullable: true
title: Nil bot_id set when display_as_bot is false
bot_profile:
additionalProperties: false
properties:
app_id:
pattern: ^A[A-Z0-9]{1,}$
title: App ID
type: string
deleted:
type: boolean
icons:
additionalProperties: false
properties:
image_36:
format: uri
type: string
image_48:
format: uri
type: string
image_72:
format: uri
type: string
required:
- image_36
- image_48
- image_72
type: object
id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
name:
type: string
team_id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
updated:
type: integer
required:
- id
- deleted
- name
- updated
- app_id
- icons
- team_id
title: Bot Profile Object
type: object
client_msg_id:
type: string
comment:
additionalProperties: false
properties:
comment:
type: string
created:
type: integer
id:
pattern: ^Fc[A-Z0-9]{8,}$
title: File Comment ID
type: string
is_intro:
type: boolean
is_starred:
type: boolean
num_stars:
type: integer
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
timestamp:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- id
- created
- timestamp
- user
- is_intro
- comment
title: File Comment Object
type: object
display_as_bot:
type: boolean
file:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
files:
items:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
minItems: 1
type: array
uniqueItems: true
icons:
additionalProperties: false
properties:
emoji:
type: string
image_64:
format: uri
type: string
type: object
inviter:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_delayed_message:
type: boolean
is_intro:
type: boolean
is_starred:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest_reply:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
name:
type: string
old_name:
type: string
parent_user_id:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
permalink:
format: uri
type: string
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
purpose:
type: string
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
reply_count:
type: integer
reply_users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 1
type: array
uniqueItems: true
reply_users_count:
type: integer
source_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
subscribed:
type: boolean
subtype:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
text:
type: string
thread_ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
topic:
type: string
ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
type:
type: string
unread_count:
type: integer
upload:
type: boolean
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
user_profile:
additionalProperties: false
properties:
avatar_hash:
type: string
display_name:
type: string
display_name_normalized:
type: string
first_name:
nullable: true
type: string
image_72:
format: uri
type: string
is_restricted:
type: boolean
is_ultra_restricted:
type: boolean
name:
type: string
real_name:
type: string
real_name_normalized:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
required:
- avatar_hash
- image_72
- first_name
- real_name
- display_name
- team
- name
- is_restricted
- is_ultra_restricted
type: object
user_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
username:
type: string
required:
- text
- type
- ts
title: Message object
type: object
- nullable: true
parent_conversation:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- nullable: true
pin_count:
type: integer
priority:
type: number
shares:
items:
additionalProperties: false
properties:
date_create:
type: integer
id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
is_active:
type: boolean
name:
type: string
team:
additionalProperties: false
properties:
archived:
type: boolean
avatar_base_url:
format: uri
type: string
created:
type: integer
date_create:
type: integer
deleted:
type: boolean
description:
nullable: true
type: string
discoverable:
items:
anyOf:
- nullable: true
- type: string
domain:
type: string
email_domain:
type: string
enterprise_id:
pattern: ^[E][A-Z0-9]{8,}$
title: Enterprise ID
type: string
enterprise_name:
title: Name of the enterprise org
type: string
external_org_migrations:
properties:
current:
items:
properties:
date_started:
type: integer
team_id:
type: string
required:
- team_id
- date_started
type: object
type: array
date_updated:
type: integer
required:
- date_updated
- current
title: External Org Migrations
type: object
has_compliance_export:
type: boolean
icon:
properties:
image_102:
type: string
image_132:
type: string
image_230:
type: string
image_34:
type: string
image_44:
type: string
image_68:
type: string
image_88:
type: string
image_default:
type: boolean
type: object
id:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
is_assigned:
type: boolean
is_enterprise:
type: integer
is_over_storage_limit:
type: boolean
limit_ts:
type: integer
locale:
type: string
messages_count:
type: integer
msg_edit_window_mins:
type: integer
name:
type: string
over_integrations_limit:
type: boolean
over_storage_limit:
type: boolean
pay_prod_cur:
type: string
plan:
enum:
- ''
- std
- plus
- compliance
- enterprise
type: string
primary_owner:
properties:
email:
type: string
id:
type: string
required:
- id
- email
type: object
sso_provider:
properties:
label:
type: string
name:
type: string
type:
type: string
type: object
required:
- id
- name
- domain
- email_domain
- icon
title: Team Object
type: object
required:
- id
- name
- team
- date_create
- is_active
type: object
minItems: 0
type: array
uniqueItems: true
unread_count:
type: integer
unread_count_display:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
version:
type: integer
required:
- id
- created
- is_im
- is_org_shared
- user
- priority
title: Conversation IM Channel Object from conversations.* methods
type: object
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
- channel
title: conversations.create success schema
type: object
description: If successful, the command returns a rather stark [conversation object](/types/conversation)
default:
content:
application/json:
examples:
response:
value:
error: name_taken
ok: false
schema:
additionalProperties: false
description: Schema for error response from conversations.create method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
detail:
type: string
error:
enum:
- method_not_supported_for_channel_type
- missing_scope
- name_taken
- restricted_action
- no_channel
- invalid_name_required
- invalid_name_punctuation
- invalid_name_maxlength
- invalid_name_specials
- invalid_name
- not_authed
- invalid_auth
- account_inactive
- user_is_bot
- user_is_restricted
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- team_added_to_org
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
type: string
needed:
type: string
ok:
enum:
- false
title: default failure response
type: boolean
provided:
type: string
required:
- ok
- error
title: conversations.create error schema
type: object
description: Typical error response when name already in use
security:
- slackAuth:
- channels:write
- groups:write
- im:write
- mpim:write
tags:
- conversations
summary: Create a new conversation
x-uuid: a52b4ef6-4ae5-45e0-adab-57d072b034a0
/conversations.history:
get:
description: Fetch the history of messages and events from a specific conversation in Slack. This endpoint provides access to past communications within a channel or direct message.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/conversations.history
operationId: slack_web_api_conversations_history
parameters:
- description: 'Authentication token. Requires scope: `conversations:history`'
in: query
name: token
schema:
type: string
- description: Conversation ID to fetch history for.
in: query
name: channel
schema:
type: string
- description: End of time range of messages to include in results.
in: query
name: latest
schema:
type: number
- description: Start of time range of messages to include in results.
in: query
name: oldest
schema:
type: number
- description: Include messages with latest or oldest timestamp in results only when either timestamp is specified.
in: query
name: inclusive
schema:
type: boolean
- description: The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached.
in: query
name: limit
schema:
type: integer
- description: Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](/docs/pagination) for more detail.
in: query
name: cursor
schema:
type: string
responses:
'200':
content:
application/json:
examples:
response:
value:
has_more: true
messages:
- text: I find you punny and would like to smell your nose letter
ts: '1512085950.000216'
type: message
user: U012AB3CDE
- text: What, you want to smell my shoes better?
ts: '1512104434.000490'
type: message
user: U061F7AUR
ok: true
pin_count: 0
response_metadata:
next_cursor: bmV4dF90czoxNTEyMDg1ODYxMDAwNTQz
schema:
additionalProperties: false
description: Schema for successful response from conversations.history method
properties:
channel_actions_count:
type: integer
channel_actions_ts:
items:
anyOf:
- type: integer
- nullable: true
has_more:
type: boolean
messages:
items:
additionalProperties: false
properties:
attachments:
items:
additionalProperties: false
properties:
fallback:
type: string
id:
type: integer
image_bytes:
type: integer
image_height:
type: integer
image_url:
type: string
image_width:
type: integer
required:
- id
type: object
minItems: 1
type: array
uniqueItems: true
blocks:
description: This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace.
items:
additionalProperties: true
properties:
type:
type: string
required:
- type
type: object
title: Block Kit blocks
type: array
bot_id:
items:
anyOf:
- pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
- nullable: true
title: Nil bot_id set when display_as_bot is false
bot_profile:
additionalProperties: false
properties:
app_id:
pattern: ^A[A-Z0-9]{1,}$
title: App ID
type: string
deleted:
type: boolean
icons:
additionalProperties: false
properties:
image_36:
format: uri
type: string
image_48:
format: uri
type: string
image_72:
format: uri
type: string
required:
- image_36
- image_48
- image_72
type: object
id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
name:
type: string
team_id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
updated:
type: integer
required:
- id
- deleted
- name
- updated
- app_id
- icons
- team_id
title: Bot Profile Object
type: object
client_msg_id:
type: string
comment:
additionalProperties: false
properties:
comment:
type: string
created:
type: integer
id:
pattern: ^Fc[A-Z0-9]{8,}$
title: File Comment ID
type: string
is_intro:
type: boolean
is_starred:
type: boolean
num_stars:
type: integer
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
timestamp:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- id
- created
- timestamp
- user
- is_intro
- comment
title: File Comment Object
type: object
display_as_bot:
type: boolean
file:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
files:
items:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
minItems: 1
type: array
uniqueItems: true
icons:
additionalProperties: false
properties:
emoji:
type: string
image_64:
format: uri
type: string
type: object
inviter:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_delayed_message:
type: boolean
is_intro:
type: boolean
is_starred:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest_reply:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
name:
type: string
old_name:
type: string
parent_user_id:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
permalink:
format: uri
type: string
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
purpose:
type: string
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
reply_count:
type: integer
reply_users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 1
type: array
uniqueItems: true
reply_users_count:
type: integer
source_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
subscribed:
type: boolean
subtype:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
text:
type: string
thread_ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
topic:
type: string
ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
type:
type: string
unread_count:
type: integer
upload:
type: boolean
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
user_profile:
additionalProperties: false
properties:
avatar_hash:
type: string
display_name:
type: string
display_name_normalized:
type: string
first_name:
nullable: true
type: string
image_72:
format: uri
type: string
is_restricted:
type: boolean
is_ultra_restricted:
type: boolean
name:
type: string
real_name:
type: string
real_name_normalized:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
required:
- avatar_hash
- image_72
- first_name
- real_name
- display_name
- team
- name
- is_restricted
- is_ultra_restricted
type: object
user_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
username:
type: string
required:
- text
- type
- ts
title: Message object
type: object
minItems: 1
type: array
uniqueItems: true
ok:
enum:
- true
title: default success response
type: boolean
pin_count:
type: integer
required:
- ok
- messages
- has_more
- pin_count
- channel_actions_ts
- channel_actions_count
title: conversations.history success schema
type: object
description: Typical success response containing a channel's messages
default:
content:
application/json:
examples:
response:
value:
error: channel_not_found
ok: false
schema:
additionalProperties: false
description: Schema for error response from conversations.history method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- missing_scope
- channel_not_found
- invalid_ts_latest
- invalid_ts_oldest
- not_authed
- invalid_auth
- account_inactive
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
type: string
needed:
type: string
ok:
enum:
- false
title: default failure response
type: boolean
provided:
type: string
required:
- ok
- error
title: conversations.history error schema
type: object
description: Typical error response
security:
- slackAuth:
- channels:history
- groups:history
- im:history
- mpim:history
tags:
- conversations
summary: Fetch conversation history
x-uuid: 906e8d87-cef2-4e62-a367-cf791b84e06d
/conversations.info:
get:
description: Retrieve detailed information about a specific conversation in Slack, including its name, purpose, and member list.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/conversations.info
operationId: slack_web_api_conversations_info
parameters:
- description: 'Authentication token. Requires scope: `conversations:read`'
in: query
name: token
schema:
type: string
- description: Conversation ID to learn more about
in: query
name: channel
schema:
type: string
- description: Set this to `true` to receive the locale for this conversation. Defaults to `false`
in: query
name: include_locale
schema:
type: boolean
- description: Set to `true` to include the member count for the specified conversation. Defaults to `false`
in: query
name: include_num_members
schema:
type: boolean
responses:
'200':
content:
application/json:
examples:
response:
value:
channel:
created: 1449252889
creator: W012A3BCD
id: C012AB3CD
is_archived: false
is_channel: true
is_ext_shared: false
is_general: true
is_group: false
is_im: false
is_member: true
is_mpim: false
is_org_shared: false
is_pending_ext_shared: false
is_private: false
is_read_only: false
is_shared: false
last_read: '1502126650.228446'
locale: en-US
name: general
name_normalized: general
parent_conversation: null
pending_shared: []
previous_names:
- specifics
- abstractions
- etc
purpose:
creator: W012A3BCD
last_set: 1449709364
value: This part of the workspace is for fun. Make fun here.
topic:
creator: W012A3BCD
last_set: 1449709364
value: For public discussion of generalities
unlinked: 0
ok: true
schema:
additionalProperties: false
description: Schema for successful response conversations.info
properties:
channel:
items:
anyOf:
- additionalProperties: false
properties:
accepted_user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
connected_team_ids:
items:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
minItems: 0
type: array
uniqueItems: true
conversation_host_id:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
created:
type: integer
creator:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
display_counts:
additionalProperties: false
properties:
display_counts:
type: integer
guest_counts:
type: integer
required:
- display_counts
- guest_counts
type: object
enterprise_id:
pattern: ^[E][A-Z0-9]{8,}$
title: Enterprise ID
type: string
has_pins:
type: boolean
id:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
internal_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
is_archived:
type: boolean
is_channel:
type: boolean
is_ext_shared:
type: boolean
is_frozen:
type: boolean
is_general:
type: boolean
is_global_shared:
type: boolean
is_group:
type: boolean
is_im:
type: boolean
is_member:
type: boolean
is_moved:
type: integer
is_mpim:
enum:
- false
type: boolean
is_non_threadable:
type: boolean
is_open:
type: boolean
is_org_default:
type: boolean
is_org_mandatory:
type: boolean
is_org_shared:
type: boolean
is_pending_ext_shared:
type: boolean
is_private:
type: boolean
is_read_only:
type: boolean
is_shared:
type: boolean
is_starred:
type: boolean
is_thread_only:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest:
items:
anyOf:
- additionalProperties: false
properties:
attachments:
items:
additionalProperties: false
properties:
fallback:
type: string
id:
type: integer
image_bytes:
type: integer
image_height:
type: integer
image_url:
type: string
image_width:
type: integer
required:
- id
type: object
minItems: 1
type: array
uniqueItems: true
blocks:
description: This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace.
items:
additionalProperties: true
properties:
type:
type: string
required:
- type
type: object
title: Block Kit blocks
type: array
bot_id:
items:
anyOf:
- pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
- nullable: true
title: Nil bot_id set when display_as_bot is false
bot_profile:
additionalProperties: false
properties:
app_id:
pattern: ^A[A-Z0-9]{1,}$
title: App ID
type: string
deleted:
type: boolean
icons:
additionalProperties: false
properties:
image_36:
format: uri
type: string
image_48:
format: uri
type: string
image_72:
format: uri
type: string
required:
- image_36
- image_48
- image_72
type: object
id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
name:
type: string
team_id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
updated:
type: integer
required:
- id
- deleted
- name
- updated
- app_id
- icons
- team_id
title: Bot Profile Object
type: object
client_msg_id:
type: string
comment:
additionalProperties: false
properties:
comment:
type: string
created:
type: integer
id:
pattern: ^Fc[A-Z0-9]{8,}$
title: File Comment ID
type: string
is_intro:
type: boolean
is_starred:
type: boolean
num_stars:
type: integer
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
timestamp:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- id
- created
- timestamp
- user
- is_intro
- comment
title: File Comment Object
type: object
display_as_bot:
type: boolean
file:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
files:
items:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
minItems: 1
type: array
uniqueItems: true
icons:
additionalProperties: false
properties:
emoji:
type: string
image_64:
format: uri
type: string
type: object
inviter:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_delayed_message:
type: boolean
is_intro:
type: boolean
is_starred:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest_reply:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
name:
type: string
old_name:
type: string
parent_user_id:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
permalink:
format: uri
type: string
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
purpose:
type: string
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
reply_count:
type: integer
reply_users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 1
type: array
uniqueItems: true
reply_users_count:
type: integer
source_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
subscribed:
type: boolean
subtype:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
text:
type: string
thread_ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
topic:
type: string
ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
type:
type: string
unread_count:
type: integer
upload:
type: boolean
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
user_profile:
additionalProperties: false
properties:
avatar_hash:
type: string
display_name:
type: string
display_name_normalized:
type: string
first_name:
nullable: true
type: string
image_72:
format: uri
type: string
is_restricted:
type: boolean
is_ultra_restricted:
type: boolean
name:
type: string
real_name:
type: string
real_name_normalized:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
required:
- avatar_hash
- image_72
- first_name
- real_name
- display_name
- team
- name
- is_restricted
- is_ultra_restricted
type: object
user_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
username:
type: string
required:
- text
- type
- ts
title: Message object
type: object
- nullable: true
members:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 0
type: array
uniqueItems: true
name:
type: string
name_normalized:
type: string
num_members:
type: integer
parent_conversation:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- nullable: true
pending_connected_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
pending_shared:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
pin_count:
type: integer
previous_names:
items:
title: Name of a channel
type: string
minItems: 0
type: array
uniqueItems: true
priority:
type: number
purpose:
additionalProperties: false
properties:
creator:
pattern: ^[UW][A-Z0-9]{8,}$|^$
title: User ID or empty string, used for topic and purpose creation
type: string
last_set:
type: integer
value:
type: string
required:
- value
- creator
- last_set
type: object
shared_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
shares:
items:
additionalProperties: false
properties:
accepted_user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_active:
type: boolean
team:
additionalProperties: false
properties:
archived:
type: boolean
avatar_base_url:
format: uri
type: string
created:
type: integer
date_create:
type: integer
deleted:
type: boolean
description:
nullable: true
type: string
discoverable:
items:
anyOf:
- nullable: true
- type: string
domain:
type: string
email_domain:
type: string
enterprise_id:
pattern: ^[E][A-Z0-9]{8,}$
title: Enterprise ID
type: string
enterprise_name:
title: Name of the enterprise org
type: string
external_org_migrations:
properties:
current:
items:
properties:
date_started:
type: integer
team_id:
type: string
required:
- team_id
- date_started
type: object
type: array
date_updated:
type: integer
required:
- date_updated
- current
title: External Org Migrations
type: object
has_compliance_export:
type: boolean
icon:
properties:
image_102:
type: string
image_132:
type: string
image_230:
type: string
image_34:
type: string
image_44:
type: string
image_68:
type: string
image_88:
type: string
image_default:
type: boolean
type: object
id:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
is_assigned:
type: boolean
is_enterprise:
type: integer
is_over_storage_limit:
type: boolean
limit_ts:
type: integer
locale:
type: string
messages_count:
type: integer
msg_edit_window_mins:
type: integer
name:
type: string
over_integrations_limit:
type: boolean
over_storage_limit:
type: boolean
pay_prod_cur:
type: string
plan:
enum:
- ''
- std
- plus
- compliance
- enterprise
type: string
primary_owner:
properties:
email:
type: string
id:
type: string
required:
- id
- email
type: object
sso_provider:
properties:
label:
type: string
name:
type: string
type:
type: string
type: object
required:
- id
- name
- domain
- email_domain
- icon
title: Team Object
type: object
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- team
- user
- is_active
type: object
minItems: 0
type: array
uniqueItems: true
timezone_count:
type: integer
topic:
additionalProperties: false
properties:
creator:
pattern: ^[UW][A-Z0-9]{8,}$|^$
title: User ID or empty string, used for topic and purpose creation
type: string
last_set:
type: integer
value:
type: string
required:
- value
- creator
- last_set
type: object
unlinked:
title: Field to determine whether a channel has ever been shared/disconnected in the past
type: integer
unread_count:
type: integer
unread_count_display:
type: integer
use_case:
type: string
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
version:
type: integer
required:
- id
- name
- created
- creator
- is_archived
- is_channel
- is_general
- is_mpim
- is_group
- is_org_shared
- is_im
- is_shared
- is_private
- name_normalized
- topic
- purpose
title: Conversation object
type: object
- additionalProperties: false
properties:
accepted_user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
connected_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
conversation_host_id:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
created:
type: integer
creator:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
display_counts:
additionalProperties: false
properties:
display_counts:
type: integer
guest_counts:
type: integer
required:
- display_counts
- guest_counts
type: object
id:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
internal_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
is_archived:
type: boolean
is_channel:
type: boolean
is_ext_shared:
type: boolean
is_frozen:
type: boolean
is_general:
type: boolean
is_group:
type: boolean
is_im:
type: boolean
is_member:
type: boolean
is_moved:
type: integer
is_mpim:
enum:
- true
type: boolean
is_non_threadable:
type: boolean
is_open:
type: boolean
is_org_shared:
type: boolean
is_pending_ext_shared:
type: boolean
is_private:
type: boolean
is_read_only:
type: boolean
is_shared:
type: boolean
is_starred:
type: boolean
is_thread_only:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest:
items:
anyOf:
- additionalProperties: false
properties:
attachments:
items:
additionalProperties: false
properties:
fallback:
type: string
id:
type: integer
image_bytes:
type: integer
image_height:
type: integer
image_url:
type: string
image_width:
type: integer
required:
- id
type: object
minItems: 1
type: array
uniqueItems: true
blocks:
description: This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace.
items:
additionalProperties: true
properties:
type:
type: string
required:
- type
type: object
title: Block Kit blocks
type: array
bot_id:
items:
anyOf:
- pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
- nullable: true
title: Nil bot_id set when display_as_bot is false
bot_profile:
additionalProperties: false
properties:
app_id:
pattern: ^A[A-Z0-9]{1,}$
title: App ID
type: string
deleted:
type: boolean
icons:
additionalProperties: false
properties:
image_36:
format: uri
type: string
image_48:
format: uri
type: string
image_72:
format: uri
type: string
required:
- image_36
- image_48
- image_72
type: object
id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
name:
type: string
team_id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
updated:
type: integer
required:
- id
- deleted
- name
- updated
- app_id
- icons
- team_id
title: Bot Profile Object
type: object
client_msg_id:
type: string
comment:
additionalProperties: false
properties:
comment:
type: string
created:
type: integer
id:
pattern: ^Fc[A-Z0-9]{8,}$
title: File Comment ID
type: string
is_intro:
type: boolean
is_starred:
type: boolean
num_stars:
type: integer
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
timestamp:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- id
- created
- timestamp
- user
- is_intro
- comment
title: File Comment Object
type: object
display_as_bot:
type: boolean
file:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
files:
items:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
minItems: 1
type: array
uniqueItems: true
icons:
additionalProperties: false
properties:
emoji:
type: string
image_64:
format: uri
type: string
type: object
inviter:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_delayed_message:
type: boolean
is_intro:
type: boolean
is_starred:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest_reply:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
name:
type: string
old_name:
type: string
parent_user_id:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
permalink:
format: uri
type: string
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
purpose:
type: string
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
reply_count:
type: integer
reply_users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 1
type: array
uniqueItems: true
reply_users_count:
type: integer
source_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
subscribed:
type: boolean
subtype:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
text:
type: string
thread_ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
topic:
type: string
ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
type:
type: string
unread_count:
type: integer
upload:
type: boolean
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
user_profile:
additionalProperties: false
properties:
avatar_hash:
type: string
display_name:
type: string
display_name_normalized:
type: string
first_name:
nullable: true
type: string
image_72:
format: uri
type: string
is_restricted:
type: boolean
is_ultra_restricted:
type: boolean
name:
type: string
real_name:
type: string
real_name_normalized:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
required:
- avatar_hash
- image_72
- first_name
- real_name
- display_name
- team
- name
- is_restricted
- is_ultra_restricted
type: object
user_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
username:
type: string
required:
- text
- type
- ts
title: Message object
type: object
- nullable: true
members:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 0
type: array
uniqueItems: true
name:
type: string
name_normalized:
type: string
num_members:
type: integer
parent_conversation:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- nullable: true
pending_connected_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
pending_shared:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
pin_count:
type: integer
previous_names:
items:
title: Name of a channel
type: string
minItems: 0
type: array
uniqueItems: true
priority:
type: number
purpose:
additionalProperties: false
properties:
creator:
pattern: ^[UW][A-Z0-9]{8,}$|^$
title: User ID or empty string, used for topic and purpose creation
type: string
last_set:
type: integer
value:
type: string
required:
- value
- creator
- last_set
type: object
shared_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
shares:
items:
additionalProperties: false
properties:
accepted_user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_active:
type: boolean
team:
additionalProperties: false
properties:
archived:
type: boolean
avatar_base_url:
format: uri
type: string
created:
type: integer
date_create:
type: integer
deleted:
type: boolean
description:
nullable: true
type: string
discoverable:
items:
anyOf:
- nullable: true
- type: string
domain:
type: string
email_domain:
type: string
enterprise_id:
pattern: ^[E][A-Z0-9]{8,}$
title: Enterprise ID
type: string
enterprise_name:
title: Name of the enterprise org
type: string
external_org_migrations:
properties:
current:
items:
properties:
date_started:
type: integer
team_id:
type: string
required:
- team_id
- date_started
type: object
type: array
date_updated:
type: integer
required:
- date_updated
- current
title: External Org Migrations
type: object
has_compliance_export:
type: boolean
icon:
properties:
image_102:
type: string
image_132:
type: string
image_230:
type: string
image_34:
type: string
image_44:
type: string
image_68:
type: string
image_88:
type: string
image_default:
type: boolean
type: object
id:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
is_assigned:
type: boolean
is_enterprise:
type: integer
is_over_storage_limit:
type: boolean
limit_ts:
type: integer
locale:
type: string
messages_count:
type: integer
msg_edit_window_mins:
type: integer
name:
type: string
over_integrations_limit:
type: boolean
over_storage_limit:
type: boolean
pay_prod_cur:
type: string
plan:
enum:
- ''
- std
- plus
- compliance
- enterprise
type: string
primary_owner:
properties:
email:
type: string
id:
type: string
required:
- id
- email
type: object
sso_provider:
properties:
label:
type: string
name:
type: string
type:
type: string
type: object
required:
- id
- name
- domain
- email_domain
- icon
title: Team Object
type: object
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- team
- user
- is_active
type: object
minItems: 0
type: array
uniqueItems: true
timezone_count:
type: integer
topic:
additionalProperties: false
properties:
creator:
pattern: ^[UW][A-Z0-9]{8,}$|^$
title: User ID or empty string, used for topic and purpose creation
type: string
last_set:
type: integer
value:
type: string
required:
- value
- creator
- last_set
type: object
unlinked:
title: Field to determine whether a channel has ever been shared/disconnected in the past
type: integer
unread_count:
type: integer
unread_count_display:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
version:
type: integer
required:
- id
- name
- created
- creator
- is_archived
- is_channel
- is_general
- is_mpim
- is_group
- is_org_shared
- is_im
- is_shared
- is_private
- name_normalized
- topic
- purpose
title: Conversation MPIM Object
type: object
- additionalProperties: false
properties:
created:
type: integer
has_pins:
type: boolean
id:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
is_archived:
type: boolean
is_ext_shared:
type: boolean
is_frozen:
type: boolean
is_im:
type: boolean
is_open:
type: boolean
is_org_shared:
type: boolean
is_shared:
type: boolean
is_starred:
type: boolean
is_user_deleted:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest:
items:
anyOf:
- additionalProperties: false
properties:
attachments:
items:
additionalProperties: false
properties:
fallback:
type: string
id:
type: integer
image_bytes:
type: integer
image_height:
type: integer
image_url:
type: string
image_width:
type: integer
required:
- id
type: object
minItems: 1
type: array
uniqueItems: true
blocks:
description: This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace.
items:
additionalProperties: true
properties:
type:
type: string
required:
- type
type: object
title: Block Kit blocks
type: array
bot_id:
items:
anyOf:
- pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
- nullable: true
title: Nil bot_id set when display_as_bot is false
bot_profile:
additionalProperties: false
properties:
app_id:
pattern: ^A[A-Z0-9]{1,}$
title: App ID
type: string
deleted:
type: boolean
icons:
additionalProperties: false
properties:
image_36:
format: uri
type: string
image_48:
format: uri
type: string
image_72:
format: uri
type: string
required:
- image_36
- image_48
- image_72
type: object
id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
name:
type: string
team_id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
updated:
type: integer
required:
- id
- deleted
- name
- updated
- app_id
- icons
- team_id
title: Bot Profile Object
type: object
client_msg_id:
type: string
comment:
additionalProperties: false
properties:
comment:
type: string
created:
type: integer
id:
pattern: ^Fc[A-Z0-9]{8,}$
title: File Comment ID
type: string
is_intro:
type: boolean
is_starred:
type: boolean
num_stars:
type: integer
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
timestamp:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- id
- created
- timestamp
- user
- is_intro
- comment
title: File Comment Object
type: object
display_as_bot:
type: boolean
file:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
files:
items:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
minItems: 1
type: array
uniqueItems: true
icons:
additionalProperties: false
properties:
emoji:
type: string
image_64:
format: uri
type: string
type: object
inviter:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_delayed_message:
type: boolean
is_intro:
type: boolean
is_starred:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest_reply:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
name:
type: string
old_name:
type: string
parent_user_id:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
permalink:
format: uri
type: string
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
purpose:
type: string
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
reply_count:
type: integer
reply_users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 1
type: array
uniqueItems: true
reply_users_count:
type: integer
source_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
subscribed:
type: boolean
subtype:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
text:
type: string
thread_ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
topic:
type: string
ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
type:
type: string
unread_count:
type: integer
upload:
type: boolean
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
user_profile:
additionalProperties: false
properties:
avatar_hash:
type: string
display_name:
type: string
display_name_normalized:
type: string
first_name:
nullable: true
type: string
image_72:
format: uri
type: string
is_restricted:
type: boolean
is_ultra_restricted:
type: boolean
name:
type: string
real_name:
type: string
real_name_normalized:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
required:
- avatar_hash
- image_72
- first_name
- real_name
- display_name
- team
- name
- is_restricted
- is_ultra_restricted
type: object
user_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
username:
type: string
required:
- text
- type
- ts
title: Message object
type: object
- nullable: true
parent_conversation:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- nullable: true
pin_count:
type: integer
priority:
type: number
shares:
items:
additionalProperties: false
properties:
date_create:
type: integer
id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
is_active:
type: boolean
name:
type: string
team:
additionalProperties: false
properties:
archived:
type: boolean
avatar_base_url:
format: uri
type: string
created:
type: integer
date_create:
type: integer
deleted:
type: boolean
description:
nullable: true
type: string
discoverable:
items:
anyOf:
- nullable: true
- type: string
domain:
type: string
email_domain:
type: string
enterprise_id:
pattern: ^[E][A-Z0-9]{8,}$
title: Enterprise ID
type: string
enterprise_name:
title: Name of the enterprise org
type: string
external_org_migrations:
properties:
current:
items:
properties:
date_started:
type: integer
team_id:
type: string
required:
- team_id
- date_started
type: object
type: array
date_updated:
type: integer
required:
- date_updated
- current
title: External Org Migrations
type: object
has_compliance_export:
type: boolean
icon:
properties:
image_102:
type: string
image_132:
type: string
image_230:
type: string
image_34:
type: string
image_44:
type: string
image_68:
type: string
image_88:
type: string
image_default:
type: boolean
type: object
id:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
is_assigned:
type: boolean
is_enterprise:
type: integer
is_over_storage_limit:
type: boolean
limit_ts:
type: integer
locale:
type: string
messages_count:
type: integer
msg_edit_window_mins:
type: integer
name:
type: string
over_integrations_limit:
type: boolean
over_storage_limit:
type: boolean
pay_prod_cur:
type: string
plan:
enum:
- ''
- std
- plus
- compliance
- enterprise
type: string
primary_owner:
properties:
email:
type: string
id:
type: string
required:
- id
- email
type: object
sso_provider:
properties:
label:
type: string
name:
type: string
type:
type: string
type: object
required:
- id
- name
- domain
- email_domain
- icon
title: Team Object
type: object
required:
- id
- name
- team
- date_create
- is_active
type: object
minItems: 0
type: array
uniqueItems: true
unread_count:
type: integer
unread_count_display:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
version:
type: integer
required:
- id
- created
- is_im
- is_org_shared
- user
- priority
title: Conversation IM Channel Object from conversations.* methods
type: object
ok:
enum:
- true
title: default success response
type: boolean
required:
- ok
- channel
title: conversations.info success schema
type: object
description: Typical success response for a public channel. (Also, a response from a private channel and a multi-party IM is very similar to this example.)
default:
content:
application/json:
examples:
response:
value:
error: channel_not_found
ok: false
schema:
additionalProperties: false
description: Schema for error response from conversations.info method
properties:
callstack:
description: 'Note: PHP callstack is only visible in dev/qa'
type: string
error:
enum:
- missing_scope
- channel_not_found
- team_added_to_org
- not_authed
- invalid_auth
- account_inactive
- invalid_arg_name
- invalid_array_arg
- invalid_charset
- invalid_form_data
- invalid_post_type
- missing_post_type
- invalid_json
- json_not_object
- request_timeout
- upgrade_required
type: string
needed:
type: string
ok:
enum:
- false
title: default failure response
type: boolean
provided:
type: string
required:
- ok
- error
title: conversations.info error schema
type: object
description: Typical error response when a channel cannot be found
security:
- slackAuth:
- channels:read
- groups:read
- im:read
- mpim:read
tags:
- conversations
summary: Get conversation details
x-uuid: daa6d78e-1a4c-4a07-b245-2b6ccddbf485
/conversations.invite:
post:
description: Invite users to join a specific channel in Slack. This endpoint allows you to add new members to a conversation, expanding the participant list.
externalDocs:
description: API method documentation
url: https://api.slack.com/methods/conversations.invite
operationId: slack_web_api_conversations_invite
parameters:
- description: 'Authentication token. Requires scope: `conversations:write`'
in: header
name: token
schema:
type: string
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
channel:
description: The ID of the public or private channel to invite user(s) to.
type: string
users:
description: A comma separated list of user IDs. Up to 1000 users may be listed.
type: string
type: object
responses:
'200':
content:
application/json:
examples:
response:
value:
channel:
created: 1449252889
creator: W012A3BCD
id: C012AB3CD
is_archived: false
is_channel: true
is_ext_shared: false
is_general: true
is_group: false
is_im: false
is_member: true
is_mpim: false
is_org_shared: false
is_pending_ext_shared: false
is_private: false
is_read_only: false
is_shared: false
last_read: '1502126650.228446'
locale: en-US
name: general
name_normalized: general
num_members: 23
pending_shared: []
previous_names:
- specifics
- abstractions
- etc
purpose:
creator: W012A3BCD
last_set: 1449709364
value: This part of the workspace is for fun. Make fun here.
topic:
creator: W012A3BCD
last_set: 1449709364
value: For public discussion of generalities
unlinked: 0
ok: true
schema:
additionalProperties: false
description: Schema for successful response from conversations.invite method
properties:
channel:
items:
anyOf:
- additionalProperties: false
properties:
accepted_user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
connected_team_ids:
items:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
minItems: 0
type: array
uniqueItems: true
conversation_host_id:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
created:
type: integer
creator:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
display_counts:
additionalProperties: false
properties:
display_counts:
type: integer
guest_counts:
type: integer
required:
- display_counts
- guest_counts
type: object
enterprise_id:
pattern: ^[E][A-Z0-9]{8,}$
title: Enterprise ID
type: string
has_pins:
type: boolean
id:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
internal_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
is_archived:
type: boolean
is_channel:
type: boolean
is_ext_shared:
type: boolean
is_frozen:
type: boolean
is_general:
type: boolean
is_global_shared:
type: boolean
is_group:
type: boolean
is_im:
type: boolean
is_member:
type: boolean
is_moved:
type: integer
is_mpim:
enum:
- false
type: boolean
is_non_threadable:
type: boolean
is_open:
type: boolean
is_org_default:
type: boolean
is_org_mandatory:
type: boolean
is_org_shared:
type: boolean
is_pending_ext_shared:
type: boolean
is_private:
type: boolean
is_read_only:
type: boolean
is_shared:
type: boolean
is_starred:
type: boolean
is_thread_only:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest:
items:
anyOf:
- additionalProperties: false
properties:
attachments:
items:
additionalProperties: false
properties:
fallback:
type: string
id:
type: integer
image_bytes:
type: integer
image_height:
type: integer
image_url:
type: string
image_width:
type: integer
required:
- id
type: object
minItems: 1
type: array
uniqueItems: true
blocks:
description: This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace.
items:
additionalProperties: true
properties:
type:
type: string
required:
- type
type: object
title: Block Kit blocks
type: array
bot_id:
items:
anyOf:
- pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
- nullable: true
title: Nil bot_id set when display_as_bot is false
bot_profile:
additionalProperties: false
properties:
app_id:
pattern: ^A[A-Z0-9]{1,}$
title: App ID
type: string
deleted:
type: boolean
icons:
additionalProperties: false
properties:
image_36:
format: uri
type: string
image_48:
format: uri
type: string
image_72:
format: uri
type: string
required:
- image_36
- image_48
- image_72
type: object
id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
name:
type: string
team_id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
updated:
type: integer
required:
- id
- deleted
- name
- updated
- app_id
- icons
- team_id
title: Bot Profile Object
type: object
client_msg_id:
type: string
comment:
additionalProperties: false
properties:
comment:
type: string
created:
type: integer
id:
pattern: ^Fc[A-Z0-9]{8,}$
title: File Comment ID
type: string
is_intro:
type: boolean
is_starred:
type: boolean
num_stars:
type: integer
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
timestamp:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- id
- created
- timestamp
- user
- is_intro
- comment
title: File Comment Object
type: object
display_as_bot:
type: boolean
file:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
files:
items:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
minItems: 1
type: array
uniqueItems: true
icons:
additionalProperties: false
properties:
emoji:
type: string
image_64:
format: uri
type: string
type: object
inviter:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_delayed_message:
type: boolean
is_intro:
type: boolean
is_starred:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest_reply:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
name:
type: string
old_name:
type: string
parent_user_id:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
permalink:
format: uri
type: string
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
purpose:
type: string
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
reply_count:
type: integer
reply_users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 1
type: array
uniqueItems: true
reply_users_count:
type: integer
source_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
subscribed:
type: boolean
subtype:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
text:
type: string
thread_ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
topic:
type: string
ts:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
type:
type: string
unread_count:
type: integer
upload:
type: boolean
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
user_profile:
additionalProperties: false
properties:
avatar_hash:
type: string
display_name:
type: string
display_name_normalized:
type: string
first_name:
nullable: true
type: string
image_72:
format: uri
type: string
is_restricted:
type: boolean
is_ultra_restricted:
type: boolean
name:
type: string
real_name:
type: string
real_name_normalized:
type: string
team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
required:
- avatar_hash
- image_72
- first_name
- real_name
- display_name
- team
- name
- is_restricted
- is_ultra_restricted
type: object
user_team:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
username:
type: string
required:
- text
- type
- ts
title: Message object
type: object
- nullable: true
members:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
minItems: 0
type: array
uniqueItems: true
name:
type: string
name_normalized:
type: string
num_members:
type: integer
parent_conversation:
items:
anyOf:
- pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
- nullable: true
pending_connected_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
pending_shared:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
pin_count:
type: integer
previous_names:
items:
title: Name of a channel
type: string
minItems: 0
type: array
uniqueItems: true
priority:
type: number
purpose:
additionalProperties: false
properties:
creator:
pattern: ^[UW][A-Z0-9]{8,}$|^$
title: User ID or empty string, used for topic and purpose creation
type: string
last_set:
type: integer
value:
type: string
required:
- value
- creator
- last_set
type: object
shared_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
shares:
items:
additionalProperties: false
properties:
accepted_user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
is_active:
type: boolean
team:
additionalProperties: false
properties:
archived:
type: boolean
avatar_base_url:
format: uri
type: string
created:
type: integer
date_create:
type: integer
deleted:
type: boolean
description:
nullable: true
type: string
discoverable:
items:
anyOf:
- nullable: true
- type: string
domain:
type: string
email_domain:
type: string
enterprise_id:
pattern: ^[E][A-Z0-9]{8,}$
title: Enterprise ID
type: string
enterprise_name:
title: Name of the enterprise org
type: string
external_org_migrations:
properties:
current:
items:
properties:
date_started:
type: integer
team_id:
type: string
required:
- team_id
- date_started
type: object
type: array
date_updated:
type: integer
required:
- date_updated
- current
title: External Org Migrations
type: object
has_compliance_export:
type: boolean
icon:
properties:
image_102:
type: string
image_132:
type: string
image_230:
type: string
image_34:
type: string
image_44:
type: string
image_68:
type: string
image_88:
type: string
image_default:
type: boolean
type: object
id:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
is_assigned:
type: boolean
is_enterprise:
type: integer
is_over_storage_limit:
type: boolean
limit_ts:
type: integer
locale:
type: string
messages_count:
type: integer
msg_edit_window_mins:
type: integer
name:
type: string
over_integrations_limit:
type: boolean
over_storage_limit:
type: boolean
pay_prod_cur:
type: string
plan:
enum:
- ''
- std
- plus
- compliance
- enterprise
type: string
primary_owner:
properties:
email:
type: string
id:
type: string
required:
- id
- email
type: object
sso_provider:
properties:
label:
type: string
name:
type: string
type:
type: string
type: object
required:
- id
- name
- domain
- email_domain
- icon
title: Team Object
type: object
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- team
- user
- is_active
type: object
minItems: 0
type: array
uniqueItems: true
timezone_count:
type: integer
topic:
additionalProperties: false
properties:
creator:
pattern: ^[UW][A-Z0-9]{8,}$|^$
title: User ID or empty string, used for topic and purpose creation
type: string
last_set:
type: integer
value:
type: string
required:
- value
- creator
- last_set
type: object
unlinked:
title: Field to determine whether a channel has ever been shared/disconnected in the past
type: integer
unread_count:
type: integer
unread_count_display:
type: integer
use_case:
type: string
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
version:
type: integer
required:
- id
- name
- created
- creator
- is_archived
- is_channel
- is_general
- is_mpim
- is_group
- is_org_shared
- is_im
- is_shared
- is_private
- name_normalized
- topic
- purpose
title: Conversation object
type: object
- additionalProperties: false
properties:
accepted_user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
connected_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
conversation_host_id:
pattern: ^[TE][A-Z0-9]{8,}$
title: Team or Enterprise ID
type: string
created:
type: integer
creator:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
display_counts:
additionalProperties: false
properties:
display_counts:
type: integer
guest_counts:
type: integer
required:
- display_counts
- guest_counts
type: object
id:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
internal_team_ids:
items:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
minItems: 0
type: array
uniqueItems: true
is_archived:
type: boolean
is_channel:
type: boolean
is_ext_shared:
type: boolean
is_frozen:
type: boolean
is_general:
type: boolean
is_group:
type: boolean
is_im:
type: boolean
is_member:
type: boolean
is_moved:
type: integer
is_mpim:
enum:
- true
type: boolean
is_non_threadable:
type: boolean
is_open:
type: boolean
is_org_shared:
type: boolean
is_pending_ext_shared:
type: boolean
is_private:
type: boolean
is_read_only:
type: boolean
is_shared:
type: boolean
is_starred:
type: boolean
is_thread_only:
type: boolean
last_read:
pattern: ^\d{10}\.\d{6}$
title: Timestamp in format 0123456789.012345
type: string
latest:
items:
anyOf:
- additionalProperties: false
properties:
attachments:
items:
additionalProperties: false
properties:
fallback:
type: string
id:
type: integer
image_bytes:
type: integer
image_height:
type: integer
image_url:
type: string
image_width:
type: integer
required:
- id
type: object
minItems: 1
type: array
uniqueItems: true
blocks:
description: This is a very loose definition, in the future, we'll populate this with deeper schema in this definition namespace.
items:
additionalProperties: true
properties:
type:
type: string
required:
- type
type: object
title: Block Kit blocks
type: array
bot_id:
items:
anyOf:
- pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
- nullable: true
title: Nil bot_id set when display_as_bot is false
bot_profile:
additionalProperties: false
properties:
app_id:
pattern: ^A[A-Z0-9]{1,}$
title: App ID
type: string
deleted:
type: boolean
icons:
additionalProperties: false
properties:
image_36:
format: uri
type: string
image_48:
format: uri
type: string
image_72:
format: uri
type: string
required:
- image_36
- image_48
- image_72
type: object
id:
pattern: ^B[A-Z0-9]{8,}$
title: Bot User ID
type: string
name:
type: string
team_id:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
updated:
type: integer
required:
- id
- deleted
- name
- updated
- app_id
- icons
- team_id
title: Bot Profile Object
type: object
client_msg_id:
type: string
comment:
additionalProperties: false
properties:
comment:
type: string
created:
type: integer
id:
pattern: ^Fc[A-Z0-9]{8,}$
title: File Comment ID
type: string
is_intro:
type: boolean
is_starred:
type: boolean
num_stars:
type: integer
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
timestamp:
type: integer
user:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
required:
- id
- created
- timestamp
- user
- is_intro
- comment
title: File Comment Object
type: object
display_as_bot:
type: boolean
file:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
private:
additionalProperties: false
public:
additionalProperties: false
type: object
size:
type: integer
source_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
state:
type: string
thumb_1024:
format: uri
type: string
thumb_1024_h:
type: integer
thumb_1024_w:
type: integer
thumb_160:
format: uri
type: string
thumb_360:
format: uri
type: string
thumb_360_h:
type: integer
thumb_360_w:
type: integer
thumb_480:
format: uri
type: string
thumb_480_h:
type: integer
thumb_480_w:
type: integer
thumb_64:
format: uri
type: string
thumb_720:
format: uri
type: string
thumb_720_h:
type: integer
thumb_720_w:
type: integer
thumb_80:
format: uri
type: string
thumb_800:
format: uri
type: string
thumb_800_h:
type: integer
thumb_800_w:
type: integer
thumb_960:
format: uri
type: string
thumb_960_h:
type: integer
thumb_960_w:
type: integer
thumb_tiny:
type: string
timestamp:
type: integer
title:
type: string
updated:
type: integer
url_private:
format: uri
type: string
url_private_download:
format: uri
type: string
user:
type: string
user_team:
pattern: ^[T][A-Z0-9]{2,}$
title: Team ID
type: string
username:
type: string
title: file object
type: object
files:
items:
additionalProperties: false
properties:
channels:
items:
pattern: ^[C][A-Z0-9]{2,}$
title: Channel ID
type: string
type: array
uniqueItems: true
comments_count:
type: integer
created:
type: integer
date_delete:
type: integer
display_as_bot:
type: boolean
editable:
type: boolean
editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
external_id:
type: string
external_type:
type: string
external_url:
format: uri
type: string
filetype:
type: string
groups:
items:
pattern: ^[G][A-Z0-9]{8,}$
title: Private Channel ID
type: string
type: array
uniqueItems: true
has_rich_preview:
type: boolean
id:
pattern: ^[F][A-Z0-9]{8,}$
title: File ID
type: string
image_exif_rotation:
type: integer
ims:
items:
pattern: ^[D][A-Z0-9]{8,}$
title: Direct Message Channel ID
type: string
type: array
uniqueItems: true
is_external:
type: boolean
is_public:
type: boolean
is_starred:
type: boolean
is_tombstoned:
type: boolean
last_editor:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
mimetype:
type: string
mode:
type: string
name:
type: string
non_owner_editable:
type: boolean
num_stars:
type: integer
original_h:
type: integer
original_w:
type: integer
permalink:
format: uri
type: string
permalink_public:
format: uri
type: string
pinned_info:
additionalProperties: false
title: Info for a pinned item
type: object
pinned_to:
items:
pattern: ^[CGD][A-Z0-9]{8,}$
title: Channel-like conversation ID
type: string
type: array
pretty_type:
type: string
preview:
type: string
public_url_shared:
type: boolean
reactions:
items:
additionalProperties: true
properties:
count:
type: integer
name:
type: string
users:
items:
pattern: ^[UW][A-Z0-9]{2,}$
title: User ID
type: string
type: array
required:
- name
- users
- count
title: Reaction object
type: object
type: array
shares:
additionalProperties: false
properties:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment