openapi: 3.0.0 info: title: Slack Web API description: One way to interact with the Slack platform is its HTTP RPC-based Web API, a collection of methods requiring OAuth 2.0-based user, bot, or workspace tokens blessed with related OAuth scopes. contact: {} version: '1.0.6' servers: - url: https://slack.com/api variables: {} - url: https://slack.com/oauth variables: {} paths: /api.test: get: tags: - api summary: api_test description: Checks API calling code. externalDocs: description: API method documentation url: https://api.slack.com/methods/api.test operationId: api_test parameters: [] responses: '200': description: Standard success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/api.testsuccessschema' - description: Schema for successful response api.test method example: ok: 'true' example: ok: 'true' default: description: Artificial error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/api.testerrorschema' - description: Schema for error response api.test method example: args: error: my_error error: my_error ok: 'false' example: args: error: my_error error: my_error ok: 'false' deprecated: false security: - oauth2: - none /apps.permissions.info: get: tags: - apps.permissions - apps summary: apps_permissions_info description: Returns list of permissions this app has on a team. externalDocs: description: API method documentation url: https://api.slack.com/methods/apps.permissions.info operationId: apps_permissions_info parameters: - name: token in: query description: 'Authentication token. Requires scope: `none`' style: form explode: true schema: type: string responses: '200': description: Standard success response when used with a user token headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: 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' example: 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' default: description: Standard failure response when used with an invalid token headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - none /apps.permissions.request: get: tags: - apps.permissions - apps summary: apps_permissions_request description: Allows an app to request additional scopes externalDocs: description: API method documentation url: https://api.slack.com/methods/apps.permissions.request operationId: apps_permissions_request parameters: - name: scopes in: query description: A comma separated list of scopes to request for style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `none`' style: form explode: true schema: type: string - name: trigger_id in: query description: Token used to trigger the permissions API style: form explode: true schema: type: string responses: '200': description: Standard success response when used with a user token headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/apps.permissions.requestschema' - description: Schema for successful response from apps.permissions.request method example: ok: 'true' example: ok: 'true' default: description: Standard failure response when trigger_id is invalid headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/apps.permissions.requesterrorschema' - description: Schema for error response from apps.permissions.request method deprecated: false security: - oauth2: - none /apps.permissions.resources.list: get: tags: - apps.permissions.resources - apps summary: apps_permissions_resources_list description: Returns list of resource grants this app has on a team. externalDocs: description: API method documentation url: https://api.slack.com/methods/apps.permissions.resources.list operationId: apps_permissions_resources_list parameters: - name: cursor in: query 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. style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `none`' style: form explode: true schema: type: string - name: limit in: query description: The maximum number of items to return. style: form explode: true schema: type: integer format: int32 responses: '200': description: Typical successful paginated response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/apps.permissions.resources.listsuccessschema' - description: Schema for successful response apps.permissions.resources.list method example: ok: 'true' resources: - id: T0DES3UAN type: team - id: D024BFF1M type: app_home - id: C024BE91L type: channel response_metadata: next_cursor: dGVhbTpDMUg5UkVTR0w= example: ok: 'true' resources: - id: T0DES3UAN type: team - id: D024BFF1M type: app_home - id: C024BE91L type: channel response_metadata: next_cursor: dGVhbTpDMUg5UkVTR0w= default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/apps.permissions.resources.listerrorschema' - description: Schema for error response from apps.permissions.resources.list method example: error: invalid_cursor ok: 'false' example: error: invalid_cursor ok: 'false' deprecated: false security: - oauth2: - none /apps.permissions.scopes.list: get: tags: - apps.permissions.scopes - apps summary: apps_permissions_scopes_list description: Returns list of scopes this app has on a team. externalDocs: description: API method documentation url: https://api.slack.com/methods/apps.permissions.scopes.list operationId: apps_permissions_scopes_list parameters: - name: token in: query description: 'Authentication token. Requires scope: `none`' style: form explode: true schema: type: string responses: '200': description: Typical successful paginated response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/api.permissions.scopes.listsuccessschema' - description: Schema for successful response api.permissions.scopes.list method example: 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: [] example: 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: [] default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/apps.permissions.scopes.listerrorschema' - description: Schema for error response from apps.permissions.scopes.list method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - none /auth.revoke: get: tags: - auth summary: auth_revoke description: Revokes a token. externalDocs: description: API method documentation url: https://api.slack.com/methods/auth.revoke operationId: auth_revoke parameters: - name: test in: query description: Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked. style: form explode: true schema: type: boolean - name: token in: query description: 'Authentication token. Requires scope: `none`' style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/auth.revokeschema' - description: Schema for successful response from auth.revoke method example: ok: 'true' revoked: true example: ok: 'true' revoked: true default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/auth.revokeerrorschema' - description: Schema for error response from auth.revoke method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - none /auth.test: get: tags: - auth summary: auth_test description: Checks authentication & identity. externalDocs: description: API method documentation url: https://api.slack.com/methods/auth.test operationId: auth_test parameters: - name: token in: header description: 'Authentication token. Requires scope: `none`' style: simple schema: type: string responses: '200': description: Standard success response when used with a user token headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/auth.testsuccessschema' - description: Schema for successful response auth.test method example: ok: 'true' team: Subarachnoid Workspace team_id: T12345678 url: https://subarachnoid.slack.com/ user: grace user_id: W12345678 example: ok: 'true' team: Subarachnoid Workspace team_id: T12345678 url: https://subarachnoid.slack.com/ user: grace user_id: W12345678 default: description: Standard failure response when used with an invalid token headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/auth.testerrorschema' - description: Schema for error response auth.test method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - none /bots.info: get: tags: - bots summary: bots_info description: Gets information about a bot user. externalDocs: description: API method documentation url: https://api.slack.com/methods/bots.info operationId: bots_info parameters: - name: token in: query description: 'Authentication token. Requires scope: `users:read`' style: form explode: true schema: type: string - name: bot in: query description: Bot user to get info on style: form explode: true schema: type: string responses: '200': description: When successful, returns bot info by bot ID. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/bots.infoschema' - description: Schema for successful response from bots.info method example: bot: app_id: A061BLERW deleted: false icons: image_36: https://... image_48: https://... image_72: https://... id: B061F7JQ1 name: commandeer updated: 1449272004 ok: 'true' example: bot: app_id: A061BLERW deleted: false icons: image_36: https://... image_48: https://... image_72: https://... id: B061F7JQ1 name: commandeer updated: 1449272004 ok: 'true' default: description: When no bot can be found, it returns an error. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/bots.infoerrorschema' - description: Schema for error response from bots.info method example: error: bot_not_found ok: 'false' example: error: bot_not_found ok: 'false' deprecated: false security: - oauth2: - users:read /channels.archive: post: tags: - channels summary: channels_archive description: Archives a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.archive operationId: channels_archive parameters: - name: token in: header description: 'Authentication token. Requires scope: `channels:write`' style: simple schema: type: string requestBody: description: Channel to archive content: text/plain: schema: type: string description: Channel to archive required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.archivesuccessschema' - description: Schema for successful response from channels.archive method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.archiveerrorschema' - description: Schema for error response channels.archive method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - channels:write /channels.create: post: tags: - channels summary: channels_create description: Creates a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.create operationId: channels_create parameters: - name: token in: header description: 'Authentication token. Requires scope: `channels:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: validate: type: boolean description: Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria. name: type: string description: Name of channel to create required: false responses: '200': description: Typical success response resulting in a new channel headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.createerrorschema' - description: Schema for successful response channels.create method default: description: Example error response when an invalid name is provided headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.createerrorschema1' - description: Schema for error response channels.create method example: detail: Value passed for `name` contained unallowed special characters. error: invalid_name_specials ok: 'false' example: detail: Value passed for `name` contained unallowed special characters. error: invalid_name_specials ok: 'false' deprecated: false security: - oauth2: - channels:write /channels.history: get: tags: - channels summary: channels_history description: Fetches history of messages and events from a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.history operationId: channels_history parameters: - name: count in: query description: Number of messages to return, between 1 and 1000. style: form explode: true schema: type: integer format: int32 - name: unreads in: query description: Include `unread_count_display` in the output? style: form explode: true schema: type: boolean - name: inclusive in: query description: Include messages with latest or oldest timestamp in results. style: form explode: true schema: type: boolean - name: token in: query description: 'Authentication token. Requires scope: `channels:history`' style: form explode: true schema: type: string - name: oldest in: query description: Start of time range of messages to include in results. style: form explode: true schema: type: number format: double - name: channel in: query description: Channel to fetch history for. style: form explode: true schema: type: string - name: latest in: query description: End of time range of messages to include in results. style: form explode: true schema: type: number format: double responses: '200': description: Typical success response containing the channel's history headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.historysuccessschema' - description: Schema for successful response channels.history method default: description: Error response when the specified channel cannot be found headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.historyerrorschema' - description: Schema for error response channels.history method example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - channels:history /channels.info: get: tags: - channels summary: channels_info description: Gets information about a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.info operationId: channels_info parameters: - name: token in: query description: 'Authentication token. Requires scope: `channels:read`' style: form explode: true schema: type: string - name: include_locale in: query description: Set this to `true` to receive the locale for this channel. Defaults to `false` style: form explode: true schema: type: boolean - name: channel in: query description: Channel to get info on style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.infosuccessschema' - description: Schema for successful response channels.info method default: description: Error response when the specified channel cannot be found headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.infoerrorschema' - description: Schema for error response channels.info method example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - channels:read /channels.invite: post: tags: - channels summary: channels_invite description: Invites a user to a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.invite operationId: channels_invite parameters: - name: token in: header description: 'Authentication token. Requires scope: `channels:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: user: type: string description: User to invite to channel. channel: type: string description: Channel to invite user to. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.inviteerrorschema' - description: Schema for successful response channels.invite method default: description: A somewhat typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.inviteerrorschema1' - description: Schema for error response channels.invite method example: error: cant_invite ok: 'false' example: error: cant_invite ok: 'false' deprecated: false security: - oauth2: - channels:write /channels.join: post: tags: - channels summary: channels_join description: Joins a channel, creating it if needed. externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.join operationId: channels_join parameters: - name: token in: header description: 'Authentication token. Requires scope: `channels:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: validate: type: boolean description: Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria. name: type: string description: Name of channel to join required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.joinschema' - description: Schema for successful response from channels.join method example: already_in_channel: true channel: created: 1466025154 creator: U0G9QF9C6 id: C1H9RESGL is_archived: false is_channel: true is_general: false is_member: true is_mpim: false is_org_shared: false is_private: false is_shared: false members: - U0G9QF9C6 - U1QNSQB9U name: busting name_normalized: busting previous_names: [] purpose: creator: U0G9QF9C6 last_set: 1503435128 value: My Purpose topic: creator: U0G9QF9C6 last_set: 1503435128 value: My Topic ok: 'true' example: already_in_channel: true channel: created: 1466025154 creator: U0G9QF9C6 id: C1H9RESGL is_archived: false is_channel: true is_general: false is_member: true is_mpim: false is_org_shared: false is_private: false is_shared: false members: - U0G9QF9C6 - U1QNSQB9U name: busting name_normalized: busting previous_names: [] purpose: creator: U0G9QF9C6 last_set: 1503435128 value: My Purpose topic: creator: U0G9QF9C6 last_set: 1503435128 value: My Topic ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.joinerrorschema' - description: Schema for error response from channels.join method example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - channels:write /channels.kick: post: tags: - channels summary: channels_kick description: Removes a user from a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.kick operationId: channels_kick parameters: - name: token in: header description: 'Authentication token. Requires scope: `channels:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: user: type: string description: User to remove from channel. channel: type: string description: Channel to remove user from. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.kickschema' - description: Schema for successful response from channels.kick method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.kickerrorschema' - description: Schema for error response from channels.kick method example: error: not_in_channel ok: 'false' example: error: not_in_channel ok: 'false' deprecated: false security: - oauth2: - channels:write /channels.leave: post: tags: - channels summary: channels_leave description: Leaves a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.leave operationId: channels_leave parameters: - name: token in: header description: 'Authentication token. Requires scope: `channels:write`' style: simple schema: type: string requestBody: description: Channel to leave content: text/plain: schema: type: string description: Channel to leave required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - channels:write /channels.list: get: tags: - channels summary: channels_list description: Lists all channels in a Slack team. externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.list operationId: channels_list parameters: - name: exclude_members in: query description: Exclude the `members` collection from each `channel` style: form explode: true schema: type: boolean - name: cursor in: query 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. style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `channels:read`' style: form explode: true schema: type: string - name: limit in: query 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. style: form explode: true schema: type: integer format: int32 - name: exclude_archived in: query description: Exclude archived channels from the list style: form explode: true schema: type: boolean responses: '200': description: Typical cursored success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.listsuccessschema' - description: Schema for successful response channels.list method example: channels: - created: 1449709280 creator: U0G9QF9C6 id: C0G9QF9GW is_archived: false is_channel: true is_general: false is_member: true is_mpim: false is_org_shared: false is_private: false is_shared: false members: - U0G9QF9C6 - U0G9WFXNZ name: random name_normalized: random num_members: 2 previous_names: [] purpose: creator: '' last_set: 0 value: A place for non-work-related flimflam, faffing, hodge-podge or jibber-jabber you'd prefer to keep out of more focused work-related channels. topic: creator: U0G9QF9C6 last_set: 1449709352 value: Other stuff - created: 1449709280 creator: U0G9QF9C6 id: C0G9QKBBL is_archived: false is_channel: true is_general: true is_member: true is_mpim: false is_org_shared: false is_private: false is_shared: false members: - U0G9QF9C6 - U0G9WFXNZ name: general name_normalized: general num_members: 2 previous_names: [] purpose: creator: U0G9QF9C6 last_set: 1449709334 value: To talk about anything! topic: creator: U0G9QF9C6 last_set: 1449709364 value: Talk about anything! ok: 'true' response_metadata: next_cursor: dGVhbTpDMUg5UkVTR0w= example: channels: - created: 1449709280 creator: U0G9QF9C6 id: C0G9QF9GW is_archived: false is_channel: true is_general: false is_member: true is_mpim: false is_org_shared: false is_private: false is_shared: false members: - U0G9QF9C6 - U0G9WFXNZ name: random name_normalized: random num_members: 2 previous_names: [] purpose: creator: '' last_set: 0 value: A place for non-work-related flimflam, faffing, hodge-podge or jibber-jabber you'd prefer to keep out of more focused work-related channels. topic: creator: U0G9QF9C6 last_set: 1449709352 value: Other stuff - created: 1449709280 creator: U0G9QF9C6 id: C0G9QKBBL is_archived: false is_channel: true is_general: true is_member: true is_mpim: false is_org_shared: false is_private: false is_shared: false members: - U0G9QF9C6 - U0G9WFXNZ name: general name_normalized: general num_members: 2 previous_names: [] purpose: creator: U0G9QF9C6 last_set: 1449709334 value: To talk about anything! topic: creator: U0G9QF9C6 last_set: 1449709364 value: Talk about anything! ok: 'true' response_metadata: next_cursor: dGVhbTpDMUg5UkVTR0w= default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.listerrorschema' - description: Schema for error response channels.list method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - channels:read /channels.mark: post: tags: - channels summary: channels_mark description: Sets the read cursor in a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.mark operationId: channels_mark parameters: - name: token in: header description: 'Authentication token. Requires scope: `channels:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: ts: type: number description: Timestamp of the most recently seen message. format: double channel: type: string description: Channel to set reading cursor in. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.marksuccessschema' - description: Schema for successful response channels.mark method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.markerrorschema' - description: Schema for error response channels.mark method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - channels:write /channels.rename: post: tags: - channels summary: channels_rename description: Renames a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.rename operationId: channels_rename parameters: - name: token in: header description: 'Authentication token. Requires scope: `channels:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: validate: type: boolean description: Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria. name: type: string description: New name for channel. channel: type: string description: Channel to rename required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.renameschema' - description: Schema for successful response from channels.rename method example: channel: created: 1477445146 creator: U2U85N1RZ id: C2U875RJN is_archived: false is_channel: true is_general: false is_member: false is_mpim: false is_org_shared: false is_private: false is_shared: false members: [] name: humans-and-bots name_normalized: humans-and-bots previous_names: - humans purpose: creator: U2U85N1RZ last_set: 1509475801 value: the purpose of this channel is to bring people and robots together in harmony topic: creator: U2U85N1RZ last_set: 1509475775 value: here be robots unlinked: 0 ok: 'true' example: channel: created: 1477445146 creator: U2U85N1RZ id: C2U875RJN is_archived: false is_channel: true is_general: false is_member: false is_mpim: false is_org_shared: false is_private: false is_shared: false members: [] name: humans-and-bots name_normalized: humans-and-bots previous_names: - humans purpose: creator: U2U85N1RZ last_set: 1509475801 value: the purpose of this channel is to bring people and robots together in harmony topic: creator: U2U85N1RZ last_set: 1509475775 value: here be robots unlinked: 0 ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.renameerrorschema' - description: Schema for error response from channels.rename method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - channels:write /channels.replies: get: tags: - channels summary: channels_replies description: Retrieve a thread of messages posted to a channel externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.replies operationId: channels_replies parameters: - name: thread_ts in: query description: Unique identifier of a thread's parent message style: form explode: true schema: type: number format: double - name: token in: query description: 'Authentication token. Requires scope: `channels:history`' style: form explode: true schema: type: string - name: channel in: query description: Channel to fetch thread from style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: has_more: false messages: - last_read: '1509484885.000082' replies: - ts: '1509484424.000601' user: U2U85N1RZ - ts: '1509484885.000082' user: U2U85N1RZ reply_count: 2 subscribed: true text: This is a channel message thread_ts: '1485913694.000025' ts: '1485913694.000025' type: message unread_count: 0 user: U2X9P5FEL - parent_user_id: U2X9P5FEL text: This is a thread reply thread_ts: '1485913694.000025' ts: '1509484424.000601' type: message user: U2U85N1RZ - parent_user_id: U2X9P5FEL text: This is another thread reply thread_ts: '1485913694.000025' ts: '1509484885.000082' type: message user: U2U85N1RZ ok: 'true' example: has_more: false messages: - last_read: '1509484885.000082' replies: - ts: '1509484424.000601' user: U2U85N1RZ - ts: '1509484885.000082' user: U2U85N1RZ reply_count: 2 subscribed: true text: This is a channel message thread_ts: '1485913694.000025' ts: '1485913694.000025' type: message unread_count: 0 user: U2X9P5FEL - parent_user_id: U2X9P5FEL text: This is a thread reply thread_ts: '1485913694.000025' ts: '1509484424.000601' type: message user: U2U85N1RZ - parent_user_id: U2X9P5FEL text: This is another thread reply thread_ts: '1485913694.000025' ts: '1509484885.000082' type: message user: U2U85N1RZ ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: thread_not_found ok: 'false' example: error: thread_not_found ok: 'false' deprecated: false security: - oauth2: - channels:history /channels.setPurpose: post: tags: - channels summary: channels_setPurpose description: Sets the purpose for a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.setPurpose operationId: channels_setPurpose parameters: - name: token in: header description: 'Authentication token. Requires scope: `channels:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: purpose: type: string description: The new purpose channel: type: string description: Channel to set the purpose of required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.setPurposeschema' - description: Schema for successful response from channels.setPurpose method example: ok: 'true' purpose: My special purpose example: ok: 'true' purpose: My special purpose default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/channels.setPurposeerrorschema' - description: Schema for error response from channels.setPurpose method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - channels:write /channels.setTopic: post: tags: - channels summary: channels_setTopic description: Sets the topic for a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.setTopic operationId: channels_setTopic parameters: - name: token in: header description: 'Authentication token. Requires scope: `channels:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: topic: type: string description: The new topic channel: type: string description: Channel to set the topic of required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' topic: To picture topicality example: ok: 'true' topic: To picture topicality default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - channels:write /channels.unarchive: post: tags: - channels summary: channels_unarchive description: Unarchives a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/channels.unarchive operationId: channels_unarchive parameters: - name: token in: header description: 'Authentication token. Requires scope: `channels:write`' style: simple schema: type: string requestBody: description: Channel to unarchive content: text/plain: schema: type: string description: Channel to unarchive required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - channels:write /chat.delete: post: tags: - chat summary: chat_delete description: Deletes a message. externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.delete operationId: chat_delete parameters: - name: token in: header description: 'Authentication token. Requires scope: `chat:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: as_user: type: boolean 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. ts: type: number description: Timestamp of the message to be deleted. format: double channel: type: string description: Channel containing the message to be deleted. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/chat.deletesuccessschema' - description: Schema for successful response of chat.delete method example: channel: C024BE91L ok: 'true' ts: '1401383885.000061' example: channel: C024BE91L ok: 'true' ts: '1401383885.000061' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/chat.deleteerrorschema' - description: Schema for error response from chat.delete method example: error: message_not_found ok: 'false' example: error: message_not_found ok: 'false' deprecated: false security: - oauth2: - chat:write:user - chat:write:bot /chat.getPermalink: get: tags: - chat summary: chat_getPermalink description: Retrieve a permalink URL for a specific extant message externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.getPermalink operationId: chat_getPermalink parameters: - name: token in: query description: 'Authentication token. Requires scope: `none`' style: form explode: true schema: type: string - name: message_ts in: query description: A message's `ts` value, uniquely identifying it within a channel style: form explode: true schema: type: number format: double - name: channel in: query description: The ID of the conversation or channel containing the message style: form explode: true schema: type: string responses: '200': description: Standard success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/chat.getPermalinksuccessschema' - description: Schema for successful response chat.getPermalink example: channel: C1H9RESGA ok: 'true' permalink: https://ghostbusters.slack.com/archives/C1H9RESGA/p135854651500008 example: channel: C1H9RESGA ok: 'true' permalink: https://ghostbusters.slack.com/archives/C1H9RESGA/p135854651500008 default: description: Error response when channel cannot be found headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/chat.getPermalinkerrorschema' - description: Schema for error response from chat.getPermalink method example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - none /chat.meMessage: post: tags: - chat summary: chat_meMessage description: Share a me message into a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.meMessage operationId: chat_meMessage parameters: - name: token in: header description: 'Authentication token. Requires scope: `chat:write:user`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: text: type: string description: Text of the message to send. channel: type: string description: Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: channel: C024BE7LR ok: 'true' ts: '1417671948.000006' example: channel: C024BE7LR ok: 'true' ts: '1417671948.000006' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - chat:write:user /chat.postEphemeral: post: tags: - chat summary: chat_postEphemeral description: Sends an ephemeral message to a user in a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.postEphemeral operationId: chat_postEphemeral parameters: - name: token in: header description: 'Authentication token. Requires scope: `chat:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: attachments: type: string description: A JSON-based array of structured attachments, presented as a URL-encoded string. text: type: string description: Text of the message to send. See below for an explanation of [formatting](#formatting). This field is usually required, unless you're providing only `attachments` instead. link_names: type: boolean description: Find and link channel names and usernames. parse: type: string description: Change how messages are treated. Defaults to `none`. See [below](#formatting). user: type: string description: '`id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument.' as_user: type: boolean description: Pass true to post the message as the authed bot. Defaults to false. channel: type: string description: Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/chat.postEphemeralsuccessschema' - description: Schema for successful response from chat.postEphemeral method example: message_ts: '1502210682.580145' ok: 'true' example: message_ts: '1502210682.580145' ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/chat.postEphemeralerrorschema' - description: Schema for error response from chat.postEphemeral method example: error: user_not_in_channel ok: 'false' example: error: user_not_in_channel ok: 'false' deprecated: false security: - oauth2: - chat:write:user - chat:write:bot /chat.postMessage: post: tags: - chat summary: chat_postMessage description: Sends a message to a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.postMessage operationId: chat_postMessage parameters: - name: token in: header description: 'Authentication token. Requires scope: `chat:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: username: type: string description: Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below. thread_ts: type: number description: Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead. format: double attachments: type: string description: A JSON-based array of structured attachments, presented as a URL-encoded string. unfurl_links: type: boolean description: Pass true to enable unfurling of primarily text-based content. text: type: string description: Text of the message to send. See below for an explanation of [formatting](#formatting). This field is usually required, unless you're providing only `attachments` instead. Provide no more than 40,000 characters or [risk truncation](/changelog/2018-04-truncating-really-long-messages). unfurl_media: type: boolean description: Pass false to disable unfurling of media content. parse: type: string description: Change how messages are treated. Defaults to `none`. See [below](#formatting). as_user: type: boolean description: Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below. mrkdwn: type: boolean description: Disable Slack markup parsing by setting to `false`. Enabled by default. icon_emoji: type: string 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. link_names: type: boolean description: Find and link channel names and usernames. icon_url: type: string 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. channel: type: string 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. reply_broadcast: type: boolean 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`. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/chat.postMessagesuccessschema' - description: Schema for successful response of chat.postMessage method default: description: Typical error response if too many attachments are included headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/chat.postMessageerrorschema' - description: Schema for error response chat.postMessage method example: error: too_many_attachments ok: 'false' example: error: too_many_attachments ok: 'false' deprecated: false security: - oauth2: - chat:write:user - chat:write:bot /chat.unfurl: post: tags: - chat summary: chat_unfurl description: Provide custom unfurl behavior for user-posted URLs externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.unfurl operationId: chat_unfurl parameters: - name: token in: header description: 'Authentication token. Requires scope: `links:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: user_auth_message: type: string 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 user_auth_required: type: boolean description: Set to `true` or `1` to indicate the user must install your Slack app to trigger unfurls for this domain unfurls: type: string description: URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl message attachments. ts: type: string description: Timestamp of the message to add unfurl behavior to. user_auth_url: type: string 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. channel: type: string description: Channel ID of the message required: false responses: '200': description: Typical, minimal success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/chat.unfurlsuccessschema' - description: Schema for successful response from chat.unfurl method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/chat.unfurlerrorschema' - description: Schema for error response from chat.unfurl method example: error: cannot_unfurl_url ok: 'false' example: error: cannot_unfurl_url ok: 'false' deprecated: false security: - oauth2: - links:write /chat.update: post: tags: - chat summary: chat_update description: Updates a message. externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.update operationId: chat_update parameters: - name: token in: header description: 'Authentication token. Requires scope: `chat:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: attachments: type: string description: A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting `text`. text: type: string description: New text for the message, using the [default formatting rules](/docs/formatting). It's not required when presenting `attachments`. ts: type: number description: Timestamp of the message to be updated. format: double parse: type: string description: Change how messages are treated. Defaults to `client`, unlike `chat.postMessage`. See [below](#formatting). as_user: type: boolean description: Pass true to update the message as the authed user. [Bot users](/bot-users) in this context are considered authed users. link_names: type: boolean description: Find and link channel names and usernames. Defaults to `none`. See [below](#formatting). channel: type: string description: Channel containing the message to be updated. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/chat.updatesuccessschema' - description: Schema for successful response of chat.update method example: channel: C024BE91L ok: 'true' text: Updated text you carefully authored ts: '1401383885.000061' example: channel: C024BE91L ok: 'true' text: Updated text you carefully authored ts: '1401383885.000061' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/chat.updateerrorschema' - description: Schema for error response chat.update method example: error: cant_update_message ok: 'false' example: error: cant_update_message ok: 'false' deprecated: false security: - oauth2: - chat:write:user - chat:write:bot /conversations.archive: post: tags: - conversations summary: conversations_archive description: Archives a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.archive operationId: conversations_archive parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' style: simple schema: type: string requestBody: description: ID of conversation to archive content: text/plain: schema: type: string description: ID of conversation to archive required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.archivesuccessschema' - description: Schema for successful response conversations.archive method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.archiveerrorschema' - description: Schema for error response from conversations.archive method example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - channels:write - groups:write - im:write - mpim:write /conversations.close: post: tags: - conversations summary: conversations_close description: Closes a direct message or multi-person direct message. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.close operationId: conversations_close parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' style: simple schema: type: string requestBody: description: Conversation to close. content: text/plain: schema: type: string description: Conversation to close. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.closesuccessschema' - description: Schema for successful response conversations.close method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.closeerrorschema' - description: Schema for error response from conversations.close method example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - channels:write - groups:write - im:write - mpim:write /conversations.create: post: tags: - conversations summary: conversations_create description: Initiates a public or private channel-based conversation externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.create operationId: conversations_create parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: name: type: string description: Name of the public or private channel to create is_private: type: boolean description: Create a private channel instead of a public one required: false responses: '200': description: If successful, the command returns a rather stark [conversation object](/types/conversation) headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.createsuccessschema' - description: Schema for successful response conversations.create method default: description: Typical error response when name already in use headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.createerrorschema' - description: Schema for error response from conversations.create method example: error: name_taken ok: 'false' example: error: name_taken ok: 'false' deprecated: false security: - oauth2: - channels:write - groups:write - im:write - mpim:write /conversations.history: get: tags: - conversations summary: conversations_history description: Fetches a conversation's history of messages and events. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.history operationId: conversations_history parameters: - name: inclusive in: query description: Include messages with latest or oldest timestamp in results only when either timestamp is specified. style: form explode: true schema: type: boolean - name: cursor in: query 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. style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `conversations:history`' style: form explode: true schema: type: string - name: limit in: query 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. style: form explode: true schema: type: integer format: int32 - name: oldest in: query description: Start of time range of messages to include in results. style: form explode: true schema: type: number format: double - name: channel in: query description: Conversation ID to fetch history for. style: form explode: true schema: type: string - name: latest in: query description: End of time range of messages to include in results. style: form explode: true schema: type: number format: double responses: '200': description: Typical success response containing a channel's messages headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.historysuccessschema' - description: Schema for successful response from conversations.history method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.historyerrorschema' - description: Schema for error response from conversations.history method example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - channels:history - groups:history - im:history - mpim:history /conversations.info: get: tags: - conversations summary: conversations_info description: Retrieve information about a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.info operationId: conversations_info parameters: - name: token in: query description: 'Authentication token. Requires scope: `conversations:read`' style: form explode: true schema: type: string - name: channel in: query description: Conversation ID to learn more about style: form explode: true schema: type: string - name: include_locale in: query description: Set this to `true` to receive the locale for this conversation. Defaults to `false` style: form explode: true schema: type: boolean responses: '200': 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.) headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.infosuccessschema' - description: Schema for successful response conversations.info default: description: Typical error response when a channel cannot be found headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.infoerrorschema' - description: Schema for error response from conversations.info method example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - channels:read - groups:read - im:read - mpim:read /conversations.invite: post: tags: - conversations summary: conversations_invite description: Invites users to a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.invite operationId: conversations_invite parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: users: type: string description: A comma separated list of user IDs. Up to 30 users may be listed. channel: type: string description: The ID of the public or private channel to invite user(s) to. required: false responses: '200': description: Typical success response when an invitation is extended headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.inviteerrorschema' - description: Schema for successful response from conversations.invite method default: description: Typical error response when an invite is attempted on a conversation type that does not support it headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.inviteerrorschema1' - description: Schema for error response from conversations.invite method example: error: method_not_supported_for_channel_type ok: 'false' example: error: method_not_supported_for_channel_type ok: 'false' deprecated: false security: - oauth2: - channels:write - groups:write - im:write - mpim:write /conversations.join: post: tags: - conversations summary: conversations_join description: Joins an existing conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.join operationId: conversations_join parameters: - name: token in: header description: 'Authentication token. Requires scope: `channels:write`' style: simple schema: type: string requestBody: description: ID of conversation to join content: text/plain: schema: type: string description: ID of conversation to join required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.joinsuccessschema' - description: Schema for successful response from conversations.join method default: description: Typical error response if the conversation is archived and cannot be joined headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.joinerrorschema' - description: Schema for error response from conversations.join method example: error: is_archived ok: 'false' example: error: is_archived ok: 'false' deprecated: false security: - oauth2: - channels:write /conversations.kick: post: tags: - conversations summary: conversations_kick description: Removes a user from a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.kick operationId: conversations_kick parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: user: type: string description: User ID to be removed. channel: type: string description: ID of conversation to remove user from. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.kicksuccessschema' - description: Schema for successful response conversations.kick method example: ok: 'true' example: ok: 'true' default: description: Typical error response when you attempt to kick yourself from a channel headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.kickerrorschema' - description: Schema for error response conversations.kick method example: error: cant_kick_self ok: 'false' example: error: cant_kick_self ok: 'false' deprecated: false security: - oauth2: - channels:write - groups:write - im:write - mpim:write /conversations.leave: post: tags: - conversations summary: conversations_leave description: Leaves a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.leave operationId: conversations_leave parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' style: simple schema: type: string requestBody: description: Conversation to leave content: text/plain: schema: type: string description: Conversation to leave required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.leavesuccessschema' - description: Schema for successful response from conversations.leave method example: ok: 'true' example: ok: 'true' default: description: Typical error response when attempting to leave a workspace's "general" channel headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.leaveerrorschema' - description: Schema for error response from conversations.leave method example: error: cant_leave_general ok: 'false' example: error: cant_leave_general ok: 'false' deprecated: false security: - oauth2: - channels:write - groups:write - im:write - mpim:write /conversations.list: get: tags: - conversations summary: conversations_list description: Lists all channels in a Slack team. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.list operationId: conversations_list parameters: - name: cursor in: query 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. style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `conversations:read`' style: form explode: true schema: type: string - name: limit in: query description: The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000. style: form explode: true schema: type: integer format: int32 - name: exclude_archived in: query description: Set to `true` to exclude archived channels from the list style: form explode: true schema: type: boolean - name: types in: query description: Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im` style: form explode: true schema: type: string responses: '200': description: Typical success response with only public channels headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.listsuccessschema' - description: Schema for successful response from conversations.list method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.listerrorschema' - description: Schema for error response from conversations.list method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - channels:read - groups:read - im:read - mpim:read /conversations.members: get: tags: - conversations summary: conversations_members description: Retrieve members of a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.members operationId: conversations_members parameters: - name: cursor in: query 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. style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `conversations:read`' style: form explode: true schema: type: string - name: limit in: query 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. style: form explode: true schema: type: integer format: int32 - name: channel in: query description: ID of the conversation to retrieve members for style: form explode: true schema: type: string responses: '200': description: Typical paginated success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.memberssuccessschema' - description: Schema for successful response conversations.members method example: members: - U023BECGF - U061F7AUR - W012A3CDE ok: 'true' response_metadata: next_cursor: e3VzZXJfaWQ6IFcxMjM0NTY3fQ== example: members: - U023BECGF - U061F7AUR - W012A3CDE ok: 'true' response_metadata: next_cursor: e3VzZXJfaWQ6IFcxMjM0NTY3fQ== default: description: Typical error response when an invalid cursor is provided headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.memberserrorschema' - description: Schema for error response conversations.members method example: error: invalid_cursor ok: 'false' example: error: invalid_cursor ok: 'false' deprecated: false security: - oauth2: - channels:read - groups:read - im:read - mpim:read /conversations.open: post: tags: - conversations summary: conversations_open description: Opens or resumes a direct message or multi-person direct message. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.open operationId: conversations_open parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: return_im: type: boolean description: Boolean, indicates you want the full IM channel definition in the response. users: type: string description: Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a `channel` when not supplying `users`. channel: type: string description: Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.opensuccessschema' - description: Schema for successful response from conversations.open method when opening channels, ims, mpims default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.openerrorschema' - description: Schema for error response from conversations.open method example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - channels:write - groups:write - im:write - mpim:write /conversations.rename: post: tags: - conversations summary: conversations_rename description: Renames a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.rename operationId: conversations_rename parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: name: type: string description: New name for conversation. channel: type: string description: ID of conversation to rename required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.renamesuccessschema' - description: Schema for successful response from conversations.rename method default: description: Typical error response when the calling user is not a member of the conversation headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.renameerrorschema' - description: Schema for error response from conversations.rename method example: error: not_in_channel ok: 'false' example: error: not_in_channel ok: 'false' deprecated: false security: - oauth2: - channels:write - groups:write - im:write - mpim:write /conversations.replies: get: tags: - conversations summary: conversations_replies description: Retrieve a thread of messages posted to a conversation externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.replies operationId: conversations_replies parameters: - name: inclusive in: query description: Include messages with latest or oldest timestamp in results only when either timestamp is specified. style: form explode: true schema: type: boolean - name: ts in: query description: Unique identifier of a thread's parent message. style: form explode: true schema: type: number format: double - name: cursor in: query 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. style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `conversations:history`' style: form explode: true schema: type: string - name: limit in: query 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. style: form explode: true schema: type: integer format: int32 - name: oldest in: query description: Start of time range of messages to include in results. style: form explode: true schema: type: number format: double - name: channel in: query description: Conversation ID to fetch thread from. style: form explode: true schema: type: string - name: latest in: query description: End of time range of messages to include in results. style: form explode: true schema: type: number format: double responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.repliessuccessschema' - description: Schema for successful response from conversations.replies method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.replieserrorschema' - description: Schema for error response from conversations.replies method example: error: thread_not_found ok: 'false' example: error: thread_not_found ok: 'false' deprecated: false security: - oauth2: - channels:history - groups:history - im:history - mpim:history /conversations.setPurpose: post: tags: - conversations summary: conversations_setPurpose description: Sets the purpose for a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.setPurpose operationId: conversations_setPurpose parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: purpose: type: string description: A new, specialer purpose channel: type: string description: Conversation to set the purpose of required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.setPurposesuccessschema' - description: Schema for successful response from conversations.setPurpose method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.setPurposeerrorschema' - description: Schema for error response from conversations.setPurpose method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - channels:write - groups:write - im:write - mpim:write /conversations.setTopic: post: tags: - conversations summary: conversations_setTopic description: Sets the topic for a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.setTopic operationId: conversations_setTopic parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: topic: type: string description: The new topic string. Does not support formatting or linkification. channel: type: string description: Conversation to set the topic of required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.setTopicsuccessschema' - description: Schema for successful response from conversations.setTopic method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.setTopicerrorschema' - description: Schema for error response from conversations.setTopic method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - channels:write - groups:write - im:write - mpim:write /conversations.unarchive: post: tags: - conversations summary: conversations_unarchive description: Reverses conversation archival. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.unarchive operationId: conversations_unarchive parameters: - name: token in: header description: 'Authentication token. Requires scope: `conversations:write`' style: simple schema: type: string requestBody: description: ID of conversation to unarchive content: text/plain: schema: type: string description: ID of conversation to unarchive required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.unarchivesuccessschema' - description: Schema for successful response from conversations.unarchive method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/conversations.unarchiveerrorschema' - description: Schema for error response from conversations.unarchive method example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - channels:write - groups:write - im:write - mpim:write /dialog.open: get: tags: - dialog summary: dialog_open description: Open a dialog with a user externalDocs: description: API method documentation url: https://api.slack.com/methods/dialog.open operationId: dialog_open parameters: - name: token in: header description: 'Authentication token. Requires scope: `none`' style: simple schema: type: string - name: dialog in: query description: The dialog definition. This must be a JSON-encoded string. style: form explode: true schema: type: string - name: trigger_id in: query description: Exchange a trigger to post to the user. style: form explode: true schema: type: string responses: '200': description: Typical success response is quite minimal. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response, before getting to any possible validation errors. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: missing_trigger ok: 'false' example: error: missing_trigger ok: 'false' deprecated: false security: - oauth2: - none /dnd.endDnd: post: tags: - dnd summary: dnd_endDnd description: Ends the current user's Do Not Disturb session immediately. externalDocs: description: API method documentation url: https://api.slack.com/methods/dnd.endDnd operationId: dnd_endDnd parameters: - name: token in: header description: 'Authentication token. Requires scope: `dnd:write`' style: simple schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - dnd:write /dnd.endSnooze: post: tags: - dnd summary: dnd_endSnooze description: Ends the current user's snooze mode immediately. externalDocs: description: API method documentation url: https://api.slack.com/methods/dnd.endSnooze operationId: dnd_endSnooze parameters: - name: token in: header description: 'Authentication token. Requires scope: `dnd:write`' style: simple schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - dnd:write /dnd.info: get: tags: - dnd summary: dnd_info description: Retrieves a user's current Do Not Disturb status. externalDocs: description: API method documentation url: https://api.slack.com/methods/dnd.info operationId: dnd_info parameters: - name: token in: query description: 'Authentication token. Requires scope: `dnd:read`' style: form explode: true schema: type: string - name: user in: query description: User to fetch status for (defaults to current user) style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - dnd:read /dnd.setSnooze: post: tags: - dnd summary: dnd_setSnooze description: Turns on Do Not Disturb mode for the current user, or changes its duration. externalDocs: description: API method documentation url: https://api.slack.com/methods/dnd.setSnooze operationId: dnd_setSnooze parameters: - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: num_minutes: type: integer description: Number of minutes, from now, to snooze until. format: int32 token: type: string description: 'Authentication token. Requires scope: `dnd:write`' required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - dnd:write /dnd.teamInfo: get: tags: - dnd summary: dnd_teamInfo description: Retrieves the Do Not Disturb status for users on a team. externalDocs: description: API method documentation url: https://api.slack.com/methods/dnd.teamInfo operationId: dnd_teamInfo parameters: - name: token in: query description: 'Authentication token. Requires scope: `dnd:read`' style: form explode: true schema: type: string - name: users in: query description: Comma-separated list of users to fetch Do Not Disturb status for style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/dnd.teamInfosuccessschema' - description: Schema for successful response from dnd.teamInfo method example: ok: 'true' users: U023BECGF: dnd_enabled: true next_dnd_end_ts: 1450423800 next_dnd_start_ts: 1450387800 W058CJVAA: dnd_enabled: false next_dnd_end_ts: 1 next_dnd_start_ts: 1 example: ok: 'true' users: U023BECGF: dnd_enabled: true next_dnd_end_ts: 1450423800 next_dnd_start_ts: 1450387800 W058CJVAA: dnd_enabled: false next_dnd_end_ts: 1 next_dnd_start_ts: 1 default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/dnd.teamInfoerrorschema' - description: Schema for error response from dnd.teamInfo method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - dnd:read /emoji.list: get: tags: - emoji summary: emoji_list description: Lists custom emoji for a team. externalDocs: description: API method documentation url: https://api.slack.com/methods/emoji.list operationId: emoji_list parameters: - name: token in: query description: 'Authentication token. Requires scope: `emoji:read`' style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - emoji:read /files.comments.add: post: tags: - files.comments - files summary: files_comments_add description: Add a comment to an existing file. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.comments.add operationId: files_comments_add parameters: - name: token in: header description: 'Authentication token. Requires scope: `files:write:user`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: comment: type: string description: Text of the comment to add. file: type: string description: File to add a comment to. required: false responses: '200': description: Standard success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/files.comments.addschema' - description: Schema for successful response files.comments.add method default: description: Artificial error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/files.comments.adderrorschema' - description: Schema for error response from files.comments.add method example: error: file_not_found ok: 'false' example: error: file_not_found ok: 'false' deprecated: false security: - oauth2: - files:write:user /files.comments.delete: post: tags: - files.comments - files summary: files_comments_delete description: Deletes an existing comment on a file. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.comments.delete operationId: files_comments_delete parameters: - name: token in: header description: 'Authentication token. Requires scope: `files:write:user`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: id: type: string description: The comment to delete. file: type: string description: File to delete a comment from. required: false responses: '200': description: Standard success response is very simple headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/files.comments.deleteschema' - description: Schema for successful response files.comments.delete method example: ok: 'true' example: ok: 'true' default: description: Standard failure response when used with an invalid token headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/files.comments.deleteerrorschema' - description: Schema for error response files.comments.delete method deprecated: false security: - oauth2: - files:write:user /files.comments.edit: post: tags: - files.comments - files summary: files_comments_edit description: Edit an existing file comment. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.comments.edit operationId: files_comments_edit parameters: - name: token in: header description: 'Authentication token. Requires scope: `files:write:user`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: comment: type: string description: Text of the comment to edit. id: type: string description: The comment to edit. file: type: string description: File containing the comment to edit. required: false responses: '200': description: Standard success response when used with a user token headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/files.comments.editschema' - description: Schema for successful response files.comments.edit method default: description: Standard failure response when used with an invalid token headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/files.comments.editerrorschema' - description: Schema for error response files.comments.edit method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - files:write:user /files.delete: post: tags: - files summary: files_delete description: Deletes a file. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.delete operationId: files_delete parameters: - name: token in: header description: 'Authentication token. Requires scope: `files:write:user`' style: simple schema: type: string requestBody: description: ID of file to delete. content: text/plain: schema: type: string description: ID of file to delete. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/files.deleteschema' - description: Schema for successful response files.delete method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/files.deleteerrorschema' - description: Schema for error response files.delete method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - files:write:user /files.info: get: tags: - files summary: files_info description: Gets information about a team file. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.info operationId: files_info parameters: - name: count in: query description: '' style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `files:read`' style: form explode: true schema: type: string - name: file in: query description: Specify a file by providing its ID. style: form explode: true schema: type: string - name: page in: query description: '' style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/files.infoschema' - description: Schema for successful response from files.info method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/files.infoerrorschema' - description: Schema for error response from files.info method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - files:read /files.list: get: tags: - files summary: files_list description: Lists & filters team files. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.list operationId: files_list parameters: - name: count in: query description: '' style: form explode: true schema: type: string - name: channel in: query description: Filter files appearing in a specific channel, indicated by its ID. style: form explode: true schema: type: string - name: ts_to in: query description: Filter files created before this timestamp (inclusive). style: form explode: true schema: type: number format: double - name: ts_from in: query description: Filter files created after this timestamp (inclusive). style: form explode: true schema: type: number format: double - name: token in: query description: 'Authentication token. Requires scope: `files:read`' style: form explode: true schema: type: string - name: user in: query description: Filter files created by a single user. style: form explode: true schema: type: string - name: page in: query description: '' style: form explode: true schema: type: string - name: types in: query description: >- Filter files by type: * `all` - All files * `spaces` - Posts * `snippets` - Snippets * `images` - Image files * `gdocs` - Google docs * `zips` - Zip files * `pdfs` - PDF files You can pass multiple values in the types argument, like `types=spaces,snippets`.The default value is `all`, which does not filter the list. style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/files.listschema' - description: Schema for successful response from files.list method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/files.listerrorschema' - description: Schema for error response from files.list method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - files:read /files.revokePublicURL: post: tags: - files summary: files_revokePublicURL description: Revokes public/external sharing access for a file externalDocs: description: API method documentation url: https://api.slack.com/methods/files.revokePublicURL operationId: files_revokePublicURL parameters: - name: token in: header description: 'Authentication token. Requires scope: `files:write:user`' style: simple schema: type: string requestBody: description: File to revoke content: text/plain: schema: type: string description: File to revoke required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - files:write:user /files.sharedPublicURL: post: tags: - files summary: files_sharedPublicURL description: Enables a file for public/external sharing. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.sharedPublicURL operationId: files_sharedPublicURL parameters: - name: token in: header description: 'Authentication token. Requires scope: `files:write:user`' style: simple schema: type: string requestBody: description: File to share content: text/plain: schema: type: string description: File to share required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - files:write:user /files.upload: post: tags: - files summary: files_upload description: Uploads or creates a file. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.upload operationId: files_upload parameters: - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: channels: type: string description: Comma-separated list of channel names or IDs where the file will be shared. title: type: string description: Title of file. initial_comment: type: string description: Initial comment to add to file. filetype: type: string description: A [file type](/types/file#file_types) identifier. filename: type: string description: Filename of file. content: type: string description: File contents via a POST variable. If omitting this parameter, you must provide a `file`. token: type: string description: 'Authentication token. Requires scope: `files:write:user`' file: type: string description: File contents via `multipart/form-data`. If omitting this parameter, you must submit `content`. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/files.uploadschema' - description: Schema for successful response files.upload method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/files.uploaderrorschema' - description: Schema for error response files.upload method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - files:write:user /groups.archive: post: tags: - groups summary: groups_archive description: Archives a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.archive operationId: groups_archive parameters: - name: token in: header description: 'Authentication token. Requires scope: `groups:write`' style: simple schema: type: string requestBody: description: Private channel to archive content: text/plain: schema: type: string description: Private channel to archive required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.archiveschema' - description: Schema for successful response from groups.archive method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.archiveerrorschema' - description: Schema for error response from groups.archive method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - groups:write /groups.create: post: tags: - groups summary: groups_create description: Creates a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.create operationId: groups_create parameters: - name: token in: header description: 'Authentication token. Requires scope: `groups:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: validate: type: boolean description: Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria. name: type: string description: Name of private channel to create required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.createsuccessschema' - description: Schema for successful response groups.create method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.createerrorschema' - description: Schema for error response groups.create method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - groups:write /groups.createChild: post: tags: - groups summary: groups_createChild description: Clones and archives a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.createChild operationId: groups_createChild parameters: - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: token: type: string description: 'Authentication token. Requires scope: `groups:write`' channel: type: string description: Private channel to clone and archive. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - groups:write /groups.history: get: tags: - groups summary: groups_history description: Fetches history of messages and events from a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.history operationId: groups_history parameters: - name: count in: query description: Number of messages to return, between 1 and 1000. style: form explode: true schema: type: integer format: int32 - name: unreads in: query description: Include `unread_count_display` in the output? style: form explode: true schema: type: boolean - name: inclusive in: query description: Include messages with latest or oldest timestamp in results. style: form explode: true schema: type: boolean - name: token in: query description: 'Authentication token. Requires scope: `groups:history`' style: form explode: true schema: type: string - name: oldest in: query description: Start of time range of messages to include in results. style: form explode: true schema: type: number format: double - name: channel in: query description: Private channel to fetch history for. style: form explode: true schema: type: string - name: latest in: query description: End of time range of messages to include in results. style: form explode: true schema: type: number format: double responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.historysuccessschema' - description: Schema for successful response groups.history method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.historyerrorschema' - description: Schema for error response groups.history method example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - groups:history /groups.info: get: tags: - groups summary: groups_info description: Gets information about a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.info operationId: groups_info parameters: - name: token in: query description: 'Authentication token. Requires scope: `groups:read`' style: form explode: true schema: type: string - name: include_locale in: query description: Set this to `true` to receive the locale for this group. Defaults to `false` style: form explode: true schema: type: boolean - name: channel in: query description: Private channel to get info on style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.infosuccessschema' - description: Schema for successful response groups.info method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.infoerrorschema' - description: Schema for error response groups.info method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - groups:read /groups.invite: post: tags: - groups summary: groups_invite description: Invites a user to a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.invite operationId: groups_invite parameters: - name: token in: header description: 'Authentication token. Requires scope: `groups:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: user: type: string description: User to invite. channel: type: string description: Private channel to invite user to. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.invitesuccessschema' - description: Schema for successful response groups.invite method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.inviteerrorschema' - description: Schema for error response groups.invite method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - groups:write /groups.kick: post: tags: - groups summary: groups_kick description: Removes a user from a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.kick operationId: groups_kick parameters: - name: token in: header description: 'Authentication token. Requires scope: `groups:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: user: type: string description: User to remove from private channel. channel: type: string description: Private channel to remove user from. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.kickschema' - description: Schema for successful response from groups.kick method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.kickerrorschema' - description: Schema for error response from groups.kick method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - groups:write /groups.leave: post: tags: - groups summary: groups_leave description: Leaves a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.leave operationId: groups_leave parameters: - name: token in: header description: 'Authentication token. Requires scope: `groups:write`' style: simple schema: type: string requestBody: description: Private channel to leave content: text/plain: schema: type: string description: Private channel to leave required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - groups:write /groups.list: get: tags: - groups summary: groups_list description: Lists private channels that the calling user has access to. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.list operationId: groups_list parameters: - name: exclude_members in: query description: Exclude the `members` from each `group` style: form explode: true schema: type: boolean - name: token in: query description: 'Authentication token. Requires scope: `groups:read`' style: form explode: true schema: type: string - name: exclude_archived in: query description: Don't return archived private channels. style: form explode: true schema: type: boolean responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.listsuccessschema' - description: Schema for successful response groups.list method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.listerrorschema' - description: Schema for error response groups.list method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - groups:read /groups.mark: post: tags: - groups summary: groups_mark description: Sets the read cursor in a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.mark operationId: groups_mark parameters: - name: token in: header description: 'Authentication token. Requires scope: `groups:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: ts: type: number description: Timestamp of the most recently seen message. format: double channel: type: string description: Private channel to set reading cursor in. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.marksuccessschema' - description: Schema for successful response from groups.mark method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.markerrorschema' - description: Schema for error response from groups.mark method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - groups:write /groups.open: post: tags: - groups summary: groups_open description: Opens a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.open operationId: groups_open parameters: - name: token in: header description: 'Authentication token. Requires scope: `groups:write`' style: simple schema: type: string requestBody: description: Private channel to open. content: text/plain: schema: type: string description: Private channel to open. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - groups:write /groups.rename: post: tags: - groups summary: groups_rename description: Renames a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.rename operationId: groups_rename parameters: - name: token in: header description: 'Authentication token. Requires scope: `groups:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: validate: type: boolean description: Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria. name: type: string description: New name for private channel. channel: type: string description: Private channel to rename required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - groups:write /groups.replies: get: tags: - groups summary: groups_replies description: Retrieve a thread of messages posted to a private channel externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.replies operationId: groups_replies parameters: - name: thread_ts in: query description: Unique identifier of a thread's parent message style: form explode: true schema: type: number format: double - name: token in: query description: 'Authentication token. Requires scope: `groups:history`' style: form explode: true schema: type: string - name: channel in: query description: Private channel to fetch thread from style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: messages: - text: Hello ts: '1358546515.000008' type: message user: U2147483896 - is_starred: true text: World ts: '1358546515.000007' type: message user: U2147483896 - ts: '1358546515.000007' type: something_else ok: 'true' example: messages: - text: Hello ts: '1358546515.000008' type: message user: U2147483896 - is_starred: true text: World ts: '1358546515.000007' type: message user: U2147483896 - ts: '1358546515.000007' type: something_else ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - groups:history /groups.setPurpose: post: tags: - groups summary: groups_setPurpose description: Sets the purpose for a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.setPurpose operationId: groups_setPurpose parameters: - name: token in: header description: 'Authentication token. Requires scope: `groups:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: purpose: type: string description: The new purpose channel: type: string description: Private channel to set the purpose of required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.setPurposeschema' - description: Schema for successful response from groups.setPurpose method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.setPurposeerrorschema' - description: Schema for error response from groups.setPurpose method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - groups:write /groups.setTopic: post: tags: - groups summary: groups_setTopic description: Sets the topic for a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.setTopic operationId: groups_setTopic parameters: - name: token in: header description: 'Authentication token. Requires scope: `groups:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: topic: type: string description: The new topic channel: type: string description: Private channel to set the topic of required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.setTopicschema' - description: Schema for successful response from groups.setTopic method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/groups.setTopicerrorschema' - description: Schema for error response from groups.setTopic method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - groups:write /groups.unarchive: post: tags: - groups summary: groups_unarchive description: Unarchives a private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/groups.unarchive operationId: groups_unarchive parameters: - name: token in: header description: 'Authentication token. Requires scope: `groups:write`' style: simple schema: type: string requestBody: description: Private channel to unarchive content: text/plain: schema: type: string description: Private channel to unarchive required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - groups:write /im.close: post: tags: - im summary: im_close description: Close a direct message channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/im.close operationId: im_close parameters: - name: token in: header description: 'Authentication token. Requires scope: `im:write`' style: simple schema: type: string requestBody: description: Direct message channel to close. content: text/plain: schema: type: string description: Direct message channel to close. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - im:write /im.history: get: tags: - im summary: im_history description: Fetches history of messages and events from direct message channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/im.history operationId: im_history parameters: - name: count in: query description: Number of messages to return, between 1 and 1000. style: form explode: true schema: type: integer format: int32 - name: unreads in: query description: Include `unread_count_display` in the output? style: form explode: true schema: type: boolean - name: inclusive in: query description: Include messages with latest or oldest timestamp in results. style: form explode: true schema: type: boolean - name: token in: query description: 'Authentication token. Requires scope: `im:history`' style: form explode: true schema: type: string - name: oldest in: query description: Start of time range of messages to include in results. style: form explode: true schema: type: number format: double - name: channel in: query description: Direct message channel to fetch history for. style: form explode: true schema: type: string - name: latest in: query description: End of time range of messages to include in results. style: form explode: true schema: type: number format: double responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/im.historysuccessschema' - description: Schema for successful response from im.history method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/im.historyerrorschema' - description: Schema for error response from im.history method example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - im:history /im.list: get: tags: - im summary: im_list description: Lists direct message channels for the calling user. externalDocs: description: API method documentation url: https://api.slack.com/methods/im.list operationId: im_list parameters: - name: cursor in: query 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. style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `im:read`' style: form explode: true schema: type: string - name: limit in: query 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. style: form explode: true schema: type: integer format: int32 responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/im.listsuccessschema' - description: Schema for successful response im.list method example: ims: - created: 1449709280 id: D0G9QPY56 is_im: true is_org_shared: false is_user_deleted: false user: USLACKBOT - created: 1466692204 id: D1KL59A72 is_im: true is_org_shared: false is_user_deleted: false user: U0G9QF9C6 - created: 1449722883 id: D0G9XPFH9 is_im: true is_org_shared: false is_user_deleted: false user: U0G9WFXNZ - created: 1452098023 id: D0HRHJSF7 is_im: true is_org_shared: false is_user_deleted: false user: W0HRJL7CK - created: 1465834222 id: D1GD7CHC0 is_im: true is_org_shared: false is_user_deleted: true user: U1GDBDGR3 - created: 1468274703 id: D1QMF76M9 is_im: true is_org_shared: false is_user_deleted: false user: U1QNSQB9U - created: 1502210225 id: D6K48KKRN is_im: true is_org_shared: false is_user_deleted: false user: U6KR7BVFW ok: 'true' response_metadata: next_cursor: aW1faWQ6RDBCSDk1RExI= example: ims: - created: 1449709280 id: D0G9QPY56 is_im: true is_org_shared: false is_user_deleted: false user: USLACKBOT - created: 1466692204 id: D1KL59A72 is_im: true is_org_shared: false is_user_deleted: false user: U0G9QF9C6 - created: 1449722883 id: D0G9XPFH9 is_im: true is_org_shared: false is_user_deleted: false user: U0G9WFXNZ - created: 1452098023 id: D0HRHJSF7 is_im: true is_org_shared: false is_user_deleted: false user: W0HRJL7CK - created: 1465834222 id: D1GD7CHC0 is_im: true is_org_shared: false is_user_deleted: true user: U1GDBDGR3 - created: 1468274703 id: D1QMF76M9 is_im: true is_org_shared: false is_user_deleted: false user: U1QNSQB9U - created: 1502210225 id: D6K48KKRN is_im: true is_org_shared: false is_user_deleted: false user: U6KR7BVFW ok: 'true' response_metadata: next_cursor: aW1faWQ6RDBCSDk1RExI= default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/im.listerrorschema' - description: Schema for error response from im.list method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - im:read /im.mark: post: tags: - im summary: im_mark description: Sets the read cursor in a direct message channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/im.mark operationId: im_mark parameters: - name: token in: header description: 'Authentication token. Requires scope: `im:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: ts: type: number description: Timestamp of the most recently seen message. format: double channel: type: string description: Direct message channel to set reading cursor in. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/im.marksuccessschema' - description: Schema for successful response im.mark method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/im.markerrorschema' - description: Schema for error response im.mark method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - im:write /im.open: post: tags: - im summary: im_open description: Opens a direct message channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/im.open operationId: im_open parameters: - name: token in: header description: 'Authentication token. Requires scope: `im:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: return_im: type: boolean description: Boolean, indicates you want the full IM channel definition in the response. user: type: string description: User to open a direct message channel with. include_locale: type: boolean description: Set this to `true` to receive the locale for this im. Defaults to `false` required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/im.opensuccessschema' - description: Schema for successful response from im.open method example: channel: id: D947RLWRX ok: 'true' example: channel: id: D947RLWRX ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/im.openerrorschema' - description: Schema for error response from im.open method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - im:write /im.replies: get: tags: - im summary: im_replies description: Retrieve a thread of messages posted to a direct message conversation externalDocs: description: API method documentation url: https://api.slack.com/methods/im.replies operationId: im_replies parameters: - name: thread_ts in: query description: Unique identifier of a thread's parent message style: form explode: true schema: type: number format: double - name: token in: query description: 'Authentication token. Requires scope: `im:history`' style: form explode: true schema: type: string - name: channel in: query description: Direct message channel to fetch thread from style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: messages: - text: Hello ts: '1358546515.000008' type: message user: U2147483896 - is_starred: true text: World ts: '1358546515.000007' type: message user: U2147483896 - ts: '1358546515.000007' type: something_else ok: 'true' example: messages: - text: Hello ts: '1358546515.000008' type: message user: U2147483896 - is_starred: true text: World ts: '1358546515.000007' type: message user: U2147483896 - ts: '1358546515.000007' type: something_else ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - im:history /migration.exchange: get: tags: - migration summary: migration_exchange description: For Enterprise Grid workspaces, map local user IDs to global user IDs externalDocs: description: API method documentation url: https://api.slack.com/methods/migration.exchange operationId: migration_exchange parameters: - name: token in: query description: 'Authentication token. Requires scope: `tokens.basic`' style: form explode: true schema: type: string - name: to_old in: query description: Specify `true` to convert `W` global user IDs to workspace-specific `U` IDs. Defaults to `false`. style: form explode: true schema: type: boolean - name: users in: query description: A comma-separated list of user ids, up to 400 per request style: form explode: true schema: type: string responses: '200': description: Typical success response when mappings exist for the specified user IDs headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/migration.exchangesuccessschema' - description: Schema for successful response from migration.exchange method example: enterprise_id: E1KQTNXE1 invalid_user_ids: - U21ABZZXX ok: 'true' team_id: T1KR7PE1W user_id_map: U06UBSUN5: W06M56XJM U06UBSVB3: W06PUUDLY U06UBSVDX: W06PUUDMW U06UEB62U: W06PTT6GH W06UAZ65Q: W06UAZ65Q example: enterprise_id: E1KQTNXE1 invalid_user_ids: - U21ABZZXX ok: 'true' team_id: T1KR7PE1W user_id_map: U06UBSUN5: W06M56XJM U06UBSVB3: W06PUUDLY U06UBSVDX: W06PUUDMW U06UEB62U: W06PTT6GH W06UAZ65Q: W06UAZ65Q default: description: Typical error response when there are no mappings to provide headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/migration.exchangeerrorschema' - description: Schema for error response from migration.exchange method example: error: not_enterprise_team ok: 'false' example: error: not_enterprise_team ok: 'false' deprecated: false security: - oauth2: - tokens.basic /mpim.close: post: tags: - mpim summary: mpim_close description: Closes a multiparty direct message channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/mpim.close operationId: mpim_close parameters: - name: token in: header description: 'Authentication token. Requires scope: `mpim:write`' style: simple schema: type: string requestBody: description: MPIM to close. content: text/plain: schema: type: string description: MPIM to close. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - mpim:write /mpim.history: get: tags: - mpim summary: mpim_history description: Fetches history of messages and events from a multiparty direct message. externalDocs: description: API method documentation url: https://api.slack.com/methods/mpim.history operationId: mpim_history parameters: - name: count in: query description: Number of messages to return, between 1 and 1000. style: form explode: true schema: type: integer format: int32 - name: unreads in: query description: Include `unread_count_display` in the output? style: form explode: true schema: type: boolean - name: inclusive in: query description: Include messages with latest or oldest timestamp in results. style: form explode: true schema: type: boolean - name: token in: query description: 'Authentication token. Requires scope: `mpim:history`' style: form explode: true schema: type: string - name: oldest in: query description: Start of time range of messages to include in results. style: form explode: true schema: type: number format: double - name: channel in: query description: Multiparty direct message to fetch history for. style: form explode: true schema: type: string - name: latest in: query description: End of time range of messages to include in results. style: form explode: true schema: type: number format: double responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: has_more: false latest: '1358547726.000003' messages: - text: Hello ts: '1358546515.000008' type: message user: U2147483896 - is_starred: true text: World ts: '1358546515.000007' type: message user: U2147483896 - ts: '1358546515.000007' type: something_else ok: 'true' example: has_more: false latest: '1358547726.000003' messages: - text: Hello ts: '1358546515.000008' type: message user: U2147483896 - is_starred: true text: World ts: '1358546515.000007' type: message user: U2147483896 - ts: '1358546515.000007' type: something_else ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - mpim:history /mpim.list: get: tags: - mpim summary: mpim_list description: Lists multiparty direct message channels for the calling user. externalDocs: description: API method documentation url: https://api.slack.com/methods/mpim.list operationId: mpim_list parameters: - name: token in: query description: 'Authentication token. Requires scope: `mpim:read`' style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - mpim:read /mpim.mark: post: tags: - mpim summary: mpim_mark description: Sets the read cursor in a multiparty direct message channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/mpim.mark operationId: mpim_mark parameters: - name: token in: header description: 'Authentication token. Requires scope: `mpim:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: ts: type: number description: Timestamp of the most recently seen message. format: double channel: type: string description: multiparty direct message channel to set reading cursor in. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/mpim.markschema' - description: Schema for successful response from mpim.mark method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/mpim.markerrorschema' - description: Schema for error response from mpim.mark method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - mpim:write /mpim.open: post: tags: - mpim summary: mpim_open description: This method opens a multiparty direct message. externalDocs: description: API method documentation url: https://api.slack.com/methods/mpim.open operationId: mpim_open parameters: - name: token in: header description: 'Authentication token. Requires scope: `mpim:write`' style: simple schema: type: string requestBody: description: Comma separated lists of users. The ordering of the users is preserved whenever a MPIM group is returned. content: text/plain: schema: type: string description: Comma separated lists of users. The ordering of the users is preserved whenever a MPIM group is returned. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/mpim.opensuccessschema' - description: Schema for successful response from mpim.open method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/mpim.openerrorschema' - description: Schema for error response from mpim.open method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - mpim:write /mpim.replies: get: tags: - mpim summary: mpim_replies description: Retrieve a thread of messages posted to a direct message conversation from a multiparty direct message. externalDocs: description: API method documentation url: https://api.slack.com/methods/mpim.replies operationId: mpim_replies parameters: - name: thread_ts in: query description: Unique identifier of a thread's parent message. style: form explode: true schema: type: number format: double - name: token in: query description: 'Authentication token. Requires scope: `mpim:history`' style: form explode: true schema: type: string - name: channel in: query description: Multiparty direct message channel to fetch thread from. style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: messages: - text: Hello ts: '1358546515.000008' type: message user: U2147483896 - is_starred: true text: World ts: '1358546515.000007' type: message user: U2147483896 - ts: '1358546515.000007' type: something_else ok: 'true' example: messages: - text: Hello ts: '1358546515.000008' type: message user: U2147483896 - is_starred: true text: World ts: '1358546515.000007' type: message user: U2147483896 - ts: '1358546515.000007' type: something_else ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - mpim:history /oauth.access: get: tags: - oauth summary: oauth_access description: Exchanges a temporary OAuth verifier code for an access token. externalDocs: description: API method documentation url: https://api.slack.com/methods/oauth.access operationId: oauth_access parameters: - name: client_secret in: query description: Issued when you created your application. style: form explode: true schema: type: string - name: code in: query description: The `code` param returned via the OAuth callback. style: form explode: true schema: type: string - name: single_channel in: query description: Request the user to add your app only to a single channel. style: form explode: true schema: type: boolean - name: client_id in: query description: Issued when you created your application. style: form explode: true schema: type: string - name: redirect_uri in: query description: This must match the originally submitted URI (if one was sent). style: form explode: true schema: type: string responses: '200': description: Successful user token negotiation for a single scope headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_client_id ok: 'false' example: error: invalid_client_id ok: 'false' deprecated: false security: - oauth2: - none /oauth.token: get: tags: - oauth summary: oauth_token description: Exchanges a temporary OAuth verifier code for a workspace token. externalDocs: description: API method documentation url: https://api.slack.com/methods/oauth.token operationId: oauth_token parameters: - name: client_secret in: query description: Issued when you created your application. style: form explode: true schema: type: string - name: code in: query description: The `code` param returned via the OAuth callback. style: form explode: true schema: type: string - name: single_channel in: query description: Request the user to add your app only to a single channel. style: form explode: true schema: type: boolean - name: client_id in: query description: Issued when you created your application. style: form explode: true schema: type: string - name: redirect_uri in: query description: This must match the originally submitted URI (if one was sent). style: form explode: true schema: type: string responses: '200': description: Success example using a workspace app produces a very different kind of response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: access_token: xoxa-access-token-string app_id: A012345678 app_user_id: U0AB12ABC authorizing_user_id: U0HTT3Q0G installer_user_id: U061F7AUR ok: 'true' permissions: - resource_id: 0 resource_type: channel scopes: - channels:read - chat:write:user single_channel_id: C061EG9T2 team_id: T061EG9Z9 team_name: Subarachnoid Workspace token_type: app example: access_token: xoxa-access-token-string app_id: A012345678 app_user_id: U0AB12ABC authorizing_user_id: U0HTT3Q0G installer_user_id: U061F7AUR ok: 'true' permissions: - resource_id: 0 resource_type: channel scopes: - channels:read - chat:write:user single_channel_id: C061EG9T2 team_id: T061EG9Z9 team_name: Subarachnoid Workspace token_type: app default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_client_id ok: 'false' example: error: invalid_client_id ok: 'false' deprecated: false security: - oauth2: - none /pins.add: post: tags: - pins summary: pins_add description: Pins an item to a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/pins.add operationId: pins_add parameters: - name: token in: header description: 'Authentication token. Requires scope: `pins:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: file_comment: type: string description: File comment to pin. timestamp: type: number description: Timestamp of the message to pin. format: double file: type: string description: File to pin. channel: type: string description: Channel to pin the item in. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/pins.addschema' - description: Schema for successful response from pins.add method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/pins.adderrorschema' - description: Schema for error response from pins.add method example: error: channel_not_found ok: 'false' example: error: channel_not_found ok: 'false' deprecated: false security: - oauth2: - pins:write /pins.list: get: tags: - pins summary: pins_list description: Lists items pinned to a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/pins.list operationId: pins_list parameters: - name: token in: query description: 'Authentication token. Requires scope: `pins:read`' style: form explode: true schema: type: string - name: channel in: query description: Channel to get pinned items for. style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/pins.listsuccessschema' description: Typical success response default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/pins.listerrorschema' - description: Schema for error response from pins.list method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - pins:read /pins.remove: post: tags: - pins summary: pins_remove description: Un-pins an item from a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/pins.remove operationId: pins_remove parameters: - name: token in: header description: 'Authentication token. Requires scope: `pins:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: file_comment: type: string description: File comment to un-pin. timestamp: type: number description: Timestamp of the message to un-pin. format: double file: type: string description: File to un-pin. channel: type: string description: Channel where the item is pinned to. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/pins.removeschema' - description: Schema for successful response from pins.remove method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/pins.removeerrorschema' - description: Schema for error response from pins.remove method deprecated: false security: - oauth2: - pins:write /reactions.add: post: tags: - reactions summary: reactions_add description: Adds a reaction to an item. externalDocs: description: API method documentation url: https://api.slack.com/methods/reactions.add operationId: reactions_add parameters: - name: token in: header description: 'Authentication token. Requires scope: `reactions:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: name: type: string description: Reaction (emoji) name. file_comment: type: string description: File comment to add reaction to. timestamp: type: number description: Timestamp of the message to add reaction to. format: double file: type: string description: File to add reaction to. channel: type: string description: Channel where the message to add reaction to was posted. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/reactions.addschema' - description: Schema for successful response from reactions.add method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/reactions.adderrorschema' - description: Schema for error response from reactions.add method example: error: already_reacted ok: 'false' example: error: already_reacted ok: 'false' deprecated: false security: - oauth2: - reactions:write /reactions.get: get: tags: - reactions summary: reactions_get description: Gets reactions for an item. externalDocs: description: API method documentation url: https://api.slack.com/methods/reactions.get operationId: reactions_get parameters: - name: full in: query description: If true always return the complete reaction list. style: form explode: true schema: type: boolean - name: file_comment in: query description: File comment to get reactions for. style: form explode: true schema: type: string - name: timestamp in: query description: Timestamp of the message to get reactions for. style: form explode: true schema: type: number format: double - name: token in: query description: 'Authentication token. Requires scope: `reactions:read`' style: form explode: true schema: type: string - name: file in: query description: File to get reactions for. style: form explode: true schema: type: string - name: channel in: query description: Channel where the message to get reactions for was posted. style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/reactions.getsuccessschema' description: Typical success response default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/reactions.geterrorschema' - description: Schema for error response from reactions.get method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - reactions:read /reactions.list: get: tags: - reactions summary: reactions_list description: Lists reactions made by a user. externalDocs: description: API method documentation url: https://api.slack.com/methods/reactions.list operationId: reactions_list parameters: - name: count in: query description: '' style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `reactions:read`' style: form explode: true schema: type: string - name: full in: query description: If true always return the complete reaction list. style: form explode: true schema: type: boolean - name: user in: query description: Show reactions made by this user. Defaults to the authed user. style: form explode: true schema: type: string - name: page in: query description: '' style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/reactions.listschema' - description: Schema for successful response from reactions.list method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/reactions.listerrorschema' - description: Schema for error response from reactions.list method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - reactions:read /reactions.remove: post: tags: - reactions summary: reactions_remove description: Removes a reaction from an item. externalDocs: description: API method documentation url: https://api.slack.com/methods/reactions.remove operationId: reactions_remove parameters: - name: token in: header description: 'Authentication token. Requires scope: `reactions:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: name: type: string description: Reaction (emoji) name. file_comment: type: string description: File comment to remove reaction from. timestamp: type: number description: Timestamp of the message to remove reaction from. format: double file: type: string description: File to remove reaction from. channel: type: string description: Channel where the message to remove reaction from was posted. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/reactions.removeschema' - description: Schema for successful response from reactions.remove method example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/reactions.removeerrorschema' - description: Schema for error response from reactions.remove method example: error: no_reaction ok: 'false' example: error: no_reaction ok: 'false' deprecated: false security: - oauth2: - reactions:write /reminders.add: post: tags: - reminders summary: reminders_add description: Creates a reminder. externalDocs: description: API method documentation url: https://api.slack.com/methods/reminders.add operationId: reminders_add parameters: - name: token in: header description: 'Authentication token. Requires scope: `reminders:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: text: type: string description: The content of the reminder user: type: string description: The user who will receive the reminder. If no user is specified, the reminder will go to user who created it. time: type: string description: 'When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday")' required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - reminders:write /reminders.complete: post: tags: - reminders summary: reminders_complete description: Marks a reminder as complete. externalDocs: description: API method documentation url: https://api.slack.com/methods/reminders.complete operationId: reminders_complete parameters: - name: token in: header description: 'Authentication token. Requires scope: `reminders:write`' style: simple schema: type: string requestBody: description: The ID of the reminder to be marked as complete content: text/plain: schema: type: string description: The ID of the reminder to be marked as complete required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - reminders:write /reminders.delete: post: tags: - reminders summary: reminders_delete description: Deletes a reminder. externalDocs: description: API method documentation url: https://api.slack.com/methods/reminders.delete operationId: reminders_delete parameters: - name: token in: header description: 'Authentication token. Requires scope: `reminders:write`' style: simple schema: type: string requestBody: description: The ID of the reminder content: text/plain: schema: type: string description: The ID of the reminder required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - reminders:write /reminders.info: get: tags: - reminders summary: reminders_info description: Gets information about a reminder. externalDocs: description: API method documentation url: https://api.slack.com/methods/reminders.info operationId: reminders_info parameters: - name: token in: query description: 'Authentication token. Requires scope: `reminders:read`' style: form explode: true schema: type: string - name: reminder in: query description: The ID of the reminder style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - reminders:read /reminders.list: get: tags: - reminders summary: reminders_list description: Lists all reminders created by or for a given user. externalDocs: description: API method documentation url: https://api.slack.com/methods/reminders.list operationId: reminders_list parameters: - name: token in: query description: 'Authentication token. Requires scope: `reminders:read`' style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - reminders:read /rtm.connect: get: tags: - rtm summary: rtm_connect description: Starts a Real Time Messaging session. externalDocs: description: API method documentation url: https://api.slack.com/methods/rtm.connect operationId: rtm_connect parameters: - name: presence_sub in: query description: Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions). style: form explode: true schema: type: boolean - name: token in: query description: 'Authentication token. Requires scope: `rtm:stream`' style: form explode: true schema: type: string - name: batch_presence_aware in: query description: Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching). style: form explode: true schema: type: boolean responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/rtm.connectschema' - description: Schema for successful response from rtm.connect method example: ok: 'true' self: id: U4X318ZMZ name: robotoverlord team: domain: slackdemo id: T2U81E2FP name: SlackDemo url: wss://... example: ok: 'true' self: id: U4X318ZMZ name: robotoverlord team: domain: slackdemo id: T2U81E2FP name: SlackDemo url: wss://... default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/rtm.connecterrorschema' - description: Schema for error response from rtm.connect method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - rtm:stream /rtm.start: get: tags: - rtm summary: rtm_start description: Starts a Real Time Messaging session. externalDocs: description: API method documentation url: https://api.slack.com/methods/rtm.start operationId: rtm_start parameters: - name: no_latest in: query description: Exclude latest timestamps for channels, groups, mpims, and ims. Automatically sets `no_unreads` to `1` style: form explode: true schema: type: boolean - name: simple_latest in: query description: Return timestamp only for latest message object of each channel (improves performance). style: form explode: true schema: type: boolean - name: include_locale in: query description: Set this to `true` to receive the locale for users and channels. Defaults to `false` style: form explode: true schema: type: boolean - name: presence_sub in: query description: Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions). style: form explode: true schema: type: boolean - name: no_unreads in: query description: Skip unread counts for each channel (improves performance). style: form explode: true schema: type: boolean - name: batch_presence_aware in: query description: Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching). style: form explode: true schema: type: boolean - name: mpim_aware in: query description: Returns MPIMs to the client in the API response. style: form explode: true schema: type: boolean - name: token in: query description: 'Authentication token. Requires scope: `rtm:stream`' style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/rtm.startsuccessschema' - description: Schema for successful response from rtm.start method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/rtm.starterrorschema' - description: Schema for error response from rtm.start method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - rtm:stream /search.all: get: tags: - search summary: search_all description: Searches for messages and files matching a query. externalDocs: description: API method documentation url: https://api.slack.com/methods/search.all operationId: search_all parameters: - name: sort_dir in: query description: Change sort direction to ascending (`asc`) or descending (`desc`). style: form explode: true schema: type: string - name: query in: query description: Search query. May contains booleans, etc. style: form explode: true schema: type: string - name: sort in: query description: Return matches sorted by either `score` or `timestamp`. style: form explode: true schema: type: string - name: count in: query description: '' style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `search:read`' style: form explode: true schema: type: string - name: highlight in: query description: Pass a value of `true` to enable query highlight markers (see below). style: form explode: true schema: type: boolean - name: page in: query description: '' style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: files: matches: - channels: [] comments_count: 1 created: 1508804330 display_as_bot: false editable: false external_type: '' filetype: png groups: [] id: F7PKF1NR7 image_exif_rotation: 1 ims: [] initial_comment: comment: Sure! Here's the workflow diagram! created: 1508804330 id: Fc7NLL52E7 is_intro: true timestamp: 1508804330 user: U2U85N1RZ is_external: false is_public: true mimetype: image/png mode: hosted name: slack workflow diagram.png original_h: 117 original_w: 128 permalink: https://example.slack.com/files/U2U85N1RZ/F7PKF1NR7/slack_workflow_diagram.png permalink_public: https://slack-files.com/T2U81E2FZ-F7PKF1NR7-bea9143f18 pretty_type: PNG preview: null public_url_shared: false score: '0.99982661240974' size: 35705 thumb_160: https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_160.png thumb_360: https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_360.png thumb_360_h: 117 thumb_360_w: 128 thumb_64: https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_64.png thumb_80: https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_80.png timestamp: 1508804330 title: slack workflow diagram top_file: false url_private: https://files.slack.com/files-pri/T2U81E2FZ-F7PKF1NR7/slack_workflow_diagram.png url_private_download: https://files.slack.com/files-pri/T2U81E2FZ-F7PKF1NR7/download/slack_workflow_diagram.png user: U2U85N1RZ username: amy pagination: first: 1 last: 1 page: 1 page_count: 1 per_page: 20 total_count: 1 paging: count: 20 page: 1 pages: 1 total: 1 total: 1 messages: matches: - channel: id: C2U86NC6M is_ext_shared: false is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_shared: false name: general pending_shared: [] iid: 35692677-e60e-43d9-ac45-1987cea88975 next: iid: 6f510ea1-e1d3-4f3f-bdb9-f9c6f6e9d609 text: Thanks! ts: '1508804378.000219' type: message user: U2U85HJ7R username: john permalink: https://example.slack.com/archives/C2U86NC6M/p1508804330000296 previous: iid: aba8603c-0543-4fb2-9118-a5ac85f3d138 text: Can you send me the Slack workflow diagram? ts: '1508804301.000026' type: message user: U2U85HJ7R username: john team: T2U81E2FZ text: "uploaded a file: and commented: Sure! Here's the workflow diagram!" ts: '1508804330.000296' type: message user: U2U85N1RZ username: amy pagination: first: 1 last: 1 page: 1 page_count: 1 per_page: 20 total_count: 1 paging: count: 20 page: 1 pages: 1 total: 1 total: 1 ok: 'true' posts: matches: [] total: 0 query: diagram example: files: matches: - channels: [] comments_count: 1 created: 1508804330 display_as_bot: false editable: false external_type: '' filetype: png groups: [] id: F7PKF1NR7 image_exif_rotation: 1 ims: [] initial_comment: comment: Sure! Here's the workflow diagram! created: 1508804330 id: Fc7NLL52E7 is_intro: true timestamp: 1508804330 user: U2U85N1RZ is_external: false is_public: true mimetype: image/png mode: hosted name: slack workflow diagram.png original_h: 117 original_w: 128 permalink: https://example.slack.com/files/U2U85N1RZ/F7PKF1NR7/slack_workflow_diagram.png permalink_public: https://slack-files.com/T2U81E2FZ-F7PKF1NR7-bea9143f18 pretty_type: PNG preview: null public_url_shared: false score: '0.99982661240974' size: 35705 thumb_160: https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_160.png thumb_360: https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_360.png thumb_360_h: 117 thumb_360_w: 128 thumb_64: https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_64.png thumb_80: https://files.slack.com/files-tmb/T2U81E2FZ-F7PKF1NR7-19f33fc256/slack_workflow_diagram_80.png timestamp: 1508804330 title: slack workflow diagram top_file: false url_private: https://files.slack.com/files-pri/T2U81E2FZ-F7PKF1NR7/slack_workflow_diagram.png url_private_download: https://files.slack.com/files-pri/T2U81E2FZ-F7PKF1NR7/download/slack_workflow_diagram.png user: U2U85N1RZ username: amy pagination: first: 1 last: 1 page: 1 page_count: 1 per_page: 20 total_count: 1 paging: count: 20 page: 1 pages: 1 total: 1 total: 1 messages: matches: - channel: id: C2U86NC6M is_ext_shared: false is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_shared: false name: general pending_shared: [] iid: 35692677-e60e-43d9-ac45-1987cea88975 next: iid: 6f510ea1-e1d3-4f3f-bdb9-f9c6f6e9d609 text: Thanks! ts: '1508804378.000219' type: message user: U2U85HJ7R username: john permalink: https://example.slack.com/archives/C2U86NC6M/p1508804330000296 previous: iid: aba8603c-0543-4fb2-9118-a5ac85f3d138 text: Can you send me the Slack workflow diagram? ts: '1508804301.000026' type: message user: U2U85HJ7R username: john team: T2U81E2FZ text: "uploaded a file: and commented: Sure! Here's the workflow diagram!" ts: '1508804330.000296' type: message user: U2U85N1RZ username: amy pagination: first: 1 last: 1 page: 1 page_count: 1 per_page: 20 total_count: 1 paging: count: 20 page: 1 pages: 1 total: 1 total: 1 ok: 'true' posts: matches: [] total: 0 query: diagram default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: missing_scope needed: search:read ok: 'false' provided: identify,bot:basic example: error: missing_scope needed: search:read ok: 'false' provided: identify,bot:basic deprecated: false security: - oauth2: - search:read /search.files: get: tags: - search summary: search_files description: Searches for files matching a query. externalDocs: description: API method documentation url: https://api.slack.com/methods/search.files operationId: search_files parameters: - name: sort_dir in: query description: Change sort direction to ascending (`asc`) or descending (`desc`). style: form explode: true schema: type: string - name: query in: query description: Search query. style: form explode: true schema: type: string - name: sort in: query description: Return matches sorted by either `score` or `timestamp`. style: form explode: true schema: type: string - name: highlight in: query description: Pass a value of `true` to enable query highlight markers (see below). style: form explode: true schema: type: boolean - name: count in: query description: '' style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `search:read`' style: form explode: true schema: type: string - name: page in: query description: '' style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: files: matches: - channels: [] comments_count: 1 created: 1507850315 deanimate_gif: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_deanimate_gif.png display_as_bot: false editable: false external_type: '' filetype: gif groups: [] id: F7H0D7ZBB image_exif_rotation: 1 ims: [] is_external: false is_public: true mimetype: image/gif mode: hosted name: computer.gif original_h: 313 original_w: 500 permalink: https://eventsdemo.slack.com/files/U2U85N1RZ/F7H0D7ZBB/computer.gif permalink_public: https://slack-files.com/T2U81E2BB-F7H0D7ZBB-85b7f5557e pretty_type: GIF preview: null public_url_shared: false reactions: - count: 1 name: stuck_out_tongue_winking_eye users: - U2U85N1RZ score: '0.38899223746309' size: 1639034 thumb_160: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_160.png thumb_360: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_360.png thumb_360_gif: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_360.gif thumb_360_h: 225 thumb_360_w: 360 thumb_480: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_480.png thumb_480_gif: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_480.gif thumb_480_h: 300 thumb_480_w: 480 thumb_64: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_64.png thumb_80: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_80.png timestamp: 1507850315 title: computer.gif top_file: false url_private: https://files.slack.com/files-pri/T2U81E2BB-F7H0D7ZBB/computer.gif url_private_download: https://files.slack.com/files-pri/T2U81E2BB-F7H0D7ZBB/download/computer.gif user: U2U85N1RZ username: '' pagination: first: 1 last: 3 page: 1 page_count: 1 per_page: 20 total_count: 3 paging: count: 20 page: 1 pages: 1 total: 3 total: 3 ok: 'true' query: computer.gif example: files: matches: - channels: [] comments_count: 1 created: 1507850315 deanimate_gif: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_deanimate_gif.png display_as_bot: false editable: false external_type: '' filetype: gif groups: [] id: F7H0D7ZBB image_exif_rotation: 1 ims: [] is_external: false is_public: true mimetype: image/gif mode: hosted name: computer.gif original_h: 313 original_w: 500 permalink: https://eventsdemo.slack.com/files/U2U85N1RZ/F7H0D7ZBB/computer.gif permalink_public: https://slack-files.com/T2U81E2BB-F7H0D7ZBB-85b7f5557e pretty_type: GIF preview: null public_url_shared: false reactions: - count: 1 name: stuck_out_tongue_winking_eye users: - U2U85N1RZ score: '0.38899223746309' size: 1639034 thumb_160: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_160.png thumb_360: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_360.png thumb_360_gif: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_360.gif thumb_360_h: 225 thumb_360_w: 360 thumb_480: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_480.png thumb_480_gif: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_480.gif thumb_480_h: 300 thumb_480_w: 480 thumb_64: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_64.png thumb_80: https://files.slack.com/files-tmb/T2U81E2BB-F7H0D7ZBB-21624821e6/computer_80.png timestamp: 1507850315 title: computer.gif top_file: false url_private: https://files.slack.com/files-pri/T2U81E2BB-F7H0D7ZBB/computer.gif url_private_download: https://files.slack.com/files-pri/T2U81E2BB-F7H0D7ZBB/download/computer.gif user: U2U85N1RZ username: '' pagination: first: 1 last: 3 page: 1 page_count: 1 per_page: 20 total_count: 3 paging: count: 20 page: 1 pages: 1 total: 3 total: 3 ok: 'true' query: computer.gif default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: No query passed ok: 'false' example: error: No query passed ok: 'false' deprecated: false security: - oauth2: - search:read /search.messages: get: tags: - search summary: search_messages description: Searches for messages matching a query. externalDocs: description: API method documentation url: https://api.slack.com/methods/search.messages operationId: search_messages parameters: - name: sort_dir in: query description: Change sort direction to ascending (`asc`) or descending (`desc`). style: form explode: true schema: type: string - name: query in: query description: Search query. style: form explode: true schema: type: string - name: sort in: query description: Return matches sorted by either `score` or `timestamp`. style: form explode: true schema: type: string - name: count in: query description: Pass the number of results you want per "page". Maximum of `100`. style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `search:read`' style: form explode: true schema: type: string - name: highlight in: query description: Pass a value of `true` to enable query highlight markers (see below). style: form explode: true schema: type: boolean - name: page in: query description: '' style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: messages: matches: - channel: id: C12345678 is_ext_shared: false is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_shared: false name: general pending_shared: [] iid: cb64bdaa-c1e8-4631-8a91-0f78080113e9 permalink: https://hitchhikers.slack.com/archives/C12345678/p1508284197000015 team: T12345678 text: The meaning of life the universe and everything is 42. ts: '1508284197.000015' type: message user: U2U85N1RV username: roach - channel: id: C12345678 is_ext_shared: false is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_shared: false name: random pending_shared: [] iid: 9a00d3c9-bd2d-45b0-988b-6cff99ae2a90 permalink: https://hitchhikers.slack.com/archives/C12345678/p1508795665000236 team: T12345678 text: The meaning of life the universe and everything is 101010 ts: '1508795665.000236' type: message user: '' username: robot overlord pagination: first: 1 last: 2 page: 1 page_count: 1 per_page: 20 total_count: 2 paging: count: 20 page: 1 pages: 1 total: 2 total: 2 ok: 'true' query: The meaning of life the universe and everything example: messages: matches: - channel: id: C12345678 is_ext_shared: false is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_shared: false name: general pending_shared: [] iid: cb64bdaa-c1e8-4631-8a91-0f78080113e9 permalink: https://hitchhikers.slack.com/archives/C12345678/p1508284197000015 team: T12345678 text: The meaning of life the universe and everything is 42. ts: '1508284197.000015' type: message user: U2U85N1RV username: roach - channel: id: C12345678 is_ext_shared: false is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_shared: false name: random pending_shared: [] iid: 9a00d3c9-bd2d-45b0-988b-6cff99ae2a90 permalink: https://hitchhikers.slack.com/archives/C12345678/p1508795665000236 team: T12345678 text: The meaning of life the universe and everything is 101010 ts: '1508795665.000236' type: message user: '' username: robot overlord pagination: first: 1 last: 2 page: 1 page_count: 1 per_page: 20 total_count: 2 paging: count: 20 page: 1 pages: 1 total: 2 total: 2 ok: 'true' query: The meaning of life the universe and everything default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: No query passed ok: 'false' example: error: No query passed ok: 'false' deprecated: false security: - oauth2: - search:read /stars.add: post: tags: - stars summary: stars_add description: Adds a star to an item. externalDocs: description: API method documentation url: https://api.slack.com/methods/stars.add operationId: stars_add parameters: - name: token in: header description: 'Authentication token. Requires scope: `stars:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: file_comment: type: string description: File comment to add star to. timestamp: type: number description: Timestamp of the message to add star to. format: double channel: type: string description: Channel to add star to, or channel where the message to add star to was posted (used with `timestamp`). file: type: string description: File to add star to. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - stars:write /stars.list: get: tags: - stars summary: stars_list description: Lists stars for a user. externalDocs: description: API method documentation url: https://api.slack.com/methods/stars.list operationId: stars_list parameters: - name: count in: query description: '' style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `stars:read`' style: form explode: true schema: type: string - name: page in: query description: '' style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - stars:read /stars.remove: post: tags: - stars summary: stars_remove description: Removes a star from an item. externalDocs: description: API method documentation url: https://api.slack.com/methods/stars.remove operationId: stars_remove parameters: - name: token in: header description: 'Authentication token. Requires scope: `stars:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: file_comment: type: string description: File comment to remove star from. timestamp: type: number description: Timestamp of the message to remove star from. format: double channel: type: string description: Channel to remove star from, or channel where the message to remove star from was posted (used with `timestamp`). file: type: string description: File to remove star from. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - stars:write /team.accessLogs: get: tags: - team summary: team_accessLogs description: Gets the access logs for the current team. externalDocs: description: API method documentation url: https://api.slack.com/methods/team.accessLogs operationId: team_accessLogs parameters: - name: count in: query description: '' style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `admin`' style: form explode: true schema: type: string - name: page in: query description: '' style: form explode: true schema: type: string - name: before in: query description: End of time range of logs to include in results (inclusive). style: form explode: true schema: type: integer format: int32 responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - admin /team.billableInfo: get: tags: - team summary: team_billableInfo description: Gets billable users information for the current team. externalDocs: description: API method documentation url: https://api.slack.com/methods/team.billableInfo operationId: team_billableInfo parameters: - name: token in: query description: 'Authentication token. Requires scope: `admin`' style: form explode: true schema: type: string - name: user in: query description: A user to retrieve the billable information for. Defaults to all users. style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - admin /team.info: get: tags: - team summary: team_info description: Gets information about the current team. externalDocs: description: API method documentation url: https://api.slack.com/methods/team.info operationId: team_info parameters: - name: token in: query description: 'Authentication token. Requires scope: `team:read`' style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/team.infoschema' - description: Schema for successful response from team.info method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/team.infoerrorschema' - description: Schema for error response from team.info method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - team:read /team.integrationLogs: get: tags: - team summary: team_integrationLogs description: Gets the integration logs for the current team. externalDocs: description: API method documentation url: https://api.slack.com/methods/team.integrationLogs operationId: team_integrationLogs parameters: - name: count in: query description: '' style: form explode: true schema: type: string - name: change_type in: query description: Filter logs with this change type. Defaults to all logs. style: form explode: true schema: type: string - name: app_id in: query description: Filter logs to this Slack app. Defaults to all logs. style: form explode: true schema: type: integer format: int32 - name: token in: query description: 'Authentication token. Requires scope: `admin`' style: form explode: true schema: type: string - name: user in: query description: Filter logs generated by this user’s actions. Defaults to all logs. style: form explode: true schema: type: string - name: service_id in: query description: Filter logs to this service. Defaults to all logs. style: form explode: true schema: type: integer format: int32 - name: page in: query description: '' style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - admin /team.profile.get: get: tags: - team.profile - team summary: team_profile_get description: Retrieve a team's profile. externalDocs: description: API method documentation url: https://api.slack.com/methods/team.profile.get operationId: team_profile_get parameters: - name: token in: query description: 'Authentication token. Requires scope: `users.profile:read`' style: form explode: true schema: type: string - name: visibility in: query description: Filter by visibility. style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/team.profile.getsuccessschema' - description: Schema for successful response from team.profile.get method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/team.profile.geterrorschema' - description: Schema for error response from team.profile.get method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - users.profile:read /usergroups.create: post: tags: - usergroups summary: usergroups_create description: Create a User Group externalDocs: description: API method documentation url: https://api.slack.com/methods/usergroups.create operationId: usergroups_create parameters: - name: token in: header description: 'Authentication token. Requires scope: `usergroups:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: handle: type: string description: A mention handle. Must be unique among channels, users and User Groups. name: type: string description: A name for the User Group. Must be unique among User Groups. channels: type: string description: A comma separated string of encoded channel IDs for which the User Group uses as a default. include_count: type: boolean description: Include the number of users in each User Group. description: type: string description: A short description of the User Group. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - usergroups:write /usergroups.disable: post: tags: - usergroups summary: usergroups_disable description: Disable an existing User Group externalDocs: description: API method documentation url: https://api.slack.com/methods/usergroups.disable operationId: usergroups_disable parameters: - name: token in: header description: 'Authentication token. Requires scope: `usergroups:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: include_count: type: boolean description: Include the number of users in the User Group. usergroup: type: string description: The encoded ID of the User Group to disable. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - usergroups:write /usergroups.enable: post: tags: - usergroups summary: usergroups_enable description: Enable a User Group externalDocs: description: API method documentation url: https://api.slack.com/methods/usergroups.enable operationId: usergroups_enable parameters: - name: token in: header description: 'Authentication token. Requires scope: `usergroups:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: include_count: type: boolean description: Include the number of users in the User Group. usergroup: type: string description: The encoded ID of the User Group to enable. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - usergroups:write /usergroups.list: get: tags: - usergroups summary: usergroups_list description: List all User Groups for a team externalDocs: description: API method documentation url: https://api.slack.com/methods/usergroups.list operationId: usergroups_list parameters: - name: include_users in: query description: Include the list of users for each User Group. style: form explode: true schema: type: boolean - name: token in: query description: 'Authentication token. Requires scope: `usergroups:read`' style: form explode: true schema: type: string - name: include_count in: query description: Include the number of users in each User Group. style: form explode: true schema: type: boolean - name: include_disabled in: query description: Include disabled User Groups. style: form explode: true schema: type: boolean responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' usergroups: - auto_type: admin created_by: USLACKBOT date_create: 1446598059 date_delete: 0 date_update: 1446670362 deleted_by: null description: A group of all Administrators on your team. handle: admins id: S0614TZR7 is_external: false is_usergroup: true name: Team Admins prefs: channels: [] groups: [] team_id: T060RNRCH updated_by: U060RNRCZ user_count: '2' - auto_type: owner created_by: USLACKBOT date_create: 1446678371 date_delete: 0 date_update: 1446678371 deleted_by: null description: A group of all Owners on your team. handle: owners id: S06158AV7 is_external: false is_usergroup: true name: Team Owners prefs: channels: [] groups: [] team_id: T060RNRCH updated_by: USLACKBOT user_count: '1' - auto_type: null created_by: U060RNRCZ date_create: 1446746793 date_delete: 1446748865 date_update: 1446747767 deleted_by: null description: Marketing gurus, PR experts and product advocates. handle: marketing-team id: S0615G0KT is_external: false is_usergroup: true name: Marketing Team prefs: channels: [] groups: [] team_id: T060RNRCH updated_by: U060RNRCZ user_count: '0' example: ok: 'true' usergroups: - auto_type: admin created_by: USLACKBOT date_create: 1446598059 date_delete: 0 date_update: 1446670362 deleted_by: null description: A group of all Administrators on your team. handle: admins id: S0614TZR7 is_external: false is_usergroup: true name: Team Admins prefs: channels: [] groups: [] team_id: T060RNRCH updated_by: U060RNRCZ user_count: '2' - auto_type: owner created_by: USLACKBOT date_create: 1446678371 date_delete: 0 date_update: 1446678371 deleted_by: null description: A group of all Owners on your team. handle: owners id: S06158AV7 is_external: false is_usergroup: true name: Team Owners prefs: channels: [] groups: [] team_id: T060RNRCH updated_by: USLACKBOT user_count: '1' - auto_type: null created_by: U060RNRCZ date_create: 1446746793 date_delete: 1446748865 date_update: 1446747767 deleted_by: null description: Marketing gurus, PR experts and product advocates. handle: marketing-team id: S0615G0KT is_external: false is_usergroup: true name: Marketing Team prefs: channels: [] groups: [] team_id: T060RNRCH updated_by: U060RNRCZ user_count: '0' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - usergroups:read /usergroups.update: post: tags: - usergroups summary: usergroups_update description: Update an existing User Group externalDocs: description: API method documentation url: https://api.slack.com/methods/usergroups.update operationId: usergroups_update parameters: - name: token in: header description: 'Authentication token. Requires scope: `usergroups:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: handle: type: string description: A mention handle. Must be unique among channels, users and User Groups. description: type: string description: A short description of the User Group. channels: type: string description: A comma separated string of encoded channel IDs for which the User Group uses as a default. include_count: type: boolean description: Include the number of users in the User Group. usergroup: type: string description: The encoded ID of the User Group to update. name: type: string description: A name for the User Group. Must be unique among User Groups. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' usergroup: auto_type: null created_by: U060R4BJ4 date_create: 1447096577 date_delete: 0 date_update: 1447102109 deleted_by: null description: Marketing gurus, PR experts and product advocates. handle: marketing-team id: S0616NG6M is_external: false is_usergroup: true name: Marketing Team prefs: channels: [] groups: [] team_id: T060R4BHN updated_by: U060R4BJ4 user_count: 1 users: - U060R4BJ4 - U060RNRCZ example: ok: 'true' usergroup: auto_type: null created_by: U060R4BJ4 date_create: 1447096577 date_delete: 0 date_update: 1447102109 deleted_by: null description: Marketing gurus, PR experts and product advocates. handle: marketing-team id: S0616NG6M is_external: false is_usergroup: true name: Marketing Team prefs: channels: [] groups: [] team_id: T060R4BHN updated_by: U060R4BJ4 user_count: 1 users: - U060R4BJ4 - U060RNRCZ default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - usergroups:write /usergroups.users.list: get: tags: - usergroups.users - usergroups summary: usergroups_users_list description: List all users in a User Group externalDocs: description: API method documentation url: https://api.slack.com/methods/usergroups.users.list operationId: usergroups_users_list parameters: - name: token in: query description: 'Authentication token. Requires scope: `usergroups:read`' style: form explode: true schema: type: string - name: include_disabled in: query description: Allow results that involve disabled User Groups. style: form explode: true schema: type: boolean - name: usergroup in: query description: The encoded ID of the User Group to update. style: form explode: true schema: type: string responses: '200': description: Standard success response when used with a user token headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' users: - U060R4BJ4 - W123A4BC5 example: ok: 'true' users: - U060R4BJ4 - W123A4BC5 default: description: Standard failure response when used with an invalid token headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - usergroups:read /usergroups.users.update: post: tags: - usergroups.users - usergroups summary: usergroups_users_update description: Update the list of users for a User Group externalDocs: description: API method documentation url: https://api.slack.com/methods/usergroups.users.update operationId: usergroups_users_update parameters: - name: token in: header description: 'Authentication token. Requires scope: `usergroups:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: include_count: type: boolean description: Include the number of users in the User Group. users: type: string description: A comma separated string of encoded user IDs that represent the entire list of users for the User Group. usergroup: type: string description: The encoded ID of the User Group to update. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' usergroup: auto_type: null created_by: U060R4BJ4 date_create: 1447096577 date_delete: 0 date_update: 1447102109 deleted_by: null description: Marketing gurus, PR experts and product advocates. handle: marketing-team id: S0616NG6M is_external: false is_usergroup: true name: Marketing Team prefs: channels: [] groups: [] team_id: T060R4BHN updated_by: U060R4BJ4 user_count: 1 users: - U060R4BJ4 - U060RNRCZ example: ok: 'true' usergroup: auto_type: null created_by: U060R4BJ4 date_create: 1447096577 date_delete: 0 date_update: 1447102109 deleted_by: null description: Marketing gurus, PR experts and product advocates. handle: marketing-team id: S0616NG6M is_external: false is_usergroup: true name: Marketing Team prefs: channels: [] groups: [] team_id: T060R4BHN updated_by: U060R4BJ4 user_count: 1 users: - U060R4BJ4 - U060RNRCZ default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - usergroups:write /users.conversations: get: tags: - users summary: users_conversations description: List conversations the calling user may access. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.conversations operationId: users_conversations parameters: - name: cursor in: query 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. style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `conversations:read`' style: form explode: true schema: type: string - name: limit in: query description: The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000. style: form explode: true schema: type: integer format: int32 - name: user in: query description: Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership. style: form explode: true schema: type: string - name: exclude_archived in: query description: Set to `true` to exclude archived channels from the list style: form explode: true schema: type: boolean - name: types in: query description: Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im` style: form explode: true schema: type: string responses: '200': description: Typical success response with only public channels. Note how `num_members` and `is_member` are not returned like typical `conversations` objects. headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/users.conversationssuccessschema' - description: Schema for successful response from users.conversations method. Returned conversation objects do not include `num_members` or `is_member` default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/users.conversationserrorschema' - description: Schema for error response from users.conversations method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - channels:read - groups:read - im:read - mpim:read /users.deletePhoto: post: tags: - users summary: users_deletePhoto description: Delete the user profile photo externalDocs: description: API method documentation url: https://api.slack.com/methods/users.deletePhoto operationId: users_deletePhoto parameters: - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: token: type: string description: 'Authentication token. Requires scope: `users.profile:write`' required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - users.profile:write /users.getPresence: get: tags: - users summary: users_getPresence description: Gets user presence information. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.getPresence operationId: users_getPresence parameters: - name: token in: query description: 'Authentication token. Requires scope: `users:read`' style: form explode: true schema: type: string - name: user in: query description: User to get presence info on. Defaults to the authed user. style: form explode: true schema: type: string responses: '200': description: When requesting information for a different user, this method just returns the current presence (either `active` or `away`). headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/APImethodusers.getPresence' - description: Generated from users.getPresence with shasum e7251aec575d8863f9e0eb38663ae9dc26655f65 example: ok: 'true' presence: active example: ok: 'true' presence: active default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/users.countserrorschema' - description: Schema for error response users.getPresence method example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - users:read /users.identity: get: tags: - users summary: users_identity description: Get a user's identity. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.identity operationId: users_identity parameters: - name: token in: query description: 'Authentication token. Requires scope: `identity.basic`' style: form explode: true schema: type: string responses: '200': description: 'You will receive at a minimum the following information:' headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/users.identityschema' description: 'You will receive at a minimum the following information:' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/users.identityerrorschema' - description: Schema for error response from users.identity method example: error: account_inactive ok: 'false' example: error: account_inactive ok: 'false' deprecated: false security: - oauth2: - identity.basic /users.info: get: tags: - users summary: users_info description: Gets information about a user. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.info operationId: users_info parameters: - name: include_locale in: query description: Set this to `true` to receive the locale for this user. Defaults to `false` style: form explode: true schema: type: boolean - name: token in: query description: 'Authentication token. Requires scope: `users:read`' style: form explode: true schema: type: string - name: user in: query description: User to get info on style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/users.infosuccessschema' - description: Schema for successful response from users.info method example: ok: 'true' user: color: 9f69e7 deleted: false has_2fa: false id: W012A3CDE is_admin: true is_app_user: false is_bot: false is_owner: false is_primary_owner: false is_restricted: false is_ultra_restricted: false name: spengler profile: avatar_hash: ge3b51ca72de display_name: spengler display_name_normalized: spengler email: spengler@ghostbusters.example.com image_192: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_24: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_32: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_48: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_512: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_72: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg real_name: Egon Spengler real_name_normalized: Egon Spengler status_emoji: ':books:' status_text: Print is dead team: T012AB3C4 real_name: Egon Spengler team_id: T012AB3C4 tz: America/Los_Angeles tz_label: Pacific Daylight Time tz_offset: -25200 updated: 1502138686 example: ok: 'true' user: color: 9f69e7 deleted: false has_2fa: false id: W012A3CDE is_admin: true is_app_user: false is_bot: false is_owner: false is_primary_owner: false is_restricted: false is_ultra_restricted: false name: spengler profile: avatar_hash: ge3b51ca72de display_name: spengler display_name_normalized: spengler email: spengler@ghostbusters.example.com image_192: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_24: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_32: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_48: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_512: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_72: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg real_name: Egon Spengler real_name_normalized: Egon Spengler status_emoji: ':books:' status_text: Print is dead team: T012AB3C4 real_name: Egon Spengler team_id: T012AB3C4 tz: America/Los_Angeles tz_label: Pacific Daylight Time tz_offset: -25200 updated: 1502138686 default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/users.infoerrorschema' - description: Schema for error response from users.info method example: error: user_not_found ok: 'false' example: error: user_not_found ok: 'false' deprecated: false security: - oauth2: - users:read /users.list: get: tags: - users summary: users_list description: Lists all users in a Slack team. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.list operationId: users_list parameters: - name: presence in: query description: Deprecated. Whether to include presence data in the output. Defaults to `false`. Setting this to `true` reduces performance, especially with large teams. style: form explode: true schema: type: boolean - name: cursor in: query 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. style: form explode: true schema: type: string - name: token in: query description: 'Authentication token. Requires scope: `users:read`' style: form explode: true schema: type: string - name: limit in: query 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. style: form explode: true schema: type: integer format: int32 - name: include_locale in: query description: Set this to `true` to receive the locale for users. Defaults to `false` style: form explode: true schema: type: boolean responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/users.listschema' - description: Schema for successful response from users.list method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/users.listerrorschema' - description: Schema for error response from users.list method example: error: invalid_cursor ok: 'false' example: error: invalid_cursor ok: 'false' deprecated: false security: - oauth2: - users:read /users.lookupByEmail: get: tags: - users summary: users_lookupByEmail description: Find a user with an email address. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.lookupByEmail operationId: users_lookupByEmail parameters: - name: token in: query description: 'Authentication token. Requires scope: `users:read.email`' style: form explode: true schema: type: string - name: email in: query description: An email address belonging to a user in the workspace style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/users.lookupByEmailsuccessschema' - description: Schema for successful response from users.lookupByEmail method example: ok: 'true' user: color: 9f69e7 deleted: false has_2fa: false id: W012A3CDE is_admin: true is_app_user: false is_bot: false is_owner: false is_primary_owner: false is_restricted: false is_ultra_restricted: false name: spengler profile: avatar_hash: ge3b51ca72de display_name: spengler display_name_normalized: spengler email: spengler@ghostbusters.example.com image_192: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_24: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_32: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_48: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_512: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_72: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg real_name: Egon Spengler real_name_normalized: Egon Spengler status_emoji: ':books:' status_text: Print is dead team: T012AB3C4 real_name: Egon Spengler team_id: T012AB3C4 tz: America/Los_Angeles tz_label: Pacific Daylight Time tz_offset: -25200 updated: 1502138686 example: ok: 'true' user: color: 9f69e7 deleted: false has_2fa: false id: W012A3CDE is_admin: true is_app_user: false is_bot: false is_owner: false is_primary_owner: false is_restricted: false is_ultra_restricted: false name: spengler profile: avatar_hash: ge3b51ca72de display_name: spengler display_name_normalized: spengler email: spengler@ghostbusters.example.com image_192: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_24: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_32: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_48: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_512: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_72: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg real_name: Egon Spengler real_name_normalized: Egon Spengler status_emoji: ':books:' status_text: Print is dead team: T012AB3C4 real_name: Egon Spengler team_id: T012AB3C4 tz: America/Los_Angeles tz_label: Pacific Daylight Time tz_offset: -25200 updated: 1502138686 default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/users.lookupByEmailerrorschema' - description: Schema for error response from users.lookupByEmail method example: error: users_not_found ok: 'false' example: error: users_not_found ok: 'false' deprecated: false security: - oauth2: - users:read.email /users.setActive: post: tags: - users summary: users_setActive description: Marked a user as active. Deprecated and non-functional. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.setActive operationId: users_setActive parameters: - name: token in: header description: 'Authentication token. Requires scope: `users:write`' style: simple schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - users:write /users.setPhoto: post: tags: - users summary: users_setPhoto description: Set the user profile photo externalDocs: description: API method documentation url: https://api.slack.com/methods/users.setPhoto operationId: users_setPhoto parameters: - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: image: type: string description: File contents via `multipart/form-data`. crop_w: type: integer description: Width/height of crop box (always square) format: int32 token: type: string description: 'Authentication token. Requires scope: `users.profile:write`' crop_y: type: integer description: Y coordinate of top-left corner of crop box format: int32 crop_x: type: integer description: X coordinate of top-left corner of crop box format: int32 required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - users.profile:write /users.setPresence: post: tags: - users summary: users_setPresence description: Manually sets user presence. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.setPresence operationId: users_setPresence parameters: - name: token in: header description: 'Authentication token. Requires scope: `users:write`' style: simple schema: type: string requestBody: description: Either `auto` or `away` content: text/plain: schema: type: string description: Either `auto` or `away` required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: ok: 'true' example: ok: 'true' default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/Defaultsuccesstemplate' - description: Verbose schema not yet ready for this method. example: error: invalid_auth ok: 'false' example: error: invalid_auth ok: 'false' deprecated: false security: - oauth2: - users:write /users.profile.get: get: tags: - users.profile - users summary: users_profile_get description: Retrieves a user's profile information. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.profile.get operationId: users_profile_get parameters: - name: token in: query description: 'Authentication token. Requires scope: `users.profile:read`' style: form explode: true schema: type: string - name: include_labels in: query description: Include labels for each ID in custom profile fields style: form explode: true schema: type: boolean - name: user in: query description: User to retrieve profile info for style: form explode: true schema: type: string responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/users.profile.getschema' - description: Schema for successful response from users.profile.get method example: ok: 'true' profile: avatar_hash: ge3b51ca72de display_name: spengler display_name_normalized: spengler email: spengler@ghostbusters.example.com image_192: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_24: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_32: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_48: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_512: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_72: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg real_name: Egon Spengler real_name_normalized: Egon Spengler status_emoji: ':books:' status_text: Print is dead team: T012AB3C4 example: ok: 'true' profile: avatar_hash: ge3b51ca72de display_name: spengler display_name_normalized: spengler email: spengler@ghostbusters.example.com image_192: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_24: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_32: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_48: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_512: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg image_72: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg real_name: Egon Spengler real_name_normalized: Egon Spengler status_emoji: ':books:' status_text: Print is dead team: T012AB3C4 default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/users.profile.geterrorschema' - description: Schema for error response from users.profile.get method example: error: user_not_found ok: 'false' example: error: user_not_found ok: 'false' deprecated: false security: - oauth2: - users.profile:read /users.profile.set: post: tags: - users.profile - users summary: users_profile_set description: Set the profile information for a user. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.profile.set operationId: users_profile_set parameters: - name: token in: header description: 'Authentication token. Requires scope: `users.profile:write`' style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: enum: - application/x-www-form-urlencoded type: string requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: profile: type: string description: Collection of key:value pairs presented as a URL-encoded JSON hash. user: type: string description: ID of user to change. This argument may only be specified by team admins on paid teams. value: type: string description: Value to set a single key to. Usable only if `profile` is not passed. name: type: string description: Name of a single key to set. Usable only if `profile` is not passed. required: false responses: '200': description: Typical success response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/users.profile.setschema' - description: Schema for successful response from users.profile.set method default: description: Typical error response headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/users.profile.seterrorschema' - description: Schema for error response from users.profile.set method example: error: invalid_profile ok: 'false' example: error: invalid_profile ok: 'false' deprecated: false security: - oauth2: - users.profile:write components: schemas: ChannelObject: title: ChannelObject required: - created - creator - id - is_channel - is_mpim - is_org_shared - is_private - is_shared - members - name - name_normalized - purpose - topic type: object properties: accepted_user: pattern: ^[UW][A-Z0-9]{8}$ type: string created: type: integer format: int32 creator: pattern: ^[UW][A-Z0-9]{8}$ type: string id: pattern: ^[C][A-Z0-9]{8}$ type: string is_archived: type: boolean is_channel: type: boolean is_general: type: boolean is_member: type: boolean is_moved: type: integer format: int32 is_mpim: 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 last_read: pattern: ^\d{10}\.\d{6}$ type: string latest: type: array items: $ref: '#/components/schemas/Messageobject' description: '' members: minItems: 0 uniqueItems: true type: array items: pattern: ^[UW][A-Z0-9]{8}$ type: string description: '' name: type: string name_normalized: type: string num_members: type: integer format: int32 pending_shared: minItems: 0 uniqueItems: true type: array items: pattern: ^[T][A-Z0-9]{8}$ type: string description: '' previous_names: minItems: 0 uniqueItems: true type: array items: type: string description: '' priority: type: integer format: int32 purpose: $ref: '#/components/schemas/Purpose' topic: $ref: '#/components/schemas/Topic' unlinked: type: integer format: int32 unread_count: type: integer format: int32 unread_count_display: type: integer format: int32 FileCommentObject: title: FileCommentObject type: object properties: comment: type: string created: type: integer format: int32 id: pattern: ^Fc[A-Z0-9]{8}$ type: string is_intro: type: boolean pinned_info: type: object additionalProperties: $ref: '#/components/schemas/Infoforapinneditem' pinned_to: type: array items: pattern: ^[CGD][A-Z0-9]{8}$ type: string description: '' reactions: type: array items: $ref: '#/components/schemas/Reactionobject' description: '' timestamp: type: integer format: int32 user: type: string objs_dnd: title: objs_dnd required: - dnd_enabled - next_dnd_end_ts - next_dnd_start_ts - snooze_enabled type: object properties: dnd_enabled: type: boolean next_dnd_end_ts: type: integer format: int32 next_dnd_start_ts: type: integer format: int32 snooze_enabled: type: boolean fileobject: title: fileobject type: object properties: channels: uniqueItems: true type: array items: pattern: ^[C][A-Z0-9]{8}$ type: string description: '' comments_count: type: integer format: int32 created: type: integer format: int32 display_as_bot: type: boolean editable: type: boolean external_type: type: string filetype: type: string groups: uniqueItems: true type: array items: pattern: ^[G][A-Z0-9]{8}$ type: string description: '' id: pattern: ^[F][A-Z0-9]{8}$ type: string image_exif_rotation: type: integer format: int32 ims: uniqueItems: true type: array items: pattern: ^[D][A-Z0-9]{8}$ type: string description: '' is_external: type: boolean is_public: type: boolean mimetype: type: string mode: type: string name: type: string original_h: type: integer format: int32 original_w: type: integer format: int32 permalink: type: string permalink_public: type: string pinned_info: type: object additionalProperties: $ref: '#/components/schemas/Infoforapinneditem' pinned_to: type: array items: pattern: ^[CGD][A-Z0-9]{8}$ type: string description: '' pretty_type: type: string public_url_shared: type: boolean reactions: type: array items: $ref: '#/components/schemas/Reactionobject' description: '' size: type: integer format: int32 thumb_1024: type: string thumb_1024_h: type: integer format: int32 thumb_1024_w: type: integer format: int32 thumb_160: type: string thumb_360: type: string thumb_360_h: type: integer format: int32 thumb_360_w: type: integer format: int32 thumb_480: type: string thumb_480_h: type: integer format: int32 thumb_480_w: type: integer format: int32 thumb_64: type: string thumb_720: type: string thumb_720_h: type: integer format: int32 thumb_720_w: type: integer format: int32 thumb_80: type: string thumb_800: type: string thumb_800_h: type: integer format: int32 thumb_800_w: type: integer format: int32 thumb_960: type: string thumb_960_h: type: integer format: int32 thumb_960_w: type: integer format: int32 timestamp: type: integer format: int32 title: type: string url_private: type: string url_private_download: type: string user: type: string username: type: string Groupobject: title: Groupobject required: - created - creator - id - is_group - members - name - name_normalized - purpose - topic type: object properties: created: type: integer format: int32 creator: pattern: ^[UW][A-Z0-9]{8}$ type: string id: pattern: ^[G][A-Z0-9]{8}$ type: string is_archived: type: boolean is_group: type: boolean is_moved: type: integer format: int32 is_mpim: type: boolean is_open: type: boolean is_pending_ext_shared: type: boolean last_read: pattern: ^\d{10}\.\d{6}$ type: string latest: type: array items: $ref: '#/components/schemas/Messageobject' description: '' members: minItems: 1 uniqueItems: true type: array items: pattern: ^[UW][A-Z0-9]{8}$ type: string description: '' name: type: string name_normalized: type: string priority: type: integer format: int32 purpose: $ref: '#/components/schemas/Purpose' topic: $ref: '#/components/schemas/Topic' unread_count: type: integer format: int32 unread_count_display: type: integer format: int32 IMObject: title: IMObject required: - created - id - is_im - is_org_shared - is_user_deleted - user type: object properties: created: type: integer format: int32 id: pattern: ^[D][A-Z0-9]{8}$ type: string is_im: type: boolean is_org_shared: type: boolean is_user_deleted: type: boolean priority: type: integer format: int32 user: pattern: ^[UW][A-Z0-9]{8}$ type: string objs_inviting_user: title: objs_inviting_user required: - id - is_app_user - is_restricted - is_ultra_restricted - name - profile - team_id - updated type: object properties: id: pattern: ^[UW][A-Z0-9]{8}$ type: string is_app_user: type: boolean is_restricted: type: boolean is_ultra_restricted: type: boolean name: type: string profile: $ref: '#/components/schemas/objs_user_profile_shortest' real_name: type: string team_id: pattern: ^[T][A-Z0-9]{8}$ type: string updated: type: number Messageobject: title: Messageobject required: - text - ts - type type: object properties: attachments: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/Attachment' description: '' bot_id: type: array items: pattern: ^B[A-Z0-9]{8}$ type: string description: '' comment: $ref: '#/components/schemas/FileCommentObject' display_as_bot: type: boolean file: $ref: '#/components/schemas/fileobject' icons: $ref: '#/components/schemas/Icons' inviter: pattern: ^[UW][A-Z0-9]{8}$ type: string is_intro: type: boolean last_read: pattern: ^\d{10}\.\d{6}$ type: string name: type: string old_name: type: string permalink: type: string pinned_to: type: array items: pattern: ^[CGD][A-Z0-9]{8}$ type: string description: '' purpose: type: string reactions: type: array items: $ref: '#/components/schemas/Reactionobject' description: '' replies: type: array items: $ref: '#/components/schemas/Reply' description: '' reply_count: type: integer format: int32 source_team: pattern: ^[T][A-Z0-9]{8}$ type: string subscribed: type: boolean subtype: type: string team: pattern: ^[T][A-Z0-9]{8}$ type: string text: type: string thread_ts: pattern: ^\d{10}\.\d{6}$ type: string topic: type: string ts: pattern: ^\d{10}\.\d{6}$ type: string type: type: string unread_count: type: integer format: int32 upload: type: boolean user: pattern: ^[UW][A-Z0-9]{8}$ type: string user_profile: $ref: '#/components/schemas/objs_user_profile_short' user_team: pattern: ^[T][A-Z0-9]{8}$ type: string username: type: string pagingobjectforfiles: title: pagingobjectforfiles required: - count - page - total type: object properties: count: type: integer format: int32 page: type: integer format: int32 pages: type: integer format: int32 total: type: integer format: int32 Reactionobject: title: Reactionobject required: - count - name - users type: object properties: count: type: integer format: int32 name: type: string users: type: array items: pattern: ^[UW][A-Z0-9]{8}$ type: string description: '' TeamObject: title: TeamObject required: - domain - email_domain - icon - id - name type: object properties: avatar_base_url: type: string domain: type: string email_domain: type: string enterprise_id: type: string enterprise_name: type: string has_compliance_export: type: boolean icon: $ref: '#/components/schemas/Icon' id: pattern: ^[T][A-Z0-9]{8}$ type: string messages_count: type: integer format: int32 msg_edit_window_mins: type: integer format: int32 name: type: string over_integrations_limit: type: boolean over_storage_limit: type: boolean plan: type: string prefs: $ref: '#/components/schemas/TeamPrefsObject' objs_team_profile_field: title: objs_team_profile_field required: - hint - id - label - options - ordering - type type: object properties: field_name: type: string hint: type: string id: pattern: ^X[a-zA-Z0-9]{9}$ type: string is_hidden: type: boolean label: type: string options: type: array items: type: string description: '' ordering: type: number possible_values: type: array items: type: string description: '' type: $ref: '#/components/schemas/Type' objs_user: title: objs_user required: - color - deleted - id - is_admin - is_app_user - is_bot - is_owner - is_primary_owner - is_restricted - is_ultra_restricted - name - profile - real_name - team_id - tz - tz_label - tz_offset - updated type: object properties: color: pattern: ^[a-fA-F0-9]{6}$ type: string deleted: type: boolean has_2fa: type: boolean id: pattern: ^[UW][A-Z0-9]{8}$ type: string is_admin: type: boolean is_app_user: type: boolean is_bot: type: boolean is_owner: type: boolean is_primary_owner: type: boolean is_restricted: type: boolean is_ultra_restricted: type: boolean locale: type: string name: type: string presence: type: string profile: $ref: '#/components/schemas/Userprofileobject' real_name: type: string team_id: pattern: ^[T][A-Z0-9]{8}$ type: string tz: type: string tz_label: type: string tz_offset: type: number updated: type: number Userprofileobject: title: Userprofileobject required: - avatar_hash - display_name - display_name_normalized - image_192 - image_24 - image_32 - image_48 - image_72 - real_name - real_name_normalized type: object properties: always_active: type: boolean avatar_hash: type: string display_name: type: string display_name_normalized: type: string email: type: string fields: type: object first_name: type: string guest_channels: type: string image_192: type: string image_24: type: string image_32: type: string image_48: type: string image_512: type: string image_72: type: string image_original: type: string last_name: type: string phone: type: string real_name: type: string real_name_normalized: type: string skype: type: string status_emoji: type: string status_expiration: type: integer format: int32 status_text: type: string status_text_canonical: type: string team: pattern: ^[T][A-Z0-9]{8}$ type: string title: type: string objs_user_profile_short: title: objs_user_profile_short required: - avatar_hash - display_name - first_name - image_72 - is_restricted - is_ultra_restricted - name - real_name - team type: object properties: avatar_hash: type: string display_name: type: string first_name: type: string image_72: type: string is_restricted: type: boolean is_ultra_restricted: type: boolean name: type: string real_name: type: string team: pattern: ^[T][A-Z0-9]{8}$ type: string objs_user_profile_shortest: title: objs_user_profile_shortest required: - avatar_hash - display_name - first_name - image_72 - real_name - team type: object properties: avatar_hash: type: string display_name: type: string first_name: type: string image_72: type: string real_name: type: string team: pattern: ^[T][A-Z0-9]{8}$ type: string UserPrefsobject: title: UserPrefsobject type: object properties: a11y_animations: type: boolean a11y_font_size: type: string all_channels_loud: type: boolean all_notifications_prefs: type: string all_unreads_sort_order: type: string allow_calls_to_set_current_status: type: boolean allow_cmd_tab_iss: type: boolean analytics_upsell_coachmark_seen: type: boolean arrow_history: type: boolean at_channel_suppressed_channels: type: string box_enabled: type: boolean channel_sort: type: string client_logs_pri: type: string color_names_in_list: type: boolean confirm_clear_all_unreads: type: boolean confirm_sh_call_start: type: boolean confirm_user_marked_away: type: boolean convert_emoticons: type: boolean display_display_names: type: boolean display_real_names_override: type: integer format: int32 dnd_enabled: type: boolean dnd_end_hour: type: string dnd_start_hour: type: string dropbox_enabled: type: boolean email_alerts: type: string email_alerts_sleep_until: type: integer format: int32 email_developer: type: boolean email_misc: type: boolean email_offers: type: boolean email_research: type: boolean email_tips: type: boolean email_weekly: type: boolean emoji_autocomplete_big: type: boolean emoji_mode: type: string emoji_use: type: string enable_react_emoji_picker: type: boolean enable_unread_view: type: boolean enhanced_debugging: type: boolean ent_org_wide_channels_sidebar: type: boolean enter_is_special_in_tbt: type: boolean enterprise_excluded_app_teams: type: string nullable: true enterprise_mdm_custom_msg: type: string enterprise_migration_seen: type: boolean expand_inline_imgs: type: boolean expand_internal_inline_imgs: type: boolean expand_non_media_attachments: type: boolean expand_snippets: type: boolean f_key_search: type: boolean flannel_server_pool: type: string folder_data: type: string folders_enabled: type: boolean frecency_ent_jumper: type: string frecency_ent_jumper_backup: type: string frecency_jumper: type: string full_text_extracts: type: boolean fuller_timestamps: type: boolean gdrive_authed: type: boolean gdrive_enabled: type: boolean graphic_emoticons: type: boolean growls_enabled: type: boolean growth_all_banners_prefs: type: string growth_msg_limit_approaching_cta_count: type: integer format: int32 growth_msg_limit_approaching_cta_ts: type: integer format: int32 growth_msg_limit_long_reached_cta_count: type: integer format: int32 growth_msg_limit_long_reached_cta_last_ts: type: integer format: int32 growth_msg_limit_reached_cta_count: type: integer format: int32 growth_msg_limit_reached_cta_last_ts: type: integer format: int32 growth_msg_limit_sixty_day_banner_cta_count: type: integer format: int32 growth_msg_limit_sixty_day_banner_cta_last_ts: type: integer format: int32 has_created_channel: type: boolean has_invited: type: boolean has_recently_shared_a_channel: type: boolean has_searched: type: boolean has_uploaded: type: boolean hide_hex_swatch: type: boolean hide_user_group_info_pane: type: boolean highlight_words: type: string in_interactive_mas_migration_flow: type: boolean intro_to_apps_message_seen: type: boolean jumbomoji: type: boolean k_key_omnibox: type: boolean k_key_omnibox_auto_hide_count: type: integer format: int32 keyboard: type: string nullable: true last_seen_at_channel_warning: type: integer format: int32 last_snippet_type: type: string last_tos_acknowledged: type: string lessons_enabled: type: boolean load_lato_2: type: boolean locale: type: string locales_enabled: $ref: '#/components/schemas/LocalesEnabled' loud_channels: type: string loud_channels_set: type: string ls_disabled: type: boolean mac_ssb_bounce: type: string mac_ssb_bullet: type: boolean mark_msgs_read_immediately: type: boolean measure_css_usage: type: boolean mentions_exclude_at_channels: type: boolean mentions_exclude_at_user_groups: type: boolean messages_theme: type: string msg_input_send_btn: type: boolean msg_input_send_btn_auto_set: type: boolean msg_preview: type: boolean msg_preview_persistent: type: boolean mute_sounds: type: boolean muted_channels: type: string never_channels: type: string new_msg_snd: type: string newxp_seen_last_message: type: integer format: int32 no_created_overlays: type: boolean no_invites_widget_in_sidebar: type: boolean no_joined_overlays: type: boolean no_macelectron_banner: type: boolean no_macssb1_banner: type: boolean no_macssb2_banner: type: boolean no_omnibox_in_channels: type: boolean no_text_in_notifications: type: boolean no_winssb1_banner: type: boolean obey_inline_img_limit: type: boolean onboarding_cancelled: type: boolean onboarding_slackbot_conversation_step: type: integer format: int32 overloaded_message_enabled: type: boolean pagekeys_handled: type: boolean posts_formatting_guide: type: boolean preferred_skin_tone: type: string privacy_policy_seen: type: boolean prompted_for_email_disabling: type: boolean purchaser: type: boolean push_at_channel_suppressed_channels: type: string push_dm_alert: type: boolean push_everything: type: boolean push_idle_wait: type: integer format: int32 push_loud_channels: type: string push_loud_channels_set: type: string push_mention_alert: type: boolean push_mention_channels: type: string push_show_preview: type: boolean push_sound: type: string require_at: type: boolean search_exclude_bots: type: boolean search_exclude_channels: type: string search_only_current_team: type: boolean search_only_my_channels: type: boolean search_sort: type: string seen_administration_menu: type: boolean seen_app_space_coachmark: type: boolean seen_app_space_tutorial: type: boolean seen_calls_interactive_coachmark: type: boolean seen_channel_browser_admin_coachmark: type: boolean seen_custom_status_badge: type: boolean seen_custom_status_callout: type: boolean seen_domain_invite_reminder: type: boolean seen_emoji_update_overlay_coachmark: type: boolean seen_gdrive_coachmark: type: boolean seen_guest_admin_slackbot_announcement: type: boolean seen_highlights_arrows_coachmark: type: boolean seen_highlights_coachmark: type: boolean seen_highlights_warm_welcome: type: boolean seen_intl_channel_names_coachmark: type: boolean seen_japanese_locale_change_message: type: boolean seen_keyboard_shortcuts_coachmark: type: boolean seen_locale_change_message: type: integer format: int32 seen_member_invite_reminder: type: boolean seen_name_tagging_coachmark: type: boolean seen_onboarding_banner: type: boolean seen_onboarding_channels: type: boolean seen_onboarding_direct_messages: type: boolean seen_onboarding_invites: type: boolean seen_onboarding_private_groups: type: boolean seen_onboarding_recent_mentions: type: boolean seen_onboarding_search: type: boolean seen_onboarding_slackbot_conversation: type: boolean seen_onboarding_starred_items: type: boolean seen_onboarding_start: type: boolean seen_shared_channels_coachmark: type: boolean seen_shared_channels_opt_in_change_message: type: boolean seen_shdep_slackbot_message: type: boolean seen_single_emoji_msg: type: boolean seen_ssb_prompt: type: boolean seen_threads_notification_banner: type: boolean seen_unread_view_coachmark: type: boolean seen_welcome_2: type: boolean separate_private_channels: type: boolean separate_shared_channels: type: boolean shdep_promo_code_submitted: type: boolean show_all_skin_tones: type: boolean show_ent_onboarding: type: boolean show_jumper_scores: type: boolean show_memory_instrument: type: boolean show_sidebar_quickswitcher_button: type: boolean show_typing: type: boolean sidebar_behavior: type: string sidebar_theme: type: string sidebar_theme_custom_values: type: string snippet_editor_wrap_long_lines: type: boolean spaces_new_xp_banner_dismissed: type: boolean ss_emojis: type: boolean ssb_space_window: type: string start_scroll_at_oldest: type: boolean tab_ui_return_selects: type: boolean threads_everything: type: boolean time24: type: boolean two_factor_auth_enabled: type: boolean two_factor_backup_type: type: string nullable: true two_factor_type: type: string nullable: true tz: type: string user_colors: type: string webapp_spellcheck: type: boolean welcome_message_hidden: type: boolean whats_new_read: type: integer format: int32 winssb_run_from_tray: type: boolean winssb_window_flash_behavior: type: string TeamPrefsObject: title: TeamPrefsObject required: - default_channels type: object properties: all_users_can_purchase: type: boolean allow_calls: type: boolean allow_calls_interactive_screen_sharing: type: boolean allow_message_deletion: type: boolean allow_retention_override: type: boolean allow_shared_channel_perms_override: type: boolean app_whitelist_enabled: type: boolean auth_mode: type: string calling_app_name: type: string can_receive_shared_channels_invites: type: boolean compliance_export_start: type: integer format: int32 custom_status_default_emoji: type: string custom_status_presets: minItems: 1 uniqueItems: true type: array items: type: array items: type: string custom_tos: type: boolean default_channels: type: array items: pattern: ^[CGD][A-Z0-9]{8}$ type: string description: '' default_rxns: type: array items: type: string description: '' disable_email_ingestion: type: boolean disable_file_deleting: type: boolean disable_file_editing: type: boolean disable_file_uploads: type: string disallow_public_file_urls: type: boolean discoverable: type: string display_email_addresses: type: boolean display_real_names: type: boolean dm_retention_duration: type: integer format: int32 dm_retention_type: type: integer format: int32 dnd_enabled: type: boolean dnd_end_hour: type: string dnd_start_hour: type: string enable_shared_channels: type: integer format: int32 enterprise_default_channels: type: object enterprise_mandatory_channels: type: object enterprise_mdm_date_enabled: type: integer format: int32 enterprise_mdm_level: type: integer format: int32 enterprise_team_creation_request: $ref: '#/components/schemas/EnterpriseTeamCreationRequest' file_limit_whitelisted: type: boolean file_retention_duration: type: integer format: int32 file_retention_type: type: integer format: int32 gdrive_enabled_team: type: boolean group_retention_duration: type: integer format: int32 group_retention_type: type: integer format: int32 hide_referers: type: boolean invites_limit: type: boolean invites_only_admins: type: boolean locale: type: string loud_channel_mentions_limit: type: integer format: int32 msg_edit_window_mins: type: integer format: int32 require_at_for_mention: type: boolean retention_duration: type: integer format: int32 retention_type: type: integer format: int32 show_join_leave: type: boolean uses_customized_custom_status_presets: type: boolean warn_before_at_channel: type: string who_can_archive_channels: type: string who_can_at_channel: type: string who_can_at_everyone: type: string who_can_change_team_profile: type: string who_can_create_channels: type: string who_can_create_delete_user_groups: type: string who_can_create_groups: type: string who_can_create_shared_channels: type: string who_can_edit_user_groups: type: string who_can_kick_channels: type: string who_can_kick_groups: type: string who_can_manage_guests: $ref: '#/components/schemas/WhoCanManageGuests' who_can_manage_integrations: $ref: '#/components/schemas/WhoCanManageIntegrations' who_can_manage_shared_channels: $ref: '#/components/schemas/WhoCanManageSharedChannels' who_can_post_general: type: string who_can_post_in_shared_channels: $ref: '#/components/schemas/WhoCanPostInSharedChannels' who_has_team_visibility: type: string APImethodusers.getPresence: title: APImethodusers.getPresence required: - ok - presence type: object properties: auto_away: type: boolean connection_count: type: integer format: int32 last_activity: type: integer format: int32 manual_away: type: boolean ok: type: string example: 'True' online: type: boolean presence: type: string description: Generated from users.getPresence with shasum e7251aec575d8863f9e0eb38663ae9dc26655f65 api.permissions.scopes.listsuccessschema: title: api.permissions.scopes.listsuccessschema required: - ok - scopes type: object properties: ok: type: string example: 'True' scopes: $ref: '#/components/schemas/Scopes' description: Schema for successful response api.permissions.scopes.list method api.testerrorschema: title: api.testerrorschema required: - error - ok type: object properties: error: type: string ok: type: string example: 'False' description: Schema for error response api.test method api.testsuccessschema: title: api.testsuccessschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response api.test method apps.permissions.requesterrorschema: title: apps.permissions.requesterrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error' ok: type: string example: 'False' description: Schema for error response from apps.permissions.request method apps.permissions.requestschema: title: apps.permissions.requestschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response from apps.permissions.request method apps.permissions.resources.listerrorschema: title: apps.permissions.resources.listerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error1' ok: type: string example: 'False' description: Schema for error response from apps.permissions.resources.list method apps.permissions.resources.listsuccessschema: title: apps.permissions.resources.listsuccessschema required: - ok - resources type: object properties: ok: type: string example: 'True' resources: type: array items: $ref: '#/components/schemas/Resource' description: '' response_metadata: $ref: '#/components/schemas/ResponseMetadata' description: Schema for successful response apps.permissions.resources.list method apps.permissions.scopes.listerrorschema: title: apps.permissions.scopes.listerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error2' ok: type: string example: 'False' description: Schema for error response from apps.permissions.scopes.list method Attachment: title: Attachment required: - id type: object properties: fallback: type: string id: type: integer format: int32 image_bytes: type: integer format: int32 image_height: type: integer format: int32 image_url: type: string image_width: type: integer format: int32 auth.revokeerrorschema: title: auth.revokeerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error3' ok: type: string example: 'False' description: Schema for error response from auth.revoke method auth.revokeschema: title: auth.revokeschema required: - ok - revoked type: object properties: ok: type: string example: 'True' revoked: type: boolean description: Schema for successful response from auth.revoke method auth.testerrorschema: title: auth.testerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error4' ok: type: string example: 'False' description: Schema for error response auth.test method auth.testsuccessschema: title: auth.testsuccessschema required: - ok - team - team_id - url - user - user_id type: object properties: ok: type: string example: 'True' team: type: string team_id: pattern: ^[T][A-Z0-9]{8}$ type: string url: type: string user: type: string user_id: pattern: ^[UW][A-Z0-9]{8}$ type: string description: Schema for successful response auth.test method Bot: title: Bot required: - app_id - deleted - icons - id - name - updated type: object properties: app_id: pattern: ^A[A-Z0-9]{8}$ type: string deleted: type: boolean icons: $ref: '#/components/schemas/Icons1' id: pattern: ^B[A-Z0-9]{8}$ type: string name: type: string updated: type: integer format: int32 user_id: pattern: ^[UW][A-Z0-9]{8}$ type: string bots.infoerrorschema: title: bots.infoerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error5' ok: type: string example: 'False' description: Schema for error response from bots.info method bots.infoschema: title: bots.infoschema required: - bot - ok type: object properties: bot: $ref: '#/components/schemas/Bot' ok: type: string example: 'True' description: Schema for successful response from bots.info method Channel: title: Channel required: - id type: object properties: created: type: string id: pattern: ^[D][A-Z0-9]{8}$ type: string is_im: type: boolean is_open: type: boolean last_read: pattern: ^\d{10}\.\d{6}$ type: string latest: $ref: '#/components/schemas/Messageobject' unread_count: type: number unread_count_display: type: number user: pattern: ^[UW][A-Z0-9]{8}$ type: string channels.archiveerrorschema: title: channels.archiveerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error6' ok: type: string example: 'False' description: Schema for error response channels.archive method channels.archivesuccessschema: title: channels.archivesuccessschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response from channels.archive method channels.createerrorschema: title: channels.createerrorschema required: - channel - ok type: object properties: channel: $ref: '#/components/schemas/ChannelObject' ok: type: string example: 'True' description: Schema for successful response channels.create method channels.createerrorschema1: title: channels.createerrorschema1 required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error7' ok: type: string example: 'False' description: Schema for error response channels.create method channels.historyerrorschema: title: channels.historyerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error8' ok: type: string example: 'False' description: Schema for error response channels.history method channels.historysuccessschema: title: channels.historysuccessschema required: - has_more - messages - ok type: object properties: has_more: type: boolean messages: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/Messageobject' description: '' ok: type: string example: 'True' description: Schema for successful response channels.history method channels.infoerrorschema: title: channels.infoerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error9' ok: type: string example: 'False' description: Schema for error response channels.info method channels.infosuccessschema: title: channels.infosuccessschema required: - channel - ok type: object properties: channel: $ref: '#/components/schemas/ChannelObject' ok: type: string example: 'True' description: Schema for successful response channels.info method channels.inviteerrorschema: title: channels.inviteerrorschema required: - channel - ok type: object properties: channel: $ref: '#/components/schemas/ChannelObject' ok: type: string example: 'True' description: Schema for successful response channels.invite method channels.inviteerrorschema1: title: channels.inviteerrorschema1 required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error10' ok: type: string example: 'False' description: Schema for error response channels.invite method channels.joinerrorschema: title: channels.joinerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error11' ok: type: string example: 'False' description: Schema for error response from channels.join method channels.joinschema: title: channels.joinschema required: - channel - ok type: object properties: already_in_channel: type: boolean channel: $ref: '#/components/schemas/ChannelObject' ok: type: string example: 'True' description: Schema for successful response from channels.join method channels.kickerrorschema: title: channels.kickerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error12' ok: type: string example: 'False' description: Schema for error response from channels.kick method channels.kickschema: title: channels.kickschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response from channels.kick method channels.listerrorschema: title: channels.listerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error13' ok: type: string example: 'False' description: Schema for error response channels.list method channels.listsuccessschema: title: channels.listsuccessschema required: - channels - ok type: object properties: channels: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/ChannelObject' description: '' ok: type: string example: 'True' description: Schema for successful response channels.list method channels.markerrorschema: title: channels.markerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error14' ok: type: string example: 'False' description: Schema for error response channels.mark method channels.marksuccessschema: title: channels.marksuccessschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response channels.mark method channels.renameerrorschema: title: channels.renameerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error15' ok: type: string example: 'False' description: Schema for error response from channels.rename method channels.renameschema: title: channels.renameschema required: - channel - ok type: object properties: channel: $ref: '#/components/schemas/ChannelObject' ok: type: string example: 'True' description: Schema for successful response from channels.rename method channels.setPurposeerrorschema: title: channels.setPurposeerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error16' ok: type: string example: 'False' description: Schema for error response from channels.setPurpose method channels.setPurposeschema: title: channels.setPurposeschema required: - ok - purpose type: object properties: ok: type: string example: 'True' purpose: type: string description: Schema for successful response from channels.setPurpose method chat.deleteerrorschema: title: chat.deleteerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error17' ok: type: string example: 'False' description: Schema for error response from chat.delete method chat.deletesuccessschema: title: chat.deletesuccessschema required: - channel - ok - ts type: object properties: channel: pattern: ^[CGD][A-Z0-9]{8}$ type: string ok: type: string example: 'True' ts: pattern: ^\d{10}\.\d{6}$ type: string description: Schema for successful response of chat.delete method chat.getPermalinkerrorschema: title: chat.getPermalinkerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error18' ok: type: string example: 'False' description: Schema for error response from chat.getPermalink method chat.getPermalinksuccessschema: title: chat.getPermalinksuccessschema required: - channel - ok - permalink type: object properties: channel: pattern: ^[CGD][A-Z0-9]{8}$ type: string ok: type: string example: 'True' permalink: type: string description: Schema for successful response chat.getPermalink chat.postEphemeralerrorschema: title: chat.postEphemeralerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error19' ok: type: string example: 'False' description: Schema for error response from chat.postEphemeral method chat.postEphemeralsuccessschema: title: chat.postEphemeralsuccessschema required: - message_ts - ok type: object properties: message_ts: pattern: ^\d{10}\.\d{6}$ type: string ok: type: string example: 'True' description: Schema for successful response from chat.postEphemeral method chat.postMessageerrorschema: title: chat.postMessageerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error20' ok: type: string example: 'False' description: Schema for error response chat.postMessage method chat.postMessagesuccessschema: title: chat.postMessagesuccessschema required: - channel - message - ok - ts type: object properties: channel: pattern: ^[CGD][A-Z0-9]{8}$ type: string message: $ref: '#/components/schemas/Messageobject' ok: type: string example: 'True' ts: pattern: ^\d{10}\.\d{6}$ type: string description: Schema for successful response of chat.postMessage method chat.unfurlerrorschema: title: chat.unfurlerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error21' ok: type: string example: 'False' description: Schema for error response from chat.unfurl method chat.unfurlsuccessschema: title: chat.unfurlsuccessschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response from chat.unfurl method chat.updateerrorschema: title: chat.updateerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error22' ok: type: string example: 'False' description: Schema for error response chat.update method chat.updatesuccessschema: title: chat.updatesuccessschema required: - channel - ok - text - ts type: object properties: channel: pattern: ^[CGD][A-Z0-9]{8}$ type: string ok: type: string example: 'True' text: type: string ts: pattern: ^\d{10}\.\d{6}$ type: string description: Schema for successful response of chat.update method Conversationobject: title: Conversationobject required: - created - creator - id - is_archived - is_channel - is_general - is_group - is_im - is_mpim - is_org_shared - is_private - is_shared - name - name_normalized - purpose - topic type: object properties: accepted_user: pattern: ^[UW][A-Z0-9]{8}$ type: string created: type: integer format: int32 creator: pattern: ^[UW][A-Z0-9]{8}$ type: string display_counts: $ref: '#/components/schemas/DisplayCounts' has_pins: type: boolean id: pattern: ^[CGD][A-Z0-9]{8}$ type: string is_archived: type: boolean is_channel: type: boolean is_ext_shared: type: boolean is_general: type: boolean is_group: type: boolean is_im: type: boolean is_member: type: boolean is_moved: type: integer format: int32 is_mpim: type: string example: 'False' 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 last_read: pattern: ^\d{10}\.\d{6}$ type: string latest: type: array items: $ref: '#/components/schemas/Messageobject' description: '' members: minItems: 0 uniqueItems: true type: array items: pattern: ^[UW][A-Z0-9]{8}$ type: string description: '' name: type: string name_normalized: type: string num_members: type: integer format: int32 pending_shared: minItems: 0 uniqueItems: true type: array items: pattern: ^[T][A-Z0-9]{8}$ type: string description: '' pin_count: type: integer format: int32 previous_names: minItems: 0 uniqueItems: true type: array items: type: string description: '' priority: type: integer format: int32 purpose: $ref: '#/components/schemas/Purpose' shared_team_ids: minItems: 0 uniqueItems: true type: array items: pattern: ^[T][A-Z0-9]{8}$ type: string description: '' shares: minItems: 0 uniqueItems: true type: array items: $ref: '#/components/schemas/Share' description: '' timezone_count: type: integer format: int32 topic: $ref: '#/components/schemas/Topic' unlinked: type: integer format: int32 unread_count: type: integer format: int32 unread_count_display: type: integer format: int32 user: pattern: ^[UW][A-Z0-9]{8}$ type: string conversations.archiveerrorschema: title: conversations.archiveerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error23' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from conversations.archive method conversations.archivesuccessschema: title: conversations.archivesuccessschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response conversations.archive method conversations.closeerrorschema: title: conversations.closeerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error24' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from conversations.close method conversations.closesuccessschema: title: conversations.closesuccessschema required: - ok type: object properties: already_closed: type: boolean no_op: type: boolean ok: type: string example: 'True' description: Schema for successful response conversations.close method conversations.createerrorschema: title: conversations.createerrorschema required: - error - ok type: object properties: detail: type: string error: $ref: '#/components/schemas/Error25' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from conversations.create method conversations.createsuccessschema: title: conversations.createsuccessschema required: - channel - ok type: object properties: channel: type: array items: $ref: '#/components/schemas/Conversationobject' description: '' ok: type: string example: 'True' description: Schema for successful response conversations.create method conversations.historyerrorschema: title: conversations.historyerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error26' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from conversations.history method conversations.historysuccessschema: title: conversations.historysuccessschema required: - has_more - messages - ok - pin_count type: object properties: has_more: type: boolean messages: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/Messageobject' description: '' ok: type: string example: 'True' pin_count: type: integer format: int32 description: Schema for successful response from conversations.history method conversations.infoerrorschema: title: conversations.infoerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error27' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from conversations.info method conversations.infosuccessschema: title: conversations.infosuccessschema required: - channel - ok type: object properties: channel: type: array items: $ref: '#/components/schemas/Conversationobject' description: '' ok: type: string example: 'True' description: Schema for successful response conversations.info conversations.inviteerrorschema: title: conversations.inviteerrorschema required: - channel - ok type: object properties: channel: type: array items: $ref: '#/components/schemas/Conversationobject' description: '' ok: type: string example: 'True' description: Schema for successful response from conversations.invite method conversations.inviteerrorschema1: title: conversations.inviteerrorschema1 required: - ok type: object properties: error: $ref: '#/components/schemas/Error28' errors: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/errorsisreturnedwhenanerrorassociatesanuser' description: '' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from conversations.invite method conversations.joinerrorschema: title: conversations.joinerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error30' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from conversations.join method conversations.joinsuccessschema: title: conversations.joinsuccessschema required: - channel - ok type: object properties: channel: type: array items: $ref: '#/components/schemas/Conversationobject' description: '' ok: type: string example: 'True' response_metadata: $ref: '#/components/schemas/Responsemetadata1' warning: type: string description: Schema for successful response from conversations.join method conversations.kickerrorschema: title: conversations.kickerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error31' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response conversations.kick method conversations.kicksuccessschema: title: conversations.kicksuccessschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response conversations.kick method conversations.leaveerrorschema: title: conversations.leaveerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error32' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from conversations.leave method conversations.leavesuccessschema: title: conversations.leavesuccessschema required: - ok type: object properties: not_in_channel: type: boolean ok: type: string example: 'True' description: Schema for successful response from conversations.leave method conversations.listerrorschema: title: conversations.listerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error33' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from conversations.list method conversations.listsuccessschema: title: conversations.listsuccessschema required: - channels - ok type: object properties: channels: uniqueItems: true type: array items: type: array items: $ref: '#/components/schemas/Conversationobject' ok: type: string example: 'True' response_metadata: $ref: '#/components/schemas/ResponseMetadata' description: Schema for successful response from conversations.list method conversations.memberserrorschema: title: conversations.memberserrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error34' ok: type: string example: 'False' description: Schema for error response conversations.members method conversations.memberssuccessschema: title: conversations.memberssuccessschema required: - members - ok - response_metadata type: object properties: members: minItems: 1 uniqueItems: true type: array items: pattern: ^[UW][A-Z0-9]{8}$ type: string description: '' ok: type: string example: 'True' response_metadata: $ref: '#/components/schemas/ResponseMetadata' description: Schema for successful response conversations.members method conversations.openerrorschema: title: conversations.openerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error35' ok: type: string example: 'False' description: Schema for error response from conversations.open method conversations.opensuccessschema: title: conversations.opensuccessschema required: - channel - ok type: object properties: already_open: type: boolean channel: type: array items: $ref: '#/components/schemas/Conversationobject' description: '' no_op: type: boolean ok: type: string example: 'True' description: Schema for successful response from conversations.open method when opening channels, ims, mpims conversations.renameerrorschema: title: conversations.renameerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error36' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from conversations.rename method conversations.renamesuccessschema: title: conversations.renamesuccessschema required: - channel - ok type: object properties: channel: type: array items: $ref: '#/components/schemas/Conversationobject' description: '' ok: type: string example: 'True' description: Schema for successful response from conversations.rename method conversations.replieserrorschema: title: conversations.replieserrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error37' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from conversations.replies method conversations.repliessuccessschema: title: conversations.repliessuccessschema required: - messages - ok type: object properties: has_more: type: boolean messages: type: array items: type: array items: $ref: '#/components/schemas/Message' ok: type: string example: 'True' description: Schema for successful response from conversations.replies method conversations.setPurposeerrorschema: title: conversations.setPurposeerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error38' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from conversations.setPurpose method conversations.setPurposesuccessschema: title: conversations.setPurposesuccessschema required: - channel - ok type: object properties: channel: type: array items: $ref: '#/components/schemas/Conversationobject' description: '' ok: type: string example: 'True' description: Schema for successful response from conversations.setPurpose method conversations.setTopicerrorschema: title: conversations.setTopicerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error38' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from conversations.setTopic method conversations.setTopicsuccessschema: title: conversations.setTopicsuccessschema required: - channel - ok type: object properties: channel: type: array items: $ref: '#/components/schemas/Conversationobject' description: '' ok: type: string example: 'True' description: Schema for successful response from conversations.setTopic method conversations.unarchiveerrorschema: title: conversations.unarchiveerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error40' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from conversations.unarchive method conversations.unarchivesuccessschema: title: conversations.unarchivesuccessschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response from conversations.unarchive method Defaultsuccesstemplate: title: Defaultsuccesstemplate required: - ok type: object properties: ok: type: string example: 'True' description: Verbose schema not yet ready for this method. DisplayCounts: title: DisplayCounts required: - display_counts - guest_counts type: object properties: display_counts: type: integer format: int32 guest_counts: type: integer format: int32 dnd.teamInfoerrorschema: title: dnd.teamInfoerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error41' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from dnd.teamInfo method dnd.teamInfosuccessschema: title: dnd.teamInfosuccessschema required: - ok - users type: object properties: cached: type: boolean ok: type: string example: 'True' users: type: object description: Schema for successful response from dnd.teamInfo method EnterpriseTeamCreationRequest: title: EnterpriseTeamCreationRequest required: - is_enabled type: object properties: is_enabled: type: boolean Error: title: 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 Error1: title: Error1 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 Error2: title: Error2 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 Error3: title: Error3 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 Error4: title: Error4 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 Error5: title: Error5 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 Error6: title: Error6 enum: - 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 Error7: title: Error7 enum: - 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 - 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 Error8: title: Error8 enum: - 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 Error9: title: Error9 enum: - channel_not_found - 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 - team_added_to_org - missing_charset - superfluous_charset type: string Error10: title: Error10 enum: - channel_not_found - user_not_found - cant_invite_self - not_in_channel - already_in_channel - is_archived - cant_invite - too_many_users - ura_max_channels - 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 Error11: title: Error11 enum: - channel_not_found - name_taken - restricted_action - no_channel - is_archived - invalid_name_required - invalid_name_punctuation - invalid_name_maxlength - invalid_name_specials - invalid_name - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - 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 - fatal_error type: string Error12: title: Error12 enum: - channel_not_found - user_not_found - cant_kick_self - not_in_channel - cant_kick_from_general - restricted_action - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - 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 - fatal_error type: string Error13: title: Error13 enum: - 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 Error14: title: Error14 enum: - channel_not_found - invalid_timestamp - not_in_channel - 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 Error15: title: Error15 enum: - channel_not_found - not_in_channel - not_authorized - invalid_name - name_taken - invalid_name_required - invalid_name_punctuation - invalid_name_maxlength - invalid_name_specials - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - 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 - fatal_error type: string Error16: title: Error16 enum: - channel_not_found - not_in_channel - is_archived - too_long - user_is_restricted - 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 Error17: title: Error17 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 Error18: title: Error18 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 Error19: title: Error19 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 Error20: title: Error20 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 Error21: title: Error21 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 Error22: title: Error22 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 type: string Error23: title: Error23 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 Error24: title: Error24 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 Error25: title: Error25 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 Error26: title: Error26 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 Error27: title: Error27 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 Error28: title: Error28 enum: - method_not_supported_for_channel_type - missing_scope - channel_not_found - user_not_found - cant_invite_self - not_in_channel - already_in_channel - is_archived - cant_invite - too_many_users - ura_max_channels - 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 Error30: title: Error30 enum: - method_not_supported_for_channel_type - missing_scope - channel_not_found - is_archived - 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 Error31: title: Error31 enum: - method_not_supported_for_channel_type - missing_scope - channel_not_found - user_not_found - cant_kick_self - not_in_channel - cant_kick_from_general - restricted_action - 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 - invalid_json - json_not_object - request_timeout - upgrade_required type: string Error32: title: Error32 enum: - method_not_supported_for_channel_type - last_member - missing_scope - channel_not_found - is_archived - cant_leave_general - 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 Error33: title: Error33 enum: - 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 - invalid_json - json_not_object - request_timeout - upgrade_required type: string Error34: title: Error34 enum: - channel_not_found - invalid_limit - invalid_cursor - fetch_members_failed - 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 Error35: title: Error35 enum: - method_not_supported_for_channel_type - user_not_found - user_not_visible - user_disabled - users_list_not_supplied - not_enough_users - too_many_users - 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 - channel_not_found type: string Error36: title: Error36 enum: - user_is_restricted - method_not_supported_for_channel_type - missing_scope - channel_not_found - not_in_channel - not_authorized - invalid_name - name_taken - invalid_name_required - invalid_name_punctuation - invalid_name_maxlength - invalid_name_specials - 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 Error37: title: Error37 enum: - missing_scope - channel_not_found - thread_not_found - 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 Error38: title: Error38 enum: - method_not_supported_for_channel_type - missing_scope - channel_not_found - not_in_channel - is_archived - too_long - user_is_restricted - 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 Error40: title: Error40 enum: - method_not_supported_for_channel_type - missing_scope - channel_not_found - not_archived - 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 Error41: title: Error41 enum: - 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 - request_timeout - upgrade_required type: string Error42: title: Error42 enum: - file_not_found - file_deleted - no_comment - cant_add - not_authed - invalid_auth - account_inactive - no_permission - 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 Error43: title: Error43 enum: - cant_delete - comment_not_found - not_authed - invalid_auth - account_inactive - no_permission - 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 Error44: title: Error44 enum: - cant_edit - comment_not_found - not_authed - invalid_auth - account_inactive - no_permission - 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 Error45: title: Error45 enum: - file_not_found - file_deleted - cant_delete_file - not_authed - invalid_auth - account_inactive - 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 type: string Error46: title: Error46 enum: - file_not_found - file_deleted - timezone_count_failed - not_authed - invalid_auth - account_inactive - 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 type: string Error47: title: Error47 enum: - user_not_found - unknown_type - not_authed - invalid_auth - account_inactive - no_permission - 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 type: string Error48: title: Error48 enum: - posting_to_general_channel_denied - invalid_channel - file_uploads_disabled - file_uploads_except_images_disabled - storage_limit_reached - not_authed - invalid_auth - account_inactive - 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 type: string Error49: title: Error49 enum: - channel_not_found - already_archived - group_contains_others - restricted_action - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - user_is_bot - user_is_ultra_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 - fatal_error type: string Error50: title: Error50 enum: - no_channel - restricted_action - name_taken - 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_ultra_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 Error51: title: Error51 enum: - 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 - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required type: string Error52: title: Error52 enum: - channel_not_found - 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 Error53: title: Error53 enum: - channel_not_found - user_not_found - cant_invite_self - is_archived - cant_invite - ura_max_channels - not_authed - invalid_auth - account_inactive - user_is_bot - user_is_ultra_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 Error54: title: Error54 enum: - channel_not_found - user_not_found - cant_kick_self - not_in_group - restricted_action - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - 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 - fatal_error type: string Error56: title: Error56 enum: - channel_not_found - invalid_timestamp - 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 Error57: title: Error57 enum: - channel_not_found - is_archived - too_long - user_is_restricted - 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 Error60: title: Error60 enum: - invalid_cursor - not_authed - invalid_auth - account_inactive - 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 type: string Error62: title: Error62 enum: - user_not_found - user_not_visible - user_disabled - not_authed - invalid_auth - account_inactive - 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 type: string Error63: title: Error63 enum: - not_enterprise_team - too_many_users - 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 Error64: title: Error64 enum: - channel_not_found - invalid_timestamp - 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 Error65: title: Error65 enum: - users_list_not_supplied - not_enough_users - too_many_users - not_authed - invalid_auth - account_inactive - 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 type: string Error66: title: Error66 enum: - bad_timestamp - file_not_found - file_comment_not_found - message_not_found - channel_not_found - no_item_specified - already_pinned - permission_denied - file_not_shared - not_pinnable - not_authed - invalid_auth - account_inactive - 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 type: string Error67: title: Error67 enum: - channel_not_found - not_authed - invalid_auth - account_inactive - 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 type: string Error68: title: Error68 enum: - bad_timestamp - file_not_found - file_comment_not_found - message_not_found - no_item_specified - not_pinned - permission_denied - not_authed - invalid_auth - account_inactive - no_permission - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_typ - missing_post_typ - team_added_to_org - invalid_json - json_not_object - request_timeou - upgrade_required type: string Error69: title: Error69 enum: - bad_timestamp - file_not_found - file_comment_not_found - message_not_found - no_item_specified - invalid_name - already_reacted - too_many_emoji - too_many_reactions - not_authed - invalid_auth - account_inactive - 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 type: string Error70: title: Error70 enum: - bad_timestamp - file_not_found - file_comment_not_found - message_not_found - no_item_specified - not_authed - invalid_auth - account_inactive - no_permission - 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 Error71: title: Error71 enum: - user_not_found - not_authed - invalid_auth - account_inactiv - 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 Error72: title: Error72 enum: - bad_timestamp - file_not_found - file_comment_not_found - message_not_found - no_item_specified - invalid_name - no_reaction - not_authed - invalid_auth - account_inactive - 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 Error73: title: Error73 enum: - 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 Error74: title: Error74 enum: - migration_in_progress - 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 Error75: title: Error75 enum: - not_authed - invalid_auth - account_inactive - token_revokedno_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 Error76: title: Error76 enum: - not_authed - invalid_auth - account_inactive - no_permission - user_is_bot - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_typ - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeou - upgrade_required type: string Error77: title: Error77 enum: - method_not_supported_for_channel_type - missing_scope - invalid_types - invalid_cursor - invalid_limit - 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 Error79: title: Error79 enum: - user_not_found - user_not_visible - 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 Error80: title: Error80 enum: - invalid_cursor - not_authed - invalid_auth - account_inactive - 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 Error81: title: Error81 enum: - users_not_found - not_authed - invalid_auth - account_inactive - 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 Error82: title: Error82 enum: - user_not_found - 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 Error83: title: Error83 enum: - reserved_name - invalid_profile - profile_set_failed - not_admin - not_app_admin - cannot_update_admin_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 errorsisreturnedwhenanerrorassociatesanuser: title: errorsisreturnedwhenanerrorassociatesanuser required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error28' ok: type: string example: 'False' user: pattern: ^[UW][A-Z0-9]{8}$ type: string FileCommentPin: title: FileCommentPin type: object properties: comment: $ref: '#/components/schemas/FileCommentObject' created: type: integer format: int32 created_by: pattern: ^[UW][A-Z0-9]{8}$ type: string file: $ref: '#/components/schemas/fileobject' type: $ref: '#/components/schemas/Type1' files.comments.adderrorschema: title: files.comments.adderrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error42' ok: type: string example: 'False' description: Schema for error response from files.comments.add method files.comments.addschema: title: files.comments.addschema required: - comment - ok type: object properties: comment: $ref: '#/components/schemas/FileCommentObject' ok: type: string example: 'True' description: Schema for successful response files.comments.add method files.comments.deleteerrorschema: title: files.comments.deleteerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error43' ok: type: string example: 'False' description: Schema for error response files.comments.delete method files.comments.deleteschema: title: files.comments.deleteschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response files.comments.delete method files.comments.editerrorschema: title: files.comments.editerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error44' ok: type: string example: 'False' description: Schema for error response files.comments.edit method files.comments.editschema: title: files.comments.editschema required: - comment - ok type: object properties: comment: $ref: '#/components/schemas/FileCommentObject' ok: type: string example: 'True' description: Schema for successful response files.comments.edit method files.deleteerrorschema: title: files.deleteerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error45' ok: type: string example: 'False' description: Schema for error response files.delete method files.deleteschema: title: files.deleteschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response files.delete method files.infoerrorschema: title: files.infoerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error46' ok: type: string example: 'False' description: Schema for error response from files.info method files.infoschema: title: files.infoschema required: - comments - file - ok - paging type: object properties: comments: type: array items: type: object description: '' file: $ref: '#/components/schemas/fileobject' ok: type: string example: 'True' paging: $ref: '#/components/schemas/pagingobjectforfiles' description: Schema for successful response from files.info method files.listerrorschema: title: files.listerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error47' ok: type: string example: 'False' description: Schema for error response from files.list method files.listschema: title: files.listschema required: - files - ok - paging type: object properties: files: minItems: 0 uniqueItems: true type: array items: $ref: '#/components/schemas/fileobject' description: '' ok: type: string example: 'True' paging: $ref: '#/components/schemas/pagingobjectforfiles' description: Schema for successful response from files.list method files.uploaderrorschema: title: files.uploaderrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error48' ok: type: string example: 'False' description: Schema for error response files.upload method files.uploadschema: title: files.uploadschema required: - file - ok type: object properties: file: $ref: '#/components/schemas/fileobject' ok: type: string example: 'True' description: Schema for successful response files.upload method groups.archiveerrorschema: title: groups.archiveerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error49' ok: type: string example: 'False' description: Schema for error response from groups.archive method groups.archiveschema: title: groups.archiveschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response from groups.archive method groups.createerrorschema: title: groups.createerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error50' ok: type: string example: 'False' description: Schema for error response groups.create method groups.createsuccessschema: title: groups.createsuccessschema required: - group - ok type: object properties: group: $ref: '#/components/schemas/Groupobject' ok: type: string example: 'True' description: Schema for successful response groups.create method groups.historyerrorschema: title: groups.historyerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error51' ok: type: string example: 'False' description: Schema for error response groups.history method groups.historysuccessschema: title: groups.historysuccessschema required: - has_more - messages - ok type: object properties: has_more: type: boolean messages: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/Messageobject' description: '' ok: type: string example: 'True' description: Schema for successful response groups.history method groups.infoerrorschema: title: groups.infoerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error52' ok: type: string example: 'False' description: Schema for error response groups.info method groups.infosuccessschema: title: groups.infosuccessschema required: - group - ok type: object properties: group: $ref: '#/components/schemas/Groupobject' ok: type: string example: 'True' description: Schema for successful response groups.info method groups.inviteerrorschema: title: groups.inviteerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error53' ok: type: string example: 'False' description: Schema for error response groups.invite method groups.invitesuccessschema: title: groups.invitesuccessschema required: - group - ok type: object properties: group: $ref: '#/components/schemas/Groupobject' ok: type: string example: 'True' description: Schema for successful response groups.invite method groups.kickerrorschema: title: groups.kickerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error54' ok: type: string example: 'False' description: Schema for error response from groups.kick method groups.kickschema: title: groups.kickschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response from groups.kick method groups.listerrorschema: title: groups.listerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error13' ok: type: string example: 'False' description: Schema for error response groups.list method groups.listsuccessschema: title: groups.listsuccessschema required: - groups - ok type: object properties: groups: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/Groupobject' description: '' ok: type: string example: 'True' description: Schema for successful response groups.list method groups.markerrorschema: title: groups.markerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error56' ok: type: string example: 'False' description: Schema for error response from groups.mark method groups.marksuccessschema: title: groups.marksuccessschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response from groups.mark method groups.setPurposeerrorschema: title: groups.setPurposeerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error57' ok: type: string example: 'False' description: Schema for error response from groups.setPurpose method groups.setPurposeschema: title: groups.setPurposeschema required: - ok - purpose type: object properties: ok: type: string example: 'True' purpose: type: string description: Schema for successful response from groups.setPurpose method groups.setTopicerrorschema: title: groups.setTopicerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error57' ok: type: string example: 'False' description: Schema for error response from groups.setTopic method groups.setTopicschema: title: groups.setTopicschema required: - ok - topic type: object properties: ok: type: string example: 'True' topic: type: string description: Schema for successful response from groups.setTopic method Icon: title: Icon type: object 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 Icons: title: Icons type: object properties: emoji: type: string Icons1: title: Icons1 required: - image_36 - image_48 - image_72 type: object properties: image_36: type: string image_48: type: string image_72: type: string im.historyerrorschema: title: im.historyerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error8' needed: type: string ok: type: string example: 'False' provided: type: string description: Schema for error response from im.history method im.historysuccessschema: title: im.historysuccessschema required: - has_more - messages - ok type: object properties: has_more: type: boolean messages: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/Messageobject' description: '' ok: type: string example: 'True' description: Schema for successful response from im.history method im.listerrorschema: title: im.listerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error60' ok: type: string example: 'False' description: Schema for error response from im.list method im.listsuccessschema: title: im.listsuccessschema required: - ims - ok type: object properties: ims: uniqueItems: true type: array items: $ref: '#/components/schemas/IMObject' description: '' ok: type: string example: 'True' description: Schema for successful response im.list method im.markerrorschema: title: im.markerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error14' ok: type: string example: 'False' description: Schema for error response im.mark method im.marksuccessschema: title: im.marksuccessschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response im.mark method im.openerrorschema: title: im.openerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error62' ok: type: string example: 'False' description: Schema for error response from im.open method im.opensuccessschema: title: im.opensuccessschema required: - channel - ok type: object properties: already_open: type: boolean channel: $ref: '#/components/schemas/Channel' no_op: type: boolean ok: type: string example: 'True' description: Schema for successful response from im.open method Infoforapinneditem: title: Infoforapinneditem required: - pinned_by - pinned_ts type: object properties: pinned_by: pattern: ^[UW][A-Z0-9]{8}$ type: string pinned_ts: type: integer format: int32 Item: title: Item required: - channel - message - type type: object properties: channel: pattern: ^[CGD][A-Z0-9]{8}$ type: string message: $ref: '#/components/schemas/Messageobject' type: type: string example: message LocalesEnabled: title: LocalesEnabled type: object properties: de-DE: type: string en-US: type: string es-ES: type: string fr-FR: type: string ja-JP: type: string pseudo: type: string Message: title: Message required: - replies - reply_count - subscribed - text - thread_ts - ts - type - user type: object properties: last_read: pattern: ^\d{10}\.\d{6}$ type: string replies: type: array items: $ref: '#/components/schemas/Reply' description: '' reply_count: type: integer format: int32 source_team: pattern: ^[T][A-Z0-9]{8}$ type: string subscribed: type: boolean team: pattern: ^[T][A-Z0-9]{8}$ type: string text: type: string thread_ts: pattern: ^\d{10}\.\d{6}$ type: string ts: pattern: ^\d{10}\.\d{6}$ type: string type: type: string unread_count: type: integer format: int32 user: pattern: ^[UW][A-Z0-9]{8}$ type: string user_profile: $ref: '#/components/schemas/objs_user_profile_short' user_team: pattern: ^[T][A-Z0-9]{8}$ type: string migration.exchangeerrorschema: title: migration.exchangeerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error63' ok: type: string example: 'False' description: Schema for error response from migration.exchange method migration.exchangesuccessschema: title: migration.exchangesuccessschema required: - enterprise_id - ok - team_id type: object properties: enterprise_id: type: string invalid_user_ids: type: array items: type: string description: '' ok: type: string example: 'True' team_id: pattern: ^[T][A-Z0-9]{8}$ type: string user_id_map: type: object description: Schema for successful response from migration.exchange method mpim.markerrorschema: title: mpim.markerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error64' ok: type: string example: 'False' description: Schema for error response from mpim.mark method mpim.markschema: title: mpim.markschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response from mpim.mark method mpim.openerrorschema: title: mpim.openerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error65' ok: type: string example: 'False' description: Schema for error response from mpim.open method mpim.opensuccessschema: title: mpim.opensuccessschema required: - group - ok type: object properties: group: $ref: '#/components/schemas/Groupobject' ok: type: string example: 'True' description: Schema for successful response from mpim.open method pins.adderrorschema: title: pins.adderrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error66' ok: type: string example: 'False' description: Schema for error response from pins.add method pins.addschema: title: pins.addschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response from pins.add method pins.listerrorschema: title: pins.listerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error67' ok: type: string example: 'False' description: Schema for error response from pins.list method pins.listsuccessschema: title: pins.listsuccessschema required: - items - ok type: object properties: items: uniqueItems: true type: array items: $ref: '#/components/schemas/FileCommentPin' description: '' ok: type: string example: 'True' pins.removeerrorschema: title: pins.removeerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error68' ok: type: string example: 'False' description: Schema for error response from pins.remove method pins.removeschema: title: pins.removeschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response from pins.remove method Profile: title: Profile required: - fields type: object properties: fields: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/objs_team_profile_field' description: '' Purpose: title: Purpose required: - creator - last_set - value type: object properties: creator: pattern: ^[UW][A-Z0-9]{8}$|^$ type: string last_set: type: integer format: int32 value: type: string reactions.adderrorschema: title: reactions.adderrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error69' ok: type: string example: 'False' description: Schema for error response from reactions.add method reactions.addschema: title: reactions.addschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response from reactions.add method reactions.geterrorschema: title: reactions.geterrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error70' ok: type: string example: 'False' description: Schema for error response from reactions.get method reactions.getsuccessschema: title: reactions.getsuccessschema required: - channel - message - ok - type type: object properties: channel: pattern: ^[CGD][A-Z0-9]{8}$ type: string message: $ref: '#/components/schemas/Messageobject' ok: type: string example: 'True' type: type: string example: message reactions.listerrorschema: title: reactions.listerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error71' ok: type: string example: 'False' description: Schema for error response from reactions.list method reactions.listschema: title: reactions.listschema required: - items - ok type: object properties: items: type: array items: type: array items: $ref: '#/components/schemas/Item' ok: type: string example: 'True' paging: $ref: '#/components/schemas/pagingobjectforfiles' description: Schema for successful response from reactions.list method reactions.removeerrorschema: title: reactions.removeerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error72' ok: type: string example: 'False' description: Schema for error response from reactions.remove method reactions.removeschema: title: reactions.removeschema required: - ok type: object properties: ok: type: string example: 'True' description: Schema for successful response from reactions.remove method Reply: title: Reply required: - ts - user type: object properties: ts: pattern: ^\d{10}\.\d{6}$ type: string user: pattern: ^[UW][A-Z0-9]{8}$ type: string Resource: title: Resource type: object properties: id: type: string type: type: string Responsemetadata1: title: Responsemetadata1 type: object properties: warnings: minItems: 1 uniqueItems: true type: array items: type: string description: '' ResponseMetadata: title: ResponseMetadata required: - next_cursor type: object properties: next_cursor: type: string rtm.connecterrorschema: title: rtm.connecterrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error73' ok: type: string example: 'False' description: Schema for error response from rtm.connect method rtm.connectschema: title: rtm.connectschema required: - ok - self - team - url type: object properties: ok: type: string example: 'True' self: $ref: '#/components/schemas/Self' team: $ref: '#/components/schemas/Team' url: type: string description: Schema for successful response from rtm.connect method rtm.starterrorschema: title: rtm.starterrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error74' ok: type: string example: 'False' description: Schema for error response from rtm.start method rtm.startsuccessschema: title: rtm.startsuccessschema required: - bots - cache_ts - cache_ts_version - can_manage_shared_channels - channels - dnd - groups - ims - latest_event_ts - non_threadable_channels - ok - read_only_channels - self - subteams - team - thread_only_channels - url - users type: object properties: bots: type: object cache_ts: type: integer format: int32 cache_ts_version: type: string cache_version: type: string can_manage_shared_channels: type: boolean channels: minItems: 1 uniqueItems: true type: array items: type: array items: $ref: '#/components/schemas/Conversationobject' dead_pig: type: boolean dnd: $ref: '#/components/schemas/objs_dnd' groups: uniqueItems: true type: array items: type: array items: type: string nullable: true ims: minItems: 1 uniqueItems: true type: array items: type: array items: $ref: '#/components/schemas/Conversationobject' latest_event_ts: type: string mpims: uniqueItems: true type: array items: type: array items: type: string nullable: true non_threadable_channels: type: object ok: type: string example: 'True' read_only_channels: type: object self: $ref: '#/components/schemas/Self1' subteams: $ref: '#/components/schemas/Subteams' team: $ref: '#/components/schemas/TeamObject' thread_only_channels: type: object url: type: string users: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/objs_user' description: '' description: Schema for successful response from rtm.start method Scopes: title: Scopes type: object properties: app_home: type: array items: type: string description: '' channel: type: array items: type: string description: '' group: type: array items: type: string description: '' im: type: array items: type: string description: '' mpim: type: array items: type: string description: '' team: type: array items: type: string description: '' user: type: array items: type: string description: '' Self: title: Self required: - id - name type: object properties: id: pattern: ^[UW][A-Z0-9]{8}$ type: string name: type: string Self1: title: Self1 required: - created - id - manual_presence - prefs type: object properties: created: type: integer format: int32 id: type: string manual_presence: type: string name: type: string prefs: $ref: '#/components/schemas/UserPrefsobject' Share: title: Share required: - accepted_user - is_active - team - user type: object properties: accepted_user: pattern: ^[UW][A-Z0-9]{8}$ type: string is_active: type: boolean team: $ref: '#/components/schemas/TeamObject' user: pattern: ^[UW][A-Z0-9]{8}$ type: string Subteams: title: Subteams required: - all - self type: object properties: all: type: object self: type: object Team: title: Team required: - domain - id - name type: object properties: domain: type: string id: pattern: ^[T][A-Z0-9]{8}$ type: string name: type: string team.infoerrorschema: title: team.infoerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error75' ok: type: string example: 'False' description: Schema for error response from team.info method team.infoschema: title: team.infoschema required: - ok - team type: object properties: ok: type: string example: 'True' team: $ref: '#/components/schemas/TeamObject' description: Schema for successful response from team.info method team.profile.geterrorschema: title: team.profile.geterrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error76' ok: type: string example: 'False' description: Schema for error response from team.profile.get method team.profile.getsuccessschema: title: team.profile.getsuccessschema required: - ok - profile type: object properties: ok: type: string example: 'True' profile: $ref: '#/components/schemas/Profile' description: Schema for successful response from team.profile.get method Team1: title: Team1 required: - id type: object properties: id: pattern: ^[T][A-Z0-9]{8}$ type: string Topic: title: Topic required: - creator - last_set - value type: object properties: creator: pattern: ^[UW][A-Z0-9]{8}$|^$ type: string last_set: type: integer format: int32 value: type: string Type: title: Type enum: - text - date - link - mailto - options_list - user type: string Type1: title: Type1 enum: - file_comment type: string User: title: User required: - id - name type: object properties: id: pattern: ^[UW][A-Z0-9]{8}$ type: string name: type: string users.conversationserrorschema: title: users.conversationserrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error77' ok: type: string example: 'False' description: Schema for error response from users.conversations method users.conversationssuccessschema: title: users.conversationssuccessschema required: - channels - ok type: object properties: channels: uniqueItems: true type: array items: type: array items: $ref: '#/components/schemas/Conversationobject' ok: type: string example: 'True' response_metadata: $ref: '#/components/schemas/ResponseMetadata' description: Schema for successful response from users.conversations method. Returned conversation objects do not include `num_members` or `is_member` users.countserrorschema: title: users.countserrorschema required: - error - ok type: object properties: error: type: string ok: type: string example: 'False' description: Schema for error response users.getPresence method users.identityerrorschema: title: users.identityerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error2' ok: type: string example: 'False' description: Schema for error response from users.identity method users.identityschema: title: users.identityschema required: - ok - team - user type: object properties: ok: type: string example: 'True' team: $ref: '#/components/schemas/Team1' user: $ref: '#/components/schemas/User' description: Schema for 'identity.basic' scope users.infoerrorschema: title: users.infoerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error79' ok: type: string example: 'False' description: Schema for error response from users.info method users.infosuccessschema: title: users.infosuccessschema required: - ok - user type: object properties: ok: type: string example: 'True' user: $ref: '#/components/schemas/objs_user' description: Schema for successful response from users.info method users.listerrorschema: title: users.listerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error80' ok: type: string example: 'False' description: Schema for error response from users.list method users.listschema: title: users.listschema required: - cache_ts - members - ok type: object properties: cache_ts: type: integer format: int32 members: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/objs_user' description: '' ok: type: string example: 'True' description: Schema for successful response from users.list method users.lookupByEmailerrorschema: title: users.lookupByEmailerrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error81' ok: type: string example: 'False' description: Schema for error response from users.lookupByEmail method users.lookupByEmailsuccessschema: title: users.lookupByEmailsuccessschema required: - ok - user type: object properties: ok: type: string example: 'True' user: $ref: '#/components/schemas/objs_user' description: Schema for successful response from users.lookupByEmail method users.profile.geterrorschema: title: users.profile.geterrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error82' ok: type: string example: 'False' description: Schema for error response from users.profile.get method users.profile.getschema: title: users.profile.getschema required: - ok - profile type: object properties: ok: type: string example: 'True' profile: $ref: '#/components/schemas/Userprofileobject' description: Schema for successful response from users.profile.get method users.profile.seterrorschema: title: users.profile.seterrorschema required: - error - ok type: object properties: error: $ref: '#/components/schemas/Error83' ok: type: string example: 'False' description: Schema for error response from users.profile.set method users.profile.setschema: title: users.profile.setschema required: - ok - profile - username type: object properties: ok: type: string example: 'True' profile: $ref: '#/components/schemas/Userprofileobject' username: type: string description: Schema for successful response from users.profile.set method WhoCanManageGuests: title: WhoCanManageGuests required: - type type: object properties: type: type: array items: type: string description: '' WhoCanManageIntegrations: title: WhoCanManageIntegrations required: - type type: object properties: type: type: array items: type: string description: '' WhoCanManageSharedChannels: title: WhoCanManageSharedChannels required: - type type: object properties: type: type: array items: type: string description: '' WhoCanPostInSharedChannels: title: WhoCanPostInSharedChannels required: - type type: object properties: type: type: array items: type: string description: '' securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://slack.com/api/authorize tokenUrl: https://slack.com/api/oauth.access scopes: admin: admin bot: Bot user scope channels:history: channels:history channels:read: channels:read channels:write: channels:write chat:write: chat:write chat:write:bot: Author messages as a bot chat:write:user: chat:write:user conversations:history: conversations:history conversations:read: conversations:read conversations:write: conversations:write dnd:read: dnd:read dnd:write: dnd:write emoji:read: emoji:read files:read: files:read files:write:user: files:write:user groups:history: groups:history groups:read: groups:read groups:write: groups:write identity.basic: identity.basic im:history: im:history im:read: im:read im:write: im:write links:write: links:write mpim:history: mpim:history mpim:read: mpim:read mpim:write: mpim:write none: No scope required pins:read: pins:read pins:write: pins:write reactions:read: reactions:read reactions:write: reactions:write reminders:read: reminders:read reminders:write: reminders:write rtm:stream: rtm:stream search:read: search:read stars:read: stars:read stars:write: stars:write team:read: team:read tokens.basic: tokens.basic usergroups:read: usergroups:read usergroups:write: usergroups:write users.profile:read: users.profile:read users.profile:write: users.profile:write users:read: users:read users:read.email: users:read.email users:write: users:write security: - oauth2: [] tags: - name: api description: '' - name: apps.permissions description: '' - name: apps.permissions.resources description: '' - name: apps.permissions.scopes description: '' - name: auth description: '' - name: bots description: '' - name: channels description: '' - name: chat description: '' - name: conversations description: '' - name: dialog description: '' - name: dnd description: '' - name: emoji description: '' - name: files.comments description: '' - name: files description: '' - name: groups description: '' - name: im description: '' - name: migration description: '' - name: mpim description: '' - name: oauth description: '' - name: pins description: '' - name: reactions description: '' - name: reminders description: '' - name: rtm description: '' - name: search description: '' - name: stars description: '' - name: team description: '' - name: team.profile description: '' - name: usergroups description: '' - name: usergroups.users description: '' - name: users description: '' - name: users.profile description: '' externalDocs: description: Learn more about the Slack Web API url: https://api.slack.com/web