openapi: 3.1.0 info: version: '1.0' title: Slack Admin Access Get API description: "The Slack Admin API is a set of privileged endpoints\x14primarily under admin.* with related SCIM and Audit Logs APIs\x14that lets Enterprise Grid owners and admins automate organization\x11 wide management and governance. It covers user lifecycle (provision, suspend, assign roles), workspace and channel administration across workspaces (create, move, archive channels; manage membership and settings), app governance (approve/deny or allowlist/ban apps and install them to workspaces), invite request handling, and security/compliance controls such as information barriers, session and authentication policies, and org\x11level analytics exports. These APIs require elevated admin scopes and are commonly used to power automated onboarding/offboarding, centralized channel and app controls, and integrations with identity, ITSM, and compliance systems." tags: - name: Get paths: /admin.apps.approved.list: get: tags: - Get description: List approved apps for an org or workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.apps.approved.list operationId: getAdminAppsApprovedList parameters: - name: token in: query description: 'Authentication token. Requires scope: `admin.apps:read`' required: true schema: type: string - name: limit in: query description: The maximum number of items to return. Must be between 1 - 1000 both inclusive. schema: type: integer - name: cursor in: query description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page schema: type: string - name: team_id in: query schema: type: string - name: enterprise_id in: query schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: approved_apps: - app: additional_info: '' app_directory_url: https://myteam.enterprise.slack.com/apps/A0W7UKG8E-my-test-app app_homepage_url: https://www.slack.com description: test app help_url: https://www.slack.com icons: image_1024: https://3026743124446w96_2bd4ea1ad1f89a23c242_1024.png image_128: https://30267341249446w6_2bd4ea1ad1f89a23c242_128.png image_192: https://30267431249446w6_2bd4ea1ad1f89a23c242_192.png image_32: https://302674312496446w_2bd4ea1ad1f89a23c242_32.png image_36: https://302674312496446w_2bd4ea1ad1f89a23c242_36.png image_48: https://302674312496446w_2bd4ea1ad1f89a23c242_48.png image_512: https://30267431249446w6_2bd4ea1ad1f89a23c242_512.png image_64: https://302674312496446w_2bd4ea1ad1f89a23c242_64.png image_72: https://302674312496446w_2bd4ea1ad1f89a23c242_72.png image_96: https://302674312496446w_2bd4ea1ad1f89a23c242_96.png image_original: https://302674446w12496_2bd4ea1ad1f89a23c242_original.png id: A0W7UKG8E is_app_directory_approved: false is_internal: false name: My Test App privacy_policy_url: https://www.slack.com date_updated: 1574296707 last_resolved_by: actor_id: W0G82F4FD actor_type: user scopes: - description: Add the ability for people to direct message or mention @my_test_app is_sensitive: true name: bot token_type: bot ok: true response_metadata: next_cursor: '' default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.apps:read summary: Slack Get Admin Apps Approved List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.apps.requests.list: get: tags: - Get description: List app requests for a team/workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.apps.requests.list operationId: getAdminAppsRequestsList parameters: - name: token in: query description: 'Authentication token. Requires scope: `admin.apps:read`' required: true schema: type: string - name: limit in: query description: The maximum number of items to return. Must be between 1 - 1000 both inclusive. schema: type: integer - name: cursor in: query description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page schema: type: string - name: team_id in: query schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: app_requests: - app: additional_info: '' app_directory_url: https://acmecorp.slack.com/apps/A061BL8RQ0-test-app app_homepage_url: '' description: '' help_url: '' icons: image_1024: /cdn/15258203/img/testapp/service_1024.png image_128: /cdn/157258203/img/testapp/service_128.png image_192: /cdn/157258203/img/testapp/service_192.png image_32: /cdn/157658203/img/testapp/service_32.png image_36: /cdn/157658203/img/testapp/service_36.png image_48: /cdn/157658203/img/testapp/service_48.png image_512: /cdn/15758203/img/testapp/service_512.png image_64: /cdn/157658203/img/testapp/service_64.png image_72: /cdn/157658203/img/testapp/service_72.png image_96: /cdn/157658203/img/testapp/service_96.png id: A061BL8RQ0 is_app_directory_approved: true is_internal: false name: Test App privacy_policy_url: https://testapp.com/privacy date_created: 1578956327 id: Ar0XJGFLMLS message: test test again previous_resolution: null scopes: - description: Post messages to specific channels in Slack is_sensitive: false name: incoming-webhook token_type: user team: domain: acmecorp id: T0M94LNUCR name: Acme Corp user: email: janedoe@example.com id: W08RA9G5HR name: Jane Doe ok: true response_metadata: next_cursor: '' default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: missing_scope needed: admin.apps:read ok: false provided: read,client,admin,identify,post,apps security: - slackAuth: - admin.apps:read summary: Slack Get Admin Apps Requests List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.apps.restricted.list: get: tags: - Get description: List restricted apps for an org or workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.apps.restricted.list operationId: getAdminAppsRestrictedList parameters: - name: token in: query description: 'Authentication token. Requires scope: `admin.apps:read`' required: true schema: type: string - name: limit in: query description: The maximum number of items to return. Must be between 1 - 1000 both inclusive. schema: type: integer - name: cursor in: query description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page schema: type: string - name: team_id in: query schema: type: string - name: enterprise_id in: query schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true response_metadata: next_cursor: '' restricted_apps: - app: additional_info: '' app_directory_url: https://myteam.enterprise.slack.com/apps/A0FDLP8M2L-my-test-app app_homepage_url: https://example.com description: A fun test app for Slack help_url: https://example.com icons: image_1024: https://1433265338rl878408_eb57dbc818daa4ba15d6_1024.png image_128: https://4332653438rl87808_eb57dbc818daa4ba15d6_128.png image_192: https://4332653438rl87808_eb57dbc818daa4ba15d6_192.png image_32: https://143326534038rl8788_eb57dbc818daa4ba15d6_32.png image_36: https://143326534038rl8788_eb57dbc818daa4ba15d6_36.png image_48: https://143326534038rl8788_eb57dbc818daa4ba15d6_48.png image_512: https://4332653438rl87808_eb57dbc818daa4ba15d6_512.png image_64: https://143326534038rl8788_eb57dbc818daa4ba15d6_64.png image_72: https://143326534038rl8788_eb57dbc818daa4ba15d6_72.png image_96: https://143326534038rl8788_eb57dbc818daa4ba15d6_96.png image_original: https://143338rl8782653408_eb57dbc818daa4ba15d6_original.png id: A0FDLP8M2L is_app_directory_approved: true is_internal: false name: My Test App privacy_policy_url: https://example.com date_updated: 1574296721 last_resolved_by: actor_id: W0G82LMFD actor_type: user scopes: - description: Upload, edit, and delete files on the user's behalf is_sensitive: true name: files:write:user token_type: user default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.apps:read summary: Slack Get Admin Apps Restricted List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.ekm.listOriginalConnectedChannelInfo: get: tags: - Get description: List all disconnected channels i.e., channels that were once connected to other workspaces and then disconnected and the corresponding original channel IDs for key revocation with EKM. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo operationId: getAdminConversationsEkmListoriginalconnectedchannelinfo parameters: - name: token in: query description: 'Authentication token. Requires scope: `admin.conversations:read`' required: true schema: type: string - name: channel_ids in: query description: A comma-separated list of channels to filter to. schema: type: string - name: team_ids in: query description: A comma-separated list of the workspaces to which the channels you would like returned belong. schema: type: string - name: limit in: query description: The maximum number of items to return. Must be between 1 - 1000 both inclusive. schema: type: integer - name: cursor in: query description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: channels: - id: string internal_team_ids: array original_connected_channel_id: string original_connected_host_id: string ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:read summary: Slack Get Admin Conversations Ekm Listoriginalconnectedchannelinfo x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.getConversationPrefs: get: tags: - Get description: Get conversation preferences for a public or private channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.getConversationPrefs operationId: getAdminConversationsGetconversationprefs parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.conversations:read`' required: true schema: type: string - name: channel_id in: query description: The channel to get preferences for. required: true schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: admin.conversations.getConversationPrefs schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' prefs: type: object properties: can_thread: type: object properties: type: type: array items: type: string user: type: array items: type: string who_can_post: type: object properties: type: type: array items: type: string user: type: array items: type: string additionalProperties: false description: Schema for successful response of admin.conversations.getConversationPrefs example: ok: true default: description: Typical error response content: application/json: schema: title: admin.conversations.unarchive error schema required: - error - ok type: object properties: error: type: string enum: - feature_not_enabled - not_an_admin - not_an_enterprise - restricted_action - missing_scope - channel_not_found - channel_type_not_supported - could_not_get_conversation_prefs ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from admin.conversations.getConversationPrefs example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:read summary: Slack Get Admin Conversations Getconversationprefs x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.getTeams: get: tags: - Get description: Get all the workspaces a given public or private channel is connected to within this Enterprise org. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.getTeams operationId: getAdminConversationsGetteams parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.conversations:read`' required: true schema: type: string - name: channel_id in: query description: The channel to determine connected workspaces within the organization for. required: true schema: type: string - name: cursor in: query description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page schema: type: string - name: limit in: query description: The maximum number of items to return. Must be between 1 - 1000 both inclusive. schema: type: integer responses: '200': description: Typical success response content: application/json: schema: title: admin.conversations.getTeams schema required: - ok - team_ids type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' response_metadata: type: object additionalProperties: false team_ids: type: array items: $ref: '#/components/schemas/defs_team' additionalProperties: false description: Schema for successful response of admin.conversations.getTeams example: ok: true teams: - T1234 - T5678 default: description: Typical error response content: application/json: schema: title: admin.conversations.getTeams error schema required: - error - ok type: object properties: error: type: string enum: - feature_not_enabled - channel_not_found - channel_type_not_supported - unsupported_team_type - restricted_action - could_not_get_teams - invalid_cursor - invalid_limit ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from admin.conversations.getTeams example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:read summary: Slack Get Admin Conversations Getteams x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.restrictAccess.listGroups: get: tags: - Get description: List all IDP Groups linked to a channel externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups operationId: getAdminConversationsRestrictaccessListgroups parameters: - name: token in: query description: 'Authentication token. Requires scope: `admin.conversations:read`' required: true schema: type: string - name: channel_id in: query required: true schema: type: string - name: team_id in: query description: The workspace where the channel exists. This argument is required for channels only tied to one workspace, and optional for channels that are shared across an organization. schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: group_ids: - YOUR_GROUP_ID ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.conversations:read summary: Slack Get Admin Conversations Restrictaccess Listgroups x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.conversations.search: get: tags: - Get description: Search for public or private channels in an Enterprise organization. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.conversations.search operationId: getAdminConversationsSearch parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.conversations:read`' required: true schema: type: string - name: team_ids in: query description: Comma separated string of team IDs, signifying the workspaces to search through. schema: type: string - name: query in: query description: Name of the the channel to query by. schema: type: string - name: limit in: query description: Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10. schema: type: integer - name: cursor in: query description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. schema: type: string - name: search_channel_types in: query description: The type of channel to include or exclude in the search. For example `private` will search private channels, while `private_exclude` will exclude them. For a full list of types, check the [Types section](#types). schema: type: string - name: sort in: query description: 'Possible values are `relevant` (search ranking based on what we think is closest), `name` (alphabetical), `member_count` (number of users in the channel), and `created` (date channel was created). You can optionally pair this with the `sort_dir` arg to change how it is sorted ' schema: type: string - name: sort_dir in: query description: Sort direction. Possible values are `asc` for ascending order like (1, 2, 3) or (a, b, c), and `desc` for descending order like (3, 2, 1) or (c, b, a) schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: admin.conversations.search schema required: - channels - next_cursor type: object properties: channels: type: array items: $ref: '#/components/schemas/objs_channel' next_cursor: type: string additionalProperties: false description: Schema for successful response of admin.conversations.search example: channels: - created: 1449252889 creator: U012A3CDE id: C012AB3CD is_archived: false is_channel: true is_ext_shared: false is_general: true is_group: false is_im: false is_member: true is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_shared: false name: general name_normalized: general num_members: 4 pending_shared: [] previous_names: [] purpose: creator: '' last_set: 0 value: This channel is for team-wide communication and announcements. All team members are in this channel. topic: creator: '' last_set: 0 value: Company-wide announcements and work-based matters unlinked: 0 ok: true response_metadata: next_cursor: dGVhbTpDMDYxRkE1UEI= default: description: Typical error response content: application/json: schema: title: admin.conversations.search error schema required: - error - ok type: object properties: error: type: string enum: - feature_not_enabled - not_an_admin - not_an_enterprise - team_not_found - not_allowed - invalid_auth - invalid_cursor - invalid_search_channel_type - invalid_sort - invalid_sort_dir ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from admin.conversations.search example: error: not_an_enterprise ok: false security: - slackAuth: - admin.conversations:read summary: Slack Get Admin Conversations Search x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.emoji.list: get: tags: - Get description: List emoji for an Enterprise Grid organization. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.emoji.list operationId: getAdminEmojiList parameters: - name: token in: query description: 'Authentication token. Requires scope: `admin.teams:read`' required: true schema: type: string - name: cursor in: query description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page schema: type: string - name: limit in: query description: The maximum number of items to return. Must be between 1 - 1000 both inclusive. schema: type: integer responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: cache_ts: '1575283387.000000' categories: - emoji_names: - grinning - grin - joy - etc etc ... name: Smileys & People categories_version: '5' emoji: black_square: alias:black_large_square bowtie: https://emoji.slack-edge.com/T9TK3CUKW/bowtie/f3ec6f2bb0.png cubimal_chick: https://emoji.slack-edge.com/T9TK3CUKW/cubimal_chick/85961c43d7.png dusty_stick: https://emoji.slack-edge.com/T9TK3CUKW/dusty_stick/6177a62312.png glitch_crab: https://emoji.slack-edge.com/T9TK3CUKW/glitch_crab/db049f1f9c.png piggy: https://emoji.slack-edge.com/T9TK3CUKW/piggy/b7762ee8cd.png pride: https://emoji.slack-edge.com/T9TK3CUKW/pride/56b1bd3388.png shipit: alias:squirrel simple_smile: apple: https://a.slack-edge.com/80588/img/emoji_2017_12_06/apple/simple_smile.png google: https://a.slack-edge.com/80588/img/emoji_2017_12_06/google/simple_smile.png slack: https://emoji.slack-edge.com/T9TK3CUKW/slack/7d462d2443.png slack_call: https://emoji.slack-edge.com/T9TK3CUKW/slack_call/b81fffd6dd.png squirrel: https://emoji.slack-edge.com/T9TK3CUKW/squirrel/465f40c0e0.png thumbsup_all: https://emoji.slack-edge.com/T9TK3CUKW/thumbsup_all/50096a1020.gif white_square: alias:white_large_square ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:read summary: Slack Get Admin Emoji List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.inviteRequests.approved.list: get: tags: - Get description: List all approved workspace invite requests. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.inviteRequests.approved.list operationId: getAdminInviterequestsApprovedList parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.invites:read`' required: true schema: type: string - name: team_id in: query description: ID for the workspace where the invite requests were made. schema: type: string - name: cursor in: query description: Value of the `next_cursor` field sent as part of the previous API response schema: type: string - name: limit in: query description: The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive schema: type: integer responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.invites:read summary: Slack Get Admin Inviterequests Approved List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.inviteRequests.denied.list: get: tags: - Get description: List all denied workspace invite requests. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.inviteRequests.denied.list operationId: getAdminInviterequestsDeniedList parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.invites:read`' required: true schema: type: string - name: team_id in: query description: ID for the workspace where the invite requests were made. schema: type: string - name: cursor in: query description: Value of the `next_cursor` field sent as part of the previous api response schema: type: string - name: limit in: query description: The number of results that will be returned by the API on each invocation. Must be between 1 - 1000 both inclusive schema: type: integer responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.invites:read summary: Slack Get Admin Inviterequests Denied List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.inviteRequests.list: get: tags: - Get description: List all pending workspace invite requests. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.inviteRequests.list operationId: getAdminInviterequestsList parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.invites:read`' required: true schema: type: string - name: team_id in: query description: ID for the workspace where the invite requests were made. schema: type: string - name: cursor in: query description: Value of the `next_cursor` field sent as part of the previous API response schema: type: string - name: limit in: query description: The number of results that will be returned by the API on each invocation. Must be between 1 - 1000, both inclusive schema: type: integer responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.invites:read summary: Slack Get Admin Inviterequests List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.teams.admins.list: get: tags: - Get description: List all of the admins on a given workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.teams.admins.list operationId: getAdminTeamsAdminsList parameters: - name: token in: query description: 'Authentication token. Requires scope: `admin.teams:read`' required: true schema: type: string - name: limit in: query description: The maximum number of items to return. schema: type: integer - name: cursor in: query description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. schema: type: string - name: team_id in: query required: true schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: admin_ids: - U1234 ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:read summary: Slack Get Admin Teams Admins List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.teams.list: get: tags: - Get description: List all teams on an Enterprise organization externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.teams.list operationId: getAdminTeamsList parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.teams:read`' required: true schema: type: string - name: limit in: query description: The maximum number of items to return. Must be between 1 - 100 both inclusive. schema: type: integer - name: cursor in: query description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true teams: - discoverability: hidden id: T1234 name: My Team primary_owner: email: bront@slack.com user_id: W1234 team_url: https://subarachnoid.slack.com/ default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:read summary: Slack Get Admin Teams List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.teams.owners.list: get: tags: - Get description: List all of the owners on a given workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.teams.owners.list operationId: getAdminTeamsOwnersList parameters: - name: token in: query description: 'Authentication token. Requires scope: `admin.teams:read`' required: true schema: type: string - name: team_id in: query required: true schema: type: string - name: limit in: query description: The maximum number of items to return. Must be between 1 - 1000 both inclusive. schema: type: integer - name: cursor in: query description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true owner_ids: - U1234 default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:read summary: Slack Get Admin Teams Owners List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.teams.settings.info: get: tags: - Get description: Fetch information about settings in a workspace externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.teams.settings.info operationId: getAdminTeamsSettingsInfo parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.teams:read`' required: true schema: type: string - name: team_id in: query required: true schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true team: default_channels: array domain: string email_domain: string enterprise_id: string enterprise_name: string icon: array id: string name: string default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.teams:read summary: Slack Get Admin Teams Settings Info x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.usergroups.listChannels: get: tags: - Get description: List the channels linked to an org-level IDP group (user group). externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.usergroups.listChannels operationId: getAdminUsergroupsListchannels parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.usergroups:read`' required: true schema: type: string - name: usergroup_id in: query description: ID of the IDP group to list default channels for. required: true schema: type: string - name: team_id in: query description: ID of the the workspace. schema: type: string - name: include_num_members in: query description: Flag to include or exclude the count of members per channel. schema: type: boolean responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: channels: - id: C024BE91L name: fun num_members: 34 team_id: T024BE911 - id: C024BE91K name: more fun team_id: T024BE912 - id: C024BE91M is_redacted: true name: public-channel num_members: 34 team_id: T024BE911 - id: C024BE91N name: some more fun team_id: T024BE921 ok: true default: description: Typical error response if the token provided is not associated with an Org Admin or Owner content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: not_an_admin ok: false security: - slackAuth: - admin.usergroups:read summary: Slack Get Admin Usergroups Listchannels x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /admin.users.list: get: tags: - Get description: List users on a workspace externalDocs: description: API method documentation url: https://api.slack.com/methods/admin.users.list operationId: getAdminUsersList parameters: - name: token in: header description: 'Authentication token. Requires scope: `admin.users:read`' required: true schema: type: string - name: team_id in: query description: The ID (`T1234`) of the workspace. required: true schema: type: string - name: cursor in: query description: Set `cursor` to `next_cursor` returned by the previous call to list items in the next page. schema: type: string - name: limit in: query description: Limit for how many users to be retrieved per page schema: type: integer responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true users: - email: bront@slack.com id: T1234 is_admin: false is_bot: false is_owner: false is_primary_owner: false is_restricted: false is_ultra_restricted: false default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin.users:read summary: Slack Get Admin Users List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /apps.event.authorizations.list: get: tags: - Get description: Get a list of authorizations for the given event context. Each authorization represents an app installation that the event is visible to. externalDocs: description: API method documentation url: https://api.slack.com/methods/apps.event.authorizations.list operationId: getAppsEventAuthorizationsList parameters: - name: token in: header description: 'Authentication token. Requires scope: `authorizations:read`' required: true schema: type: string - name: event_context in: query required: true schema: type: string - name: cursor in: query schema: type: string - name: limit in: query schema: type: integer responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: authorizations: enterprise_id: string is_bot: string team_id: string user_id: string ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - authorizations:read summary: Slack Get Apps Event Authorizations List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /apps.permissions.info: get: tags: - Get 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: getAppsPermissionsInfo parameters: - name: token in: query description: 'Authentication token. Requires scope: `none`' schema: type: string responses: '200': description: Standard success response when used with a user token content: application/json: schema: title: apps.permissions.info schema required: - info - ok type: object properties: info: required: - app_home - channel - group - im - mpim - team type: object properties: app_home: type: object properties: resources: $ref: '#/components/schemas/objs_resources' scopes: $ref: '#/components/schemas/objs_scopes' channel: type: object properties: resources: $ref: '#/components/schemas/objs_resources' scopes: $ref: '#/components/schemas/objs_scopes' group: type: object properties: resources: $ref: '#/components/schemas/objs_resources' scopes: $ref: '#/components/schemas/objs_scopes' im: type: object properties: resources: $ref: '#/components/schemas/objs_resources' scopes: $ref: '#/components/schemas/objs_scopes' mpim: type: object properties: resources: $ref: '#/components/schemas/objs_resources' scopes: $ref: '#/components/schemas/objs_scopes' team: required: - resources - scopes type: object properties: resources: $ref: '#/components/schemas/objs_resources' scopes: $ref: '#/components/schemas/objs_scopes' ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from apps.permissions.info 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 default: description: Standard failure response when used with an invalid token content: application/json: schema: title: apps.permissions.info error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from apps.permissions.info method example: error: invalid_auth ok: false security: - slackAuth: - none summary: Slack Get Apps Permissions Info x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /apps.permissions.request: get: tags: - Get description: Allows an app to request additional scopes externalDocs: description: API method documentation url: https://api.slack.com/methods/apps.permissions.request operationId: getAppsPermissionsRequest parameters: - name: token in: query description: 'Authentication token. Requires scope: `none`' required: true schema: type: string - name: scopes in: query description: A comma separated list of scopes to request for required: true schema: type: string - name: trigger_id in: query description: Token used to trigger the permissions API required: true schema: type: string responses: '200': description: Standard success response when used with a user token content: application/json: schema: title: apps.permissions.request schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from apps.permissions.request method example: ok: true default: description: Standard failure response when trigger_id is invalid content: application/json: schema: title: apps.permissions.request error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from apps.permissions.request method example: error: invalid_trigger_id ok: false security: - slackAuth: - none summary: Slack Get Apps Permissions Request x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /apps.permissions.resources.list: get: tags: - Get 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: getAppsPermissionsResourcesList parameters: - name: token in: query description: 'Authentication token. Requires scope: `none`' required: true schema: type: string - 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. schema: type: string - name: limit in: query description: The maximum number of items to return. schema: type: integer responses: '200': description: Typical successful paginated response content: application/json: schema: title: apps.permissions.resources.list success schema required: - ok - resources type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' resources: type: array items: type: object properties: id: title: An ID for a resource type: string type: title: The type of resource the `id` corresponds to type: string response_metadata: type: object additionalProperties: false additionalProperties: true 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= default: description: Typical error response content: application/json: schema: title: apps.permissions.resources.list error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from apps.permissions.resources.list method example: error: invalid_cursor ok: false security: - slackAuth: - none summary: Slack Get Apps Permissions Resources List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /apps.permissions.scopes.list: get: tags: - Get 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: getAppsPermissionsScopesList parameters: - name: token in: query description: 'Authentication token. Requires scope: `none`' required: true schema: type: string responses: '200': description: Typical successful paginated response content: application/json: schema: title: api.permissions.scopes.list success schema required: - ok - scopes type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' scopes: type: object additionalProperties: true additionalProperties: true 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: [] default: description: Typical error response content: application/json: schema: title: apps.permissions.scopes.list error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from apps.permissions.scopes.list method example: error: invalid_auth ok: false security: - slackAuth: - none summary: Slack Get Apps Permissions Scopes List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /apps.permissions.users.list: get: tags: - Get description: Returns list of user grants and corresponding scopes this app has on a team. externalDocs: description: API method documentation url: https://api.slack.com/methods/apps.permissions.users.list operationId: getAppsPermissionsUsersList parameters: - name: token in: query description: 'Authentication token. Requires scope: `none`' required: true schema: type: string - 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. schema: type: string - name: limit in: query description: The maximum number of items to return. schema: type: integer responses: '200': description: Typical successful paginated response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true resources: - id: U0DES3UAN scopes: - dnd:write:user - reminders:write:user - id: U024BFF1M scopes: - reminders:write:user response_metadata: next_cursor: dGVhbTdPMUg5UkFTT0w= default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_cursor ok: false security: - slackAuth: - none summary: Slack Get Apps Permissions Users List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /apps.permissions.users.request: get: tags: - Get description: Enables an app to trigger a permissions modal to grant an app access to a user access scope. externalDocs: description: API method documentation url: https://api.slack.com/methods/apps.permissions.users.request operationId: getAppsPermissionsUsersRequest parameters: - name: token in: query description: 'Authentication token. Requires scope: `none`' required: true schema: type: string - name: scopes in: query description: A comma separated list of user scopes to request for required: true schema: type: string - name: trigger_id in: query description: Token used to trigger the request required: true schema: type: string - name: user in: query description: The user this scope is being requested for required: true schema: type: string responses: '200': description: Standard success response when used with a user token content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Standard failure response when trigger_id is invalid content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_trigger_id ok: false security: - slackAuth: - none summary: Slack Get Apps Permissions Users Request x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /apps.uninstall: get: tags: - Get description: Uninstalls your app from a workspace. externalDocs: description: API method documentation url: https://api.slack.com/methods/apps.uninstall operationId: getAppsUninstall parameters: - name: token in: query description: 'Authentication token. Requires scope: `none`' schema: type: string - name: client_id in: query description: Issued when you created your application. schema: type: string - name: client_secret in: query description: Issued when you created your application. schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: apps.uninstall schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from apps.uninstall method example: ok: true default: description: Typical error response content: application/json: schema: title: apps.uninstall error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - invalid_client_id - bad_client_secret - client_id_token_mismatch - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - user_is_bot - invalid_arg_name - invalid_array_arg - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required - fatal_error ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from apps.uninstall method example: error: invalid_auth ok: false security: - slackAuth: - none summary: Slack Get Apps Uninstall x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /auth.revoke: get: tags: - Get description: Revokes a token. externalDocs: description: API method documentation url: https://api.slack.com/methods/auth.revoke operationId: getAuthRevoke parameters: - name: token in: query description: 'Authentication token. Requires scope: `none`' required: true schema: type: string - name: test in: query description: Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked. schema: type: boolean responses: '200': description: Typical success response content: application/json: schema: title: auth.revoke schema required: - ok - revoked type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' revoked: type: boolean additionalProperties: false description: Schema for successful response from auth.revoke method example: ok: true revoked: true default: description: Typical error response content: application/json: schema: title: auth.revoke error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from auth.revoke method example: error: invalid_auth ok: false security: - slackAuth: - none summary: Slack Get Auth Revoke x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /auth.test: get: tags: - Get description: Checks authentication & identity. externalDocs: description: API method documentation url: https://api.slack.com/methods/auth.test operationId: getAuthTest parameters: - name: token in: header description: 'Authentication token. Requires scope: `none`' required: true schema: type: string responses: '200': description: Standard success response when used with a user token content: application/json: schema: title: auth.test success schema required: - ok - team - team_id - url - user - user_id type: object properties: bot_id: $ref: '#/components/schemas/defs_bot_id' is_enterprise_install: type: boolean ok: $ref: '#/components/schemas/defs_ok_true' team: type: string team_id: $ref: '#/components/schemas/defs_team' url: type: string user: type: string user_id: $ref: '#/components/schemas/defs_user_id' additionalProperties: false 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 default: description: Standard failure response when used with an invalid token content: application/json: schema: title: auth.test error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response auth.test method example: error: invalid_auth ok: false security: - slackAuth: - none summary: Slack Get Auth Test x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /bots.info: get: tags: - Get description: Gets information about a bot user. externalDocs: description: API method documentation url: https://api.slack.com/methods/bots.info operationId: getBotsInfo parameters: - name: token in: query description: 'Authentication token. Requires scope: `users:read`' required: true schema: type: string - name: bot in: query description: Bot user to get info on schema: type: string responses: '200': description: When successful, returns bot info by bot ID. content: application/json: schema: title: bots.info schema required: - bot - ok type: object properties: bot: type: object additionalProperties: false ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from bots.info method example: bot: app_id: A161CLERW deleted: false icons: image_36: https://... image_48: https://... image_72: https://... id: B061F7JD2 name: beforebot updated: 1449272004 user_id: U012ABCDEF ok: true default: description: When no bot can be found, it returns an error. content: application/json: schema: title: bots.info error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from bots.info method example: error: bot_not_found ok: false security: - slackAuth: - users:read summary: Slack Get Bots Info x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /calls.info: get: tags: - Get description: Returns information about a Call. externalDocs: description: API method documentation url: https://api.slack.com/methods/calls.info operationId: calls_info parameters: - name: token in: header description: 'Authentication token. Requires scope: `calls:read`' required: true schema: type: string - name: id in: query description: '`id` of the Call returned by the [`calls.add`](/methods/calls.add) method.' required: true schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - calls:read summary: Slack Get Calls Info x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true PascalCaseOperationTags: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /chat.getPermalink: get: tags: - Get description: Retrieve a permalink URL for a specific extant message externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.getPermalink operationId: getChatGetpermalink parameters: - name: token in: query description: 'Authentication token. Requires scope: `none`' required: true schema: type: string - name: channel in: query description: The ID of the conversation or channel containing the message required: true schema: type: string - name: message_ts in: query description: A message's `ts` value, uniquely identifying it within a channel required: true schema: type: string responses: '200': description: Standard success response content: application/json: schema: title: chat.getPermalink success schema required: - channel - ok - permalink type: object properties: channel: $ref: '#/components/schemas/defs_channel' ok: $ref: '#/components/schemas/defs_ok_true' permalink: type: string format: uri additionalProperties: false description: Schema for successful response chat.getPermalink example: channel: C1H9RESGA ok: true permalink: https://ghostbusters.slack.com/archives/C1H9RESGA/p135854651500008 default: description: Error response when channel cannot be found content: application/json: schema: title: chat.getPermalink error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from chat.getPermalink method example: error: channel_not_found ok: false security: - slackAuth: - none summary: Slack Get Chat Getpermalink x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /chat.scheduledMessages.list: get: tags: - Get description: Returns a list of scheduled messages. externalDocs: description: API method documentation url: https://api.slack.com/methods/chat.scheduledMessages.list operationId: getChatScheduledmessagesList parameters: - name: token in: header description: 'Authentication token. Requires scope: `none`' schema: type: string - name: channel in: query description: The channel of the scheduled messages schema: type: string - name: latest in: query description: A UNIX timestamp of the latest value in the time range schema: type: number - name: oldest in: query description: A UNIX timestamp of the oldest value in the time range schema: type: number - name: limit in: query description: Maximum number of original entries to return. schema: type: integer - name: cursor in: query description: For pagination purposes, this is the `cursor` value returned from a previous call to `chat.scheduledmessages.list` indicating where you want to start this call from. schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: chat.scheduledMessages.list schema required: - ok - response_metadata - scheduled_messages type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' response_metadata: type: object additionalProperties: false scheduled_messages: type: array items: type: object additionalProperties: false additionalProperties: false description: Schema for successful response from chat.scheduledMessages.list method example: ok: true response_metadata: next_cursor: '' scheduled_messages: - channel_id: C1H9RESGL date_created: 1551891734 id: 1298393284 post_at: 1551991428 text: Here's a message for you in the future default: description: Typical error response if the channel passed is invalid content: application/json: schema: title: chat.scheduledMessages.list error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - invalid_channel - not_authed - invalid_auth - account_inactive - token_revoked - no_permission - org_login_required - ekm_access_denied - missing_scope - invalid_arguments - invalid_arg_name - invalid_charset - invalid_form_data - invalid_post_type - missing_post_type - team_added_to_org - invalid_json - json_not_object - request_timeout - upgrade_required - fatal_error ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from chat.scheduledMessages.list method example: error: invalid_channel ok: false security: - slackAuth: - none summary: Slack Get Chat Scheduledmessages List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.history: get: tags: - Get description: Fetches a conversation's history of messages and events. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.history operationId: getConversationsHistory parameters: - name: token in: query description: 'Authentication token. Requires scope: `conversations:history`' schema: type: string - name: channel in: query description: Conversation ID to fetch history for. schema: type: string - name: latest in: query description: End of time range of messages to include in results. schema: type: number - name: oldest in: query description: Start of time range of messages to include in results. schema: type: number - name: inclusive in: query description: Include messages with latest or oldest timestamp in results only when either timestamp is specified. schema: type: boolean - 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. schema: type: integer - 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. schema: type: string responses: '200': description: Typical success response containing a channel's messages content: application/json: schema: title: conversations.history success schema required: - channel_actions_count - channel_actions_ts - has_more - messages - ok - pin_count type: object properties: channel_actions_count: type: integer channel_actions_ts: type: object has_more: type: boolean messages: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/objs_message' ok: $ref: '#/components/schemas/defs_ok_true' pin_count: type: integer additionalProperties: false description: Schema for successful response from conversations.history method example: has_more: true messages: - text: I find you punny and would like to smell your nose letter ts: '1512085950.000216' type: message user: U012AB3CDE - text: What, you want to smell my shoes better? ts: '1512104434.000490' type: message user: U061F7AUR ok: true pin_count: 0 response_metadata: next_cursor: bmV4dF90czoxNTEyMDg1ODYxMDAwNTQz default: description: Typical error response content: application/json: schema: title: conversations.history error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.history method example: error: channel_not_found ok: false security: - slackAuth: - channels:history - groups:history - im:history - mpim:history summary: Slack Get Conversations History x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.info: get: tags: - Get description: Retrieve information about a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.info operationId: getConversationsInfo parameters: - name: token in: query description: 'Authentication token. Requires scope: `conversations:read`' schema: type: string - name: channel in: query description: Conversation ID to learn more about schema: type: string - name: include_locale in: query description: Set this to `true` to receive the locale for this conversation. Defaults to `false` schema: type: boolean - name: include_num_members in: query description: Set to `true` to include the member count for the specified conversation. Defaults to `false` 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.) content: application/json: schema: title: conversations.info success schema required: - channel - ok type: object properties: channel: $ref: '#/components/schemas/objs_conversation' ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response conversations.info example: channel: created: 1449252889 creator: W012A3BCD id: C012AB3CD is_archived: false is_channel: true is_ext_shared: false is_general: true is_group: false is_im: false is_member: true is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_read_only: false is_shared: false last_read: '1502126650.228446' locale: en-US name: general name_normalized: general parent_conversation: null pending_shared: [] previous_names: - specifics - abstractions - etc purpose: creator: W012A3BCD last_set: 1449709364 value: This part of the workspace is for fun. Make fun here. topic: creator: W012A3BCD last_set: 1449709364 value: For public discussion of generalities unlinked: 0 ok: true default: description: Typical error response when a channel cannot be found content: application/json: schema: title: conversations.info error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.info method example: error: channel_not_found ok: false security: - slackAuth: - channels:read - groups:read - im:read - mpim:read summary: Slack Get Conversations Info x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.list: get: tags: - Get description: Lists all channels in a Slack team. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.list operationId: getConversationsList parameters: - name: token in: query description: 'Authentication token. Requires scope: `conversations:read`' schema: type: string - name: exclude_archived in: query description: Set to `true` to exclude archived channels from the list 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` 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. schema: type: integer - 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. schema: type: string responses: '200': description: Typical success response with only public channels content: application/json: schema: title: conversations.list success schema required: - channels - ok type: object properties: channels: uniqueItems: true type: array items: $ref: '#/components/schemas/objs_conversation' ok: $ref: '#/components/schemas/defs_ok_true' response_metadata: type: object additionalProperties: false additionalProperties: false description: Schema for successful response from conversations.list method example: channels: - created: 1449252889 creator: U012A3CDE id: C012AB3CD is_archived: false is_channel: true is_ext_shared: false is_general: true is_group: false is_im: false is_member: true is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_shared: false name: general name_normalized: general num_members: 4 pending_shared: [] previous_names: [] purpose: creator: '' last_set: 0 value: This channel is for team-wide communication and announcements. All team members are in this channel. topic: creator: '' last_set: 0 value: Company-wide announcements and work-based matters unlinked: 0 - created: 1449252889 creator: U061F7AUR id: C061EG9T2 is_archived: false is_channel: true is_ext_shared: false is_general: false is_group: false is_im: false is_member: true is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_shared: false name: random name_normalized: random num_members: 4 pending_shared: [] 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: '' last_set: 0 value: Non-work banter and water cooler conversation unlinked: 0 ok: true response_metadata: next_cursor: dGVhbTpDMDYxRkE1UEI= default: description: Typical error response content: application/json: schema: title: conversations.list error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.list method example: error: invalid_auth ok: false security: - slackAuth: - channels:read - groups:read - im:read - mpim:read summary: Slack Get Conversations List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.members: get: tags: - Get description: Retrieve members of a conversation. externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.members operationId: getConversationsMembers parameters: - name: token in: query description: 'Authentication token. Requires scope: `conversations:read`' schema: type: string - name: channel in: query description: ID of the conversation to retrieve members for 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. schema: type: integer - 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. schema: type: string responses: '200': description: Typical paginated success response content: application/json: schema: title: conversations.members success schema required: - members - ok - response_metadata type: object properties: members: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/defs_user_id' ok: $ref: '#/components/schemas/defs_ok_true' response_metadata: type: object additionalProperties: false additionalProperties: false description: Schema for successful response conversations.members method example: members: - U023BECGF - U061F7AUR - W012A3CDE ok: true response_metadata: next_cursor: e3VzZXJfaWQ6IFcxMjM0NTY3fQ== default: description: Typical error response when an invalid cursor is provided content: application/json: schema: title: conversations.members error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response conversations.members method example: error: invalid_cursor ok: false security: - slackAuth: - channels:read - groups:read - im:read - mpim:read summary: Slack Get Conversations Members x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /conversations.replies: get: tags: - Get description: Retrieve a thread of messages posted to a conversation externalDocs: description: API method documentation url: https://api.slack.com/methods/conversations.replies operationId: getConversationsReplies parameters: - name: token in: query description: 'Authentication token. Requires scope: `conversations:history`' schema: type: string - name: channel in: query description: Conversation ID to fetch thread from. schema: type: string - name: ts in: query description: Unique identifier of a thread's parent message. `ts` must be the timestamp of an existing message with 0 or more replies. If there are no replies then just the single message referenced by `ts` will return - it is just an ordinary, unthreaded message. schema: type: number - name: latest in: query description: End of time range of messages to include in results. schema: type: number - name: oldest in: query description: Start of time range of messages to include in results. schema: type: number - name: inclusive in: query description: Include messages with latest or oldest timestamp in results only when either timestamp is specified. schema: type: boolean - 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. schema: type: integer - 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. schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: conversations.replies success schema required: - messages - ok type: object properties: has_more: type: boolean messages: type: array items: type: object ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from conversations.replies method example: has_more: true messages: - last_read: '1484678597.521003' reply_count: 3 subscribed: true text: island thread_ts: '1482960137.003543' ts: '1482960137.003543' type: message unread_count: 0 user: U061F7AUR - parent_user_id: U061F7AUR text: one island thread_ts: '1482960137.003543' ts: '1483037603.017503' type: message user: U061F7AUR - parent_user_id: U061F7AUR text: two island thread_ts: '1482960137.003543' ts: '1483051909.018632' type: message user: U061F7AUR - parent_user_id: U061F7AUR text: three for the land thread_ts: '1482960137.003543' ts: '1483125339.020269' type: message user: U061F7AUR ok: true response_metadata: next_cursor: bmV4dF90czoxNDg0Njc4MjkwNTE3MDkx default: description: Typical error response content: application/json: schema: title: conversations.replies error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 needed: type: string ok: $ref: '#/components/schemas/defs_ok_false' provided: type: string additionalProperties: false description: Schema for error response from conversations.replies method example: error: thread_not_found ok: false security: - slackAuth: - channels:history - groups:history - im:history - mpim:history summary: Slack Get Conversations Replies x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /dialog.open: get: tags: - Get description: Open a dialog with a user externalDocs: description: API method documentation url: https://api.slack.com/methods/dialog.open operationId: getDialogOpen parameters: - name: token in: header description: 'Authentication token. Requires scope: `none`' required: true schema: type: string - name: dialog in: query description: The dialog definition. This must be a JSON-encoded string. required: true schema: type: string - name: trigger_id in: query description: Exchange a trigger to post to the user. required: true schema: type: string responses: '200': description: Typical success response is quite minimal. content: application/json: schema: title: dialog.open schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: false description: Schema for successful response from dialog.open method example: ok: true default: description: Typical error response, before getting to any possible validation errors. content: application/json: schema: title: dialog.open error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - validation_errors - missing_trigger - missing_dialog - trigger_exchanged - trigger_expired - invalid_trigger - app_missing_action_url - cannot_create_dialog - failed_sending_dialog - 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from dialog.open method example: error: missing_trigger ok: false security: - slackAuth: - none summary: Slack Get Dialog Open x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /dnd.info: get: tags: - Get description: Retrieves a user's current Do Not Disturb status. externalDocs: description: API method documentation url: https://api.slack.com/methods/dnd.info operationId: getDndInfo parameters: - name: token in: query description: 'Authentication token. Requires scope: `dnd:read`' schema: type: string - name: user in: query description: User to fetch status for (defaults to current user) schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: dnd.info schema required: - dnd_enabled - next_dnd_end_ts - next_dnd_start_ts - ok type: object properties: dnd_enabled: type: boolean next_dnd_end_ts: type: integer next_dnd_start_ts: type: integer ok: $ref: '#/components/schemas/defs_ok_true' snooze_enabled: type: boolean snooze_endtime: type: integer snooze_remaining: type: integer additionalProperties: false description: Schema for successful response from dnd.info method example: ok: true default: description: Typical error response content: application/json: schema: title: dnd.info error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - user_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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from dnd.info method example: error: invalid_auth ok: false security: - slackAuth: - dnd:read summary: Slack Get Do Not Disturb Info x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /dnd.teamInfo: get: tags: - Get description: Retrieves the Do Not Disturb status for up to 50 users on a team. externalDocs: description: API method documentation url: https://api.slack.com/methods/dnd.teamInfo operationId: getDndTeaminfo parameters: - name: token in: query description: 'Authentication token. Requires scope: `dnd:read`' schema: type: string - name: users in: query description: Comma-separated list of users to fetch Do Not Disturb status for schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this 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 default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - dnd:read summary: Slack Get Do Not Disturb Team Information x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /files.info: get: tags: - Get description: Gets information about a file. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.info operationId: getFilesInfo parameters: - name: token in: query description: 'Authentication token. Requires scope: `files:read`' schema: type: string - name: file in: query description: Specify a file by providing its ID. schema: type: string - name: count in: query schema: type: string - name: page in: query 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. schema: type: integer - name: cursor in: query description: 'Parameter for pagination. File comments are paginated for a single file. Set `cursor` equal to the `next_cursor` attribute returned by the previous request''s `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection of comments. See [pagination](/docs/pagination) for more details.' schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: files.info schema required: - comments - file - ok type: object properties: comments: $ref: '#/components/schemas/objs_comments' editor: $ref: '#/components/schemas/defs_user_id' file: $ref: '#/components/schemas/objs_file' ok: $ref: '#/components/schemas/defs_ok_true' paging: $ref: '#/components/schemas/objs_paging' response_metadata: $ref: '#/components/schemas/objs_response_metadata' additionalProperties: false description: Schema for successful response from files.info method example: comments: [] file: channels: - C0T8SE4AU comments_count: 0 created: 1531763342 deanimate_gif: https://.../tedair_deanimate_gif.png display_as_bot: false editable: false external_type: '' filetype: gif groups: [] has_rich_preview: false id: F0S43PZDF image_exif_rotation: 1 ims: [] is_external: false is_public: true is_starred: false mimetype: image/gif mode: hosted name: tedair.gif original_h: 226 original_w: 176 permalink: https://.../tedair.gif permalink_public: https://.../... pjpeg: https://.../tedair_pjpeg.jpg pretty_type: GIF public_url_shared: false shares: public: C0T8SE4AU: - channel_name: file-under latest_reply: '1531763348.000001' reply_count: 1 reply_users: - U061F7AUR reply_users_count: 1 team_id: T061EG9R6 thread_ts: '1531763273.000015' ts: '1531763348.000001' size: 137531 thumb_160: https://.../tedair_=_160.png thumb_360: https://.../tedair_360.png thumb_360_gif: https://.../tedair_360.gif thumb_360_h: 226 thumb_360_w: 176 thumb_64: https://.../tedair_64.png thumb_80: https://.../tedair_80.png timestamp: 1531763342 title: tedair.gif url_private: https://.../tedair.gif url_private_download: https://.../tedair.gif user: U061F7AUR username: '' ok: true response_metadata: next_cursor: dGVhbTpDMUg5UkVTR0w= default: description: Typical error response content: application/json: schema: title: files.info error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from files.info method example: error: invalid_auth ok: false security: - slackAuth: - files:read summary: Slack Get Files Info x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /files.list: get: tags: - Get description: List for a team, in a channel, or from a user with applied filters. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.list operationId: getFilesList parameters: - name: token in: query description: 'Authentication token. Requires scope: `files:read`' schema: type: string - name: user in: query description: Filter files created by a single user. schema: type: string - name: channel in: query description: Filter files appearing in a specific channel, indicated by its ID. schema: type: string - name: ts_from in: query description: Filter files created after this timestamp (inclusive). schema: type: number - name: ts_to in: query description: Filter files created before this timestamp (inclusive). schema: type: number - name: types in: query description: Filter files by type ([see below](#file_types)). You can pass multiple values in the types argument, like `types=spaces,snippets`.The default value is `all`, which does not filter the list. schema: type: string - name: count in: query schema: type: string - name: page in: query schema: type: string - name: show_files_hidden_by_limit in: query description: Show truncated file info for files hidden due to being too old, and the team who owns the file being over the file limit. schema: type: boolean responses: '200': description: Typical success response content: application/json: schema: title: files.list schema required: - files - ok - paging type: object properties: files: minItems: 0 uniqueItems: true type: array items: $ref: '#/components/schemas/objs_file' ok: $ref: '#/components/schemas/defs_ok_true' paging: $ref: '#/components/schemas/objs_paging' additionalProperties: false description: Schema for successful response from files.list method example: files: - channels: - C0T8SE4AU comments_count: 0 created: 1531763254 deanimate_gif: https://.../billair_deanimate_gif.png display_as_bot: false editable: false external_type: '' filetype: gif groups: [] id: F0S43P1CZ image_exif_rotation: 1 ims: [] is_external: false is_public: true mimetype: image/gif mode: hosted name: billair.gif original_h: 226 original_w: 176 permalink: https://.../billair.gif permalink_public: https://.../... pjpeg: https://.../billair_pjpeg.jpg pretty_type: GIF public_url_shared: false size: 144538 thumb_160: https://.../billair_=_160.png thumb_360: https://.../billair_360.png thumb_360_gif: https://.../billair_360.gif thumb_360_h: 226 thumb_360_w: 176 thumb_64: https://.../billair_64.png thumb_80: https://.../billair_80.png timestamp: 1531763254 title: billair.gif url_private: https://.../billair.gif url_private_download: https://.../billair.gif user: U061F7AUR username: '' - channels: - C0T8SE4AU comments_count: 0 created: 1531763342 deanimate_gif: https://.../tedair_deanimate_gif.png display_as_bot: false editable: false external_type: '' filetype: gif groups: [] id: F0S43PZDF image_exif_rotation: 1 ims: [] is_external: false is_public: true mimetype: image/gif mode: hosted name: tedair.gif original_h: 226 original_w: 176 permalink: https://.../tedair.gif permalink_public: https://.../... pjpeg: https://.../tedair_pjpeg.jpg pretty_type: GIF public_url_shared: false size: 137531 thumb_160: https://.../tedair_=_160.png thumb_360: https://.../tedair_360.png thumb_360_gif: https://.../tedair_360.gif thumb_360_h: 226 thumb_360_w: 176 thumb_64: https://.../tedair_64.png thumb_80: https://.../tedair_80.png timestamp: 1531763342 title: tedair.gif url_private: https://.../tedair.gif url_private_download: https://.../tedair.gif user: U061F7AUR username: '' ok: true paging: count: 100 page: 1 pages: 1 total: 2 default: description: Typical error response content: application/json: schema: title: files.list error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from files.list method example: error: invalid_auth ok: false security: - slackAuth: - files:read summary: Slack Get Files List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /files.remote.info: get: tags: - Get description: Retrieve information about a remote file added to Slack externalDocs: description: API method documentation url: https://api.slack.com/methods/files.remote.info operationId: getFilesRemoteInfo parameters: - name: token in: query description: 'Authentication token. Requires scope: `remote_files:read`' schema: type: string - name: file in: query description: Specify a file by providing its ID. schema: type: string - name: external_id in: query description: Creator defined GUID for the file. schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - remote_files:read summary: Slack Get Files Remote Info x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /files.remote.list: get: tags: - Get description: Retrieve information about a remote file added to Slack externalDocs: description: API method documentation url: https://api.slack.com/methods/files.remote.list operationId: getFilesRemoteList parameters: - name: token in: query description: 'Authentication token. Requires scope: `remote_files:read`' schema: type: string - name: channel in: query description: Filter files appearing in a specific channel, indicated by its ID. schema: type: string - name: ts_from in: query description: Filter files created after this timestamp (inclusive). schema: type: number - name: ts_to in: query description: Filter files created before this timestamp (inclusive). schema: type: number - name: limit in: query description: The maximum number of items to return. schema: type: integer - 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. schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - remote_files:read summary: Slack Get Files Remote List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /files.remote.share: get: tags: - Get description: Share a remote file into a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/files.remote.share operationId: getFilesRemoteShare parameters: - name: token in: query description: 'Authentication token. Requires scope: `remote_files:share`' schema: type: string - name: file in: query description: Specify a file registered with Slack by providing its ID. Either this field or `external_id` or both are required. schema: type: string - name: external_id in: query description: The globally unique identifier (GUID) for the file, as set by the app registering the file with Slack. Either this field or `file` or both are required. schema: type: string - name: channels in: query description: Comma-separated list of channel IDs where the file will be shared. schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - remote_files:share summary: Slack Get Files Remote Share x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /migration.exchange: get: tags: - Get 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: getMigrationExchange parameters: - name: token in: query description: 'Authentication token. Requires scope: `tokens.basic`' required: true schema: type: string - name: users in: query description: A comma-separated list of user ids, up to 400 per request required: true schema: type: string - name: team_id in: query description: Specify team_id starts with `T` in case of Org Token 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`. schema: type: boolean responses: '200': description: Typical success response when mappings exist for the specified user IDs content: application/json: schema: title: migration.exchange success schema required: - enterprise_id - ok - team_id type: object properties: enterprise_id: title: The enterprise grid organization ID containing the workspace/team. type: string invalid_user_ids: title: A list of User IDs that cannot be mapped or found type: array items: type: string ok: $ref: '#/components/schemas/defs_ok_true' team_id: $ref: '#/components/schemas/defs_team' user_id_map: title: A mapping of provided user IDs with mapped user IDs type: object additionalProperties: true additionalProperties: true 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 default: description: Typical error response when there are no mappings to provide content: application/json: schema: title: migration.exchange error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from migration.exchange method example: error: not_enterprise_team ok: false security: - slackAuth: - tokens.basic summary: Slack Get Migration Exchange x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /oauth.access: get: tags: - Get 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: getOauthAccess parameters: - name: client_id in: query description: Issued when you created your application. schema: type: string - name: client_secret in: query description: Issued when you created your application. schema: type: string - name: code in: query description: The `code` param returned via the OAuth callback. schema: type: string - name: redirect_uri in: query description: This must match the originally submitted URI (if one was sent). schema: type: string - name: single_channel in: query description: Request the user to add your app only to a single channel. Only valid with a [legacy workspace app](https://api.slack.com/legacy-workspace-apps). schema: type: boolean responses: '200': description: Successful user token negotiation for a single scope content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: access_token: - TOKEN enterprise_id: null scope: groups:write team_id: TXXXXXXXXX team_name: Wyld Stallyns LLC default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_client_id ok: false security: - slackAuth: - none summary: Slack Get Oauth Access x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /oauth.token: get: tags: - Get 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: getOauthToken parameters: - name: client_id in: query description: Issued when you created your application. schema: type: string - name: client_secret in: query description: Issued when you created your application. schema: type: string - name: code in: query description: The `code` param returned via the OAuth callback. schema: type: string - name: redirect_uri in: query description: This must match the originally submitted URI (if one was sent). schema: type: string - name: single_channel in: query description: Request the user to add your app only to a single channel. schema: type: boolean responses: '200': description: Success example using a workspace app produces a very different kind of response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: access_token: - TOKEN 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 content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_client_id ok: false security: - slackAuth: - none summary: Slack Get Oauth Token x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /oauth.v2.access: get: tags: - Get description: Exchanges a temporary OAuth verifier code for an access token. externalDocs: description: API method documentation url: https://api.slack.com/methods/oauth.v2.access operationId: getOauthAccess parameters: - name: client_id in: query description: Issued when you created your application. schema: type: string - name: client_secret in: query description: Issued when you created your application. schema: type: string - name: code in: query description: The `code` param returned via the OAuth callback. required: true schema: type: string - name: redirect_uri in: query description: This must match the originally submitted URI (if one was sent). schema: type: string responses: '200': description: Successful token request with scopes for both a bot user and a user token content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: access_token: - TOKEN app_id: A0KRD7HC3 authed_user: access_token: - TOKEN id: U1234 scope: chat:write token_type: user bot_user_id: U0KRQLJ9H enterprise: id: E12345678 name: slack-sports ok: true scope: commands,incoming-webhook team: id: T9TK3CUKW name: Slack Softball Team token_type: bot default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_client_id ok: false security: - slackAuth: - none summary: Slack Get Oauth Access x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /pins.list: get: tags: - Get description: Lists items pinned to a channel. externalDocs: description: API method documentation url: https://api.slack.com/methods/pins.list operationId: getPinsList parameters: - name: token in: query description: 'Authentication token. Requires scope: `pins:read`' required: true schema: type: string - name: channel in: query description: Channel to get pinned items for. required: true schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: pins.list success schema type: array description: Schema for successful response from pins.list method example: items: - channel: C2U86NC6H created: 1508881078 created_by: U2U85N1RZ message: permalink: https://hitchhikers.slack.com/archives/C2U86NC6H/p1508197641000151 pinned_to: - C2U86NC6H text: What is the meaning of life? ts: '1508197641.000151' type: message user: U2U85N1RZ type: message - channel: C2U86NC6H created: 1508880991 created_by: U2U85N1RZ message: permalink: https://hitchhikers.slack.com/archives/C2U86NC6H/p1508284197000015 pinned_to: - C2U86NC6H text: The meaning of life, the universe, and everything is 42. ts: '1503289197.000015' type: message user: U2U85N1RZ type: message ok: true default: description: Typical error response content: application/json: schema: title: pins.list error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from pins.list method example: error: invalid_auth ok: false security: - slackAuth: - pins:read summary: Slack Get Pins List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /reactions.get: get: tags: - Get description: Gets reactions for an item. externalDocs: description: API method documentation url: https://api.slack.com/methods/reactions.get operationId: getReactionsGet parameters: - name: token in: query description: 'Authentication token. Requires scope: `reactions:read`' required: true schema: type: string - name: channel in: query description: Channel where the message to get reactions for was posted. schema: type: string - name: file in: query description: File to get reactions for. schema: type: string - name: file_comment in: query description: File comment to get reactions for. schema: type: string - name: full in: query description: If true always return the complete reaction list. schema: type: boolean - name: timestamp in: query description: Timestamp of the message to get reactions for. schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: reactions.get success schema type: array description: Schema for successful response from reactions.get method example: file: channels: - C2U7V2YA2 comments_count: 1 created: 1507850315 groups: [] id: F7H0D7ZA4 ims: [] name: computer.gif reactions: - count: 1 name: stuck_out_tongue_winking_eye users: - U2U85N1RV timestamp: 1507850315 title: computer.gif user: U2U85N1RV ok: true type: file default: description: Typical error response content: application/json: schema: title: reactions.get error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from reactions.get method example: error: invalid_auth ok: false security: - slackAuth: - reactions:read summary: Slack Get Reactions Get x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /reactions.list: get: tags: - Get description: Lists reactions made by a user. externalDocs: description: API method documentation url: https://api.slack.com/methods/reactions.list operationId: getReactionsList parameters: - name: token in: query description: 'Authentication token. Requires scope: `reactions:read`' required: true schema: type: string - name: user in: query description: Show reactions made by this user. Defaults to the authed user. schema: type: string - name: full in: query description: If true always return the complete reaction list. schema: type: boolean - name: count in: query schema: type: integer - name: page in: query schema: type: integer - name: cursor in: query description: 'Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request''s `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See [pagination](/docs/pagination) for more details.' 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. schema: type: integer responses: '200': description: Typical success response content: application/json: schema: title: reactions.list schema required: - items - ok type: object properties: items: type: array items: type: object ok: $ref: '#/components/schemas/defs_ok_true' paging: $ref: '#/components/schemas/objs_paging' response_metadata: $ref: '#/components/schemas/objs_response_metadata' additionalProperties: false description: Schema for successful response from reactions.list method example: items: - channel: C3UKJTQAC message: bot_id: B4VLRLMKJ reactions: - count: 1 name: robot_face users: - U2U85N1RV subtype: bot_message text: 'Hello from Python! :tada:' ts: '1507849573.000090' username: Shipit Notifications type: message - comment: comment: This is a file comment created: 1508286096 id: Fc7LP08P1U reactions: - count: 1 name: white_check_mark users: - U2U85N1RV timestamp: 1508286096 type: file_comment user: U2U85N1RV file: channels: - C2U7V2YA2 comments_count: 1 created: 1507850315 reactions: - count: 1 name: stuck_out_tongue_winking_eye users: - U2U85N1RV title: computer.gif user: U2U85N1RV username: '' - file: channels: - C2U7V2YA2 comments_count: 1 created: 1507850315 id: F7H0D7ZA4 name: computer.gif reactions: - count: 1 name: stuck_out_tongue_winking_eye users: - U2U85N1RV size: 1639034 title: computer.gif user: U2U85N1RV username: '' type: file ok: true response_metadata: next_cursor: dGVhbTpDMUg5UkVTR0w= default: description: Typical error response content: application/json: schema: title: reactions.list error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from reactions.list method example: error: invalid_auth ok: false security: - slackAuth: - reactions:read summary: Slack Get Reactions List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /reminders.info: get: tags: - Get description: Gets information about a reminder. externalDocs: description: API method documentation url: https://api.slack.com/methods/reminders.info operationId: getRemindersInfo parameters: - name: token in: query description: 'Authentication token. Requires scope: `reminders:read`' schema: type: string - name: reminder in: query description: The ID of the reminder schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: reminders.info schema required: - ok - reminder type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' reminder: $ref: '#/components/schemas/objs_reminder' additionalProperties: false description: Schema for successful response from reminders.info method example: ok: true default: description: Typical error response content: application/json: schema: title: reminders.info error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from reminders.info method example: error: invalid_auth ok: false security: - slackAuth: - reminders:read summary: Slack Get Reminders Info x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /reminders.list: get: tags: - Get 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: getRemindersList parameters: - name: token in: query description: 'Authentication token. Requires scope: `reminders:read`' schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: reminders.list schema required: - ok - reminders type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' reminders: type: array items: $ref: '#/components/schemas/objs_reminder' additionalProperties: false description: Schema for successful response from reminders.list method example: ok: true default: description: Typical error response content: application/json: schema: title: reminders.list error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from reminders.list method example: error: invalid_auth ok: false security: - slackAuth: - reminders:read summary: Slack Get Reminders List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /rtm.connect: get: tags: - Get description: Starts a Real Time Messaging session. externalDocs: description: API method documentation url: https://api.slack.com/methods/rtm.connect operationId: getRtmConnect parameters: - name: token in: query description: 'Authentication token. Requires scope: `rtm:stream`' required: 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). 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). schema: type: boolean responses: '200': description: Typical success response content: application/json: schema: title: rtm.connect schema required: - ok - self - team - url type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' self: type: object additionalProperties: false team: type: object additionalProperties: false url: type: string format: uri additionalProperties: false 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://... default: description: Typical error response content: application/json: schema: title: rtm.connect error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from rtm.connect method example: error: invalid_auth ok: false security: - slackAuth: - rtm:stream summary: Slack Get Rtm Connect x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /search.messages: get: tags: - Get description: Searches for messages matching a query. externalDocs: description: API method documentation url: https://api.slack.com/methods/search.messages operationId: getSearchMessages parameters: - name: token in: query description: 'Authentication token. Requires scope: `search:read`' required: true schema: type: string - name: count in: query description: Pass the number of results you want per "page". Maximum of `100`. schema: type: integer - name: highlight in: query description: Pass a value of `true` to enable query highlight markers (see below). schema: type: boolean - name: page in: query schema: type: integer - name: query in: query description: Search query. required: true schema: type: string - name: sort in: query description: Return matches sorted by either `score` or `timestamp`. schema: type: string - name: sort_dir in: query description: Change sort direction to ascending (`asc`) or descending (`desc`). schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available 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 default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: No query passed ok: false security: - slackAuth: - search:read summary: Slack Get Search Messages x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /stars.list: get: tags: - Get description: Lists stars for a user. externalDocs: description: API method documentation url: https://api.slack.com/methods/stars.list operationId: getStarsList parameters: - name: token in: query description: 'Authentication token. Requires scope: `stars:read`' schema: type: string - name: count in: query schema: type: string - name: page in: query schema: type: string - name: cursor in: query description: 'Parameter for pagination. Set `cursor` equal to the `next_cursor` attribute returned by the previous request''s `response_metadata`. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See [pagination](/docs/pagination) for more details.' 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. schema: type: integer responses: '200': description: Typical success response content: application/json: schema: title: stars.list schema required: - items - ok type: object properties: items: type: array items: type: object ok: $ref: '#/components/schemas/defs_ok_true' paging: $ref: '#/components/schemas/objs_paging' additionalProperties: false description: Schema for successful response from stars.list method example: ok: true default: description: Typical error response content: application/json: schema: title: stars.list error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from stars.list method example: error: invalid_auth ok: false security: - slackAuth: - stars:read summary: Slack Get Stars List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /team.accessLogs: get: tags: - Get description: Gets the access logs for the current team. externalDocs: description: API method documentation url: https://api.slack.com/methods/team.accessLogs operationId: getTeamAccesslogs parameters: - name: token in: query description: 'Authentication token. Requires scope: `admin`' required: true schema: type: string - name: before in: query description: End of time range of logs to include in results (inclusive). schema: type: string - name: count in: query schema: type: string - name: page in: query schema: type: string responses: '200': description: This response demonstrates pagination and two access log entries. content: application/json: schema: title: team.accessLogs schema required: - logins - ok - paging type: object properties: logins: minItems: 1 uniqueItems: true type: array items: type: object additionalProperties: false ok: $ref: '#/components/schemas/defs_ok_true' paging: $ref: '#/components/schemas/objs_paging' additionalProperties: false description: Schema for successful response from team.accessLogs method example: logins: - count: 1 country: US date_first: 1422922864 date_last: 1422922864 ip: 127.0.0.1 isp: BigCo ISP region: CA user_agent: SlackWeb Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.35 Safari/537.36 user_id: U45678 username: alice - count: 1 country: US date_first: 1422922493 date_last: 1422922493 ip: 127.0.0.1 isp: BigCo ISP region: CA user_agent: SlackWeb Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_3 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B466 Safari/600.1.4 user_id: U12345 username: white_rabbit ok: true paging: count: 100 page: 1 pages: 1 total: 2 default: description: 'A workspace must be on a paid plan to use this method, otherwise the `paid_only` error is thrown:' content: application/json: schema: title: team.accessLogs error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - paid_only - over_pagination_limit - 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from team.accessLogs method example: error: paid_only ok: false security: - slackAuth: - admin summary: Slack Get Team Accesslogs x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /team.billableInfo: get: tags: - Get description: Gets billable users information for the current team. externalDocs: description: API method documentation url: https://api.slack.com/methods/team.billableInfo operationId: getTeamBillableinfo parameters: - name: token in: query description: 'Authentication token. Requires scope: `admin`' required: true schema: type: string - name: user in: query description: A user to retrieve the billable information for. Defaults to all users. schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: billable_info: U02UCPE1R: billing_active: true U02UEBSD2: billing_active: true U0632EWRW: billing_active: false ok: true default: description: Typical error response content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_auth ok: false security: - slackAuth: - admin summary: Slack Get Team Billableinfo x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /team.info: get: tags: - Get description: Gets information about the current team. externalDocs: description: API method documentation url: https://api.slack.com/methods/team.info operationId: getTeamInfo parameters: - name: token in: query description: 'Authentication token. Requires scope: `team:read`' required: true schema: type: string - name: team in: query description: Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: team.info schema required: - ok - team type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' team: $ref: '#/components/schemas/objs_team' additionalProperties: false description: Schema for successful response from team.info method example: ok: true team: domain: example email_domain: example.com enterprise_id: E1234A12AB enterprise_name: Umbrella Corporation icon: image_102: https://... image_132: https://... image_34: https://... image_44: https://... image_68: https://... image_88: https://... image_default: true id: T12345 name: My Team default: description: Typical error response content: application/json: schema: title: team.info error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from team.info method example: error: invalid_auth ok: false security: - slackAuth: - team:read summary: Slack Get Team Info x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /team.integrationLogs: get: tags: - Get description: Gets the integration logs for the current team. externalDocs: description: API method documentation url: https://api.slack.com/methods/team.integrationLogs operationId: getTeamIntegrationlogs parameters: - name: token in: query description: 'Authentication token. Requires scope: `admin`' required: true schema: type: string - name: app_id in: query description: Filter logs to this Slack app. Defaults to all logs. schema: type: string - name: change_type in: query description: Filter logs with this change type. Defaults to all logs. schema: type: string - name: count in: query schema: type: string - name: page in: query schema: type: string - name: service_id in: query description: Filter logs to this service. Defaults to all logs. schema: type: string - name: user in: query description: Filter logs generated by this users actions. Defaults to all logs. schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: team.integrationLogs schema required: - logs - ok - paging type: object properties: logs: minItems: 1 uniqueItems: true type: array items: type: object additionalProperties: false ok: $ref: '#/components/schemas/defs_ok_true' paging: $ref: '#/components/schemas/objs_paging' additionalProperties: false description: Schema for successful response from team.integrationLogs method example: ok: true default: description: Typical error response content: application/json: schema: title: team.integrationLogs error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from team.integrationLogs method example: error: invalid_auth ok: false security: - slackAuth: - admin summary: Slack Get Team Integrationlogs x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /team.profile.get: get: tags: - Get description: Retrieve a team's profile. externalDocs: description: API method documentation url: https://api.slack.com/methods/team.profile.get operationId: getTeamProfileGet parameters: - name: token in: query description: 'Authentication token. Requires scope: `users.profile:read`' required: true schema: type: string - name: visibility in: query description: Filter by visibility. schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: team.profile.get success schema required: - ok - profile type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' profile: type: object additionalProperties: false additionalProperties: false description: Schema for successful response from team.profile.get method example: ok: true profile: fields: - hint: Enter the extension to reach your desk id: Xf06054AAA is_hidden: 1 label: Phone extension options: null ordering: 0 possible_values: null type: text - hint: When you were born id: Xf06054BBB label: Date of birth options: null ordering: 1 possible_values: null type: date - hint: Enter a link to your Facebook profile id: Xf06054CCC label: Facebook options: null ordering: 2 possible_values: null type: link - hint: Hogwarts, obviously id: Xf06054DDD label: House options: null ordering: 3 possible_values: - Gryffindor - Hufflepuff - Ravenclaw - Slytherin type: options_list - hint: Office location (LDAP) id: Xf06054EEE label: Location options: is_protected: 1 ordering: 4 possible_values: null type: text - hint: The boss id: Xf06054FFF label: Manager options: null ordering: 5 possible_values: null type: user default: description: Typical error response content: application/json: schema: title: team.profile.get error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from team.profile.get method example: error: invalid_auth ok: false security: - slackAuth: - users.profile:read summary: Slack Get Team Profile Get x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /api.test: get: tags: - Get description: Checks API calling code. externalDocs: description: API method documentation url: https://api.slack.com/methods/api.test operationId: getApiTest parameters: - name: error in: query description: Error response to return schema: type: string - name: foo in: query description: example property to return schema: type: string responses: '200': description: Standard success response content: application/json: schema: title: api.test success schema required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: type: object properties: {} description: Schema for successful response api.test method example: ok: true default: description: Artificial error response content: application/json: schema: title: api.test error schema required: - error - ok type: object properties: error: type: string ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: type: object properties: {} description: Schema for error response api.test method example: args: error: my_error error: my_error ok: false security: - slackAuth: - none summary: Slack Get Api Test x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true PullTagsFromSummary: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /usergroups.list: get: tags: - Get description: List all User Groups for a team externalDocs: description: API method documentation url: https://api.slack.com/methods/usergroups.list operationId: getUsergroupsList parameters: - name: include_users in: query description: Include the list of users for each User Group. schema: type: boolean - name: token in: query description: 'Authentication token. Requires scope: `usergroups:read`' required: true schema: type: string - name: include_count in: query description: Include the number of users in each User Group. schema: type: boolean - name: include_disabled in: query description: Include disabled User Groups. schema: type: boolean responses: '200': description: Typical success response content: application/json: schema: title: usergroups.list schema required: - ok - usergroups type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' usergroups: type: array items: $ref: '#/components/schemas/objs_subteam' additionalProperties: false description: Schema for successful response from usergroups.list 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' default: description: Typical error response content: application/json: schema: title: usergroups.list error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - 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_require - fatal_error - missing_charset - superfluous_charset ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from usergroups.list method example: error: invalid_auth ok: false security: - slackAuth: - usergroups:read summary: Slack Get User Groups List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /usergroups.users.list: get: tags: - Get description: List all users in a User Group externalDocs: description: API method documentation url: https://api.slack.com/methods/usergroups.users.list operationId: getUsergroupsUsersList parameters: - name: token in: query description: 'Authentication token. Requires scope: `usergroups:read`' required: true schema: type: string - name: include_disabled in: query description: Allow results that involve disabled User Groups. schema: type: boolean - name: usergroup in: query description: The encoded ID of the User Group to update. required: true schema: type: string responses: '200': description: Standard success response when used with a user token content: application/json: schema: title: usergroups.users.list schema required: - ok - users type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' users: type: array items: $ref: '#/components/schemas/defs_user_id' additionalProperties: false description: Schema for successful response from usergroups.users.list method example: ok: true users: - U060R4BJ4 - W123A4BC5 default: description: Standard failure response when used with an invalid token content: application/json: schema: title: usergroups.users.list error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - 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_require - fatal_error - missing_charset - superfluous_charset ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from usergroups.users.list method example: error: invalid_auth ok: false security: - slackAuth: - usergroups:read summary: Slack Get User Groups Users List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /users.conversations: get: tags: - Get description: List conversations the calling user may access. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.conversations operationId: getUsersConversations parameters: - name: token in: query description: 'Authentication token. Requires scope: `conversations:read`' schema: type: string - 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. schema: type: string - 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` schema: type: string - name: exclude_archived in: query description: Set to `true` to exclude archived channels from the list schema: type: boolean - 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. schema: type: integer - 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. 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. content: application/json: schema: title: users.conversations success schema required: - channels - ok type: object properties: channels: uniqueItems: true type: array items: $ref: '#/components/schemas/objs_conversation' ok: $ref: '#/components/schemas/defs_ok_true' response_metadata: type: object additionalProperties: false additionalProperties: true description: Schema for successful response from users.conversations method. Returned conversation objects do not include `num_members` or `is_member` example: channels: - created: 1449252889 creator: U012A3CDE id: C012AB3CD is_archived: false is_channel: true is_ext_shared: false is_general: true is_group: false is_im: false is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_shared: false name: general name_normalized: general pending_shared: [] previous_names: [] purpose: creator: '' last_set: 0 value: This channel is for team-wide communication and announcements. All team members are in this channel. topic: creator: '' last_set: 0 value: Company-wide announcements and work-based matters unlinked: 0 - created: 1449252889 creator: U061F7AUR id: C061EG9T2 is_archived: false is_channel: true is_ext_shared: false is_general: false is_group: false is_im: false is_mpim: false is_org_shared: false is_pending_ext_shared: false is_private: false is_shared: false name: random name_normalized: random pending_shared: [] 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: '' last_set: 0 value: Non-work banter and water cooler conversation unlinked: 0 ok: true response_metadata: next_cursor: dGVhbTpDMDYxRkE1UEI= default: description: Typical error response content: application/json: schema: title: users.conversations error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from users.conversations method example: error: invalid_auth ok: false security: - slackAuth: - channels:read - groups:read - im:read - mpim:read summary: Slack Get Users Conversations x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /users.getPresence: get: tags: - Get description: Gets user presence information. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.getPresence operationId: getUsersGetpresence parameters: - name: token in: query description: 'Authentication token. Requires scope: `users:read`' required: true schema: type: string - name: user in: query description: User to get presence info on. Defaults to the authed user. schema: type: string responses: '200': description: When requesting information for a different user, this method just returns the current presence (either `active` or `away`). content: application/json: schema: title: 'API method: users.getPresence' required: - ok - presence type: object properties: auto_away: type: boolean connection_count: type: integer last_activity: type: integer manual_away: type: boolean ok: $ref: '#/components/schemas/defs_ok_true' online: type: boolean presence: type: string additionalProperties: true description: Generated from users.getPresence with shasum e7251aec575d8863f9e0eb38663ae9dc26655f65 example: ok: true presence: active default: description: Typical error response content: application/json: schema: title: users.counts error schema required: - error - ok type: object properties: error: type: string ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: type: object properties: {} description: Schema for error response users.getPresence method example: error: invalid_auth ok: false security: - slackAuth: - users:read summary: Slack Get Users Getpresence x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /users.identity: get: tags: - Get description: Get a user's identity. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.identity operationId: getUsersIdentity parameters: - name: token in: query description: 'Authentication token. Requires scope: `identity.basic`' schema: type: string responses: '200': description: 'You will receive at a minimum the following information:' content: application/json: schema: title: users.identity schema type: array description: Schema for successful response from users.identity method example: ok: true team: id: T0G9PQBBK user: id: U0G9QF9C6 name: Sonny Whether default: description: Typical error response content: application/json: schema: title: users.identity error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from users.identity method example: error: account_inactive ok: false security: - slackAuth: - identity.basic summary: Slack Get Users Identity x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /users.info: get: tags: - Get description: Gets information about a user. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.info operationId: getUsersInfo parameters: - name: token in: query description: 'Authentication token. Requires scope: `users:read`' required: true schema: type: string - name: include_locale in: query description: Set this to `true` to receive the locale for this user. Defaults to `false` schema: type: boolean - name: user in: query description: User to get info on schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: users.info success schema required: - ok - user type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' user: $ref: '#/components/schemas/objs_user' additionalProperties: true 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 image_original: 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 content: application/json: schema: title: users.info error schema required: - error - ok type: object properties: callstack: type: string error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from users.info method example: error: user_not_found ok: false security: - slackAuth: - users:read summary: Slack Get Users Info x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /users.list: get: tags: - Get description: Lists all users in a Slack team. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.list operationId: getUsersList parameters: - name: token in: query description: 'Authentication token. Requires scope: `users:read`' 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. Providing no `limit` value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience `limit_required` or HTTP 500 errors. schema: type: integer - 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. schema: type: string - name: include_locale in: query description: Set this to `true` to receive the locale for users. Defaults to `false` schema: type: boolean responses: '200': description: Typical success response content: application/json: schema: title: users.list schema required: - cache_ts - members - ok type: object properties: cache_ts: type: integer members: minItems: 1 uniqueItems: true type: array items: $ref: '#/components/schemas/objs_user' ok: $ref: '#/components/schemas/defs_ok_true' response_metadata: $ref: '#/components/schemas/objs_response_metadata' additionalProperties: false description: Schema for successful response from users.list method example: cache_ts: 1498777272 members: - 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: spengler team_id: T012AB3C4 tz: America/Los_Angeles tz_label: Pacific Daylight Time tz_offset: -25200 updated: 1502138686 - color: 9f69e7 deleted: false has_2fa: false id: W07QCRPA4 is_admin: true is_bot: false is_owner: false is_primary_owner: false is_restricted: false is_ultra_restricted: false name: glinda profile: avatar_hash: 8fbdd10b41c6 display_name: Glinda the Fairly Good display_name_normalized: Glinda the Fairly Good email: glenda@south.oz.coven first_name: Glinda image_1024: https://a.slack-edge.com...png image_192: https://a.slack-edge.com...png image_24: https://a.slack-edge.com...png image_32: https://a.slack-edge.com...png image_48: https://a.slack-edge.com...png image_512: https://a.slack-edge.com...png image_72: https://a.slack-edge.com...png image_original: https://a.slack-edge.com...png last_name: Southgood phone: '' real_name: Glinda Southgood real_name_normalized: Glinda Southgood skype: '' title: Glinda the Good real_name: Glinda Southgood team_id: T0G9PQBBK tz: America/Los_Angeles tz_label: Pacific Daylight Time tz_offset: -25200 updated: 1480527098 ok: true response_metadata: next_cursor: dXNlcjpVMEc5V0ZYTlo= default: description: Typical error response content: application/json: schema: title: users.list error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - limit_required - 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from users.list method example: error: invalid_cursor ok: false security: - slackAuth: - users:read summary: Slack Get Users List x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /users.lookupByEmail: get: tags: - Get description: Find a user with an email address. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.lookupByEmail operationId: getUsersLookupbyemail parameters: - name: token in: query description: 'Authentication token. Requires scope: `users:read.email`' required: true schema: type: string - name: email in: query description: An email address belonging to a user in the workspace required: true schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: users.lookupByEmail success schema required: - ok - user type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' user: $ref: '#/components/schemas/objs_user' additionalProperties: true 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 default: description: Typical error response content: application/json: schema: title: users.lookupByEmail error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string enum: - users_not_found - enterprise_is_restricted - 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from users.lookupByEmail method example: error: users_not_found ok: false security: - slackAuth: - users:read.email summary: Slack Get Users Lookupbyemail x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /users.profile.get: get: tags: - Get description: Retrieves a user's profile information. externalDocs: description: API method documentation url: https://api.slack.com/methods/users.profile.get operationId: getUsersProfileGet parameters: - name: token in: query description: 'Authentication token. Requires scope: `users.profile:read`' required: true schema: type: string - name: include_labels in: query description: Include labels for each ID in custom profile fields schema: type: boolean - name: user in: query description: User to retrieve profile info for schema: type: string responses: '200': description: Typical success response content: application/json: schema: title: users.profile.get schema required: - ok - profile type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' profile: $ref: '#/components/schemas/objs_user_profile' additionalProperties: false 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 image_original: https://.../avatar/e3b51ca72dee4ef87916ae2b9240df50.jpg real_name: Egon Spengler real_name_normalized: Egon Spengler status_emoji: ':books:' status_expiration: 0 status_text: Print is dead team: T012AB3C4 default: description: Typical error response content: application/json: schema: title: users.profile.get error schema required: - error - ok type: object properties: callstack: type: string description: 'Note: PHP callstack is only visible in dev/qa' error: type: string 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 ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: false description: Schema for error response from users.profile.get method example: error: user_not_found ok: false security: - slackAuth: - users.profile:read summary: Slack Get Users Profile Get x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /views.open: get: tags: - Get description: Open a view for a user. externalDocs: description: API method documentation url: https://api.slack.com/methods/views.open operationId: getViewsOpen parameters: - name: token in: header description: 'Authentication token. Requires scope: `none`' required: true schema: type: string - name: trigger_id in: query description: Exchange a trigger to post to the user. required: true schema: type: string - name: view in: query description: A [view payload](/reference/surfaces/views). This must be a JSON-encoded string. required: true schema: type: string responses: '200': description: Typical success response includes the opened view payload. content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true view: app_id: AA4928AQ blocks: - block_id: a_block_id element: action_id: an_action_id type: plain_text_input label: emoji: true text: A simple label type: plain_text optional: false type: input bot_id: BA13894H callback_id: identify_your_modals clear_on_close: false external_id: '' hash: '156772938.1827394' id: VMHU10V25 notify_on_close: false private_metadata: Shh it is a secret root_view_id: VMHU10V25 state: values: {} submit: text: Create type: plain_text team_id: T8N4K1JN title: text: Quite a plain modal type: plain_text type: modal default: description: Typical error response, before getting to any possible validation errors. content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_arguments ok: false response_metadata: messages: - invalid `trigger_id` security: - slackAuth: - none summary: Slack Get Views Open x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /views.publish: get: tags: - Get description: Publish a static view for a User. externalDocs: description: API method documentation url: https://api.slack.com/methods/views.publish operationId: getViewsPublish parameters: - name: token in: header description: 'Authentication token. Requires scope: `none`' required: true schema: type: string - name: user_id in: query description: '`id` of the user you want publish a view to.' required: true schema: type: string - name: view in: query description: A [view payload](/reference/surfaces/views). This must be a JSON-encoded string. required: true schema: type: string - name: hash in: query description: A string that represents view state to protect against possible race conditions. schema: type: string responses: '200': description: Typical success response includes the published view payload. content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true view: app_id: AA4928AQ blocks: - block_id: 2WGp9 text: text: A simple section with some sample sentence. type: mrkdwn verbatim: false type: section bot_id: BA13894H callback_id: identify_your_home_tab clear_on_close: false close: null external_id: '' hash: '156772938.1827394' id: VMHU10V25 notify_on_close: false previous_view_id: null private_metadata: Shh it is a secret root_view_id: VMHU10V25 state: values: {} submit: null team_id: T8N4K1JN type: home default: description: Typical error response, before getting to any possible validation errors. content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_arguments ok: false response_metadata: messages: - invalid `user_id` security: - slackAuth: - none summary: Slack Get Views Publish x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /views.push: get: tags: - Get description: Push a view onto the stack of a root view. externalDocs: description: API method documentation url: https://api.slack.com/methods/views.push operationId: getViewsPush parameters: - name: token in: header description: 'Authentication token. Requires scope: `none`' required: true schema: type: string - name: trigger_id in: query description: Exchange a trigger to post to the user. required: true schema: type: string - name: view in: query description: A [view payload](/reference/surfaces/views). This must be a JSON-encoded string. required: true schema: type: string responses: '200': description: Typical success response includes the pushed view payload. content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true view: app_id: AAD3351BQ blocks: - block_id: edit_details element: action_id: detail_input type: plain_text_input label: text: Edit details type: plain_text type: input bot_id: BADF7A34H callback_id: view_4 clear_on_close: true close: emoji: true text: Back type: plain_text external_id: '' hash: 1569362015.55b5e41b id: VNM522E2U notify_on_close: false previous_view_id: null private_metadata: '' root_view_id: VNN729E3U state: values: {} submit: emoji: true text: Save type: plain_text team_id: T9M4RL1JM title: emoji: true text: Pushed Modal type: plain_text type: modal default: description: Typical error response. content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: invalid_arguments ok: false response_metadata: messages: - 'missing required field: title' security: - slackAuth: - none summary: Slack Get Views Push x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /views.update: get: tags: - Get description: Update an existing view. externalDocs: description: API method documentation url: https://api.slack.com/methods/views.update operationId: getViewsUpdate parameters: - name: token in: header description: 'Authentication token. Requires scope: `none`' required: true schema: type: string - name: view_id in: query description: A unique identifier of the view to be updated. Either `view_id` or `external_id` is required. schema: type: string - name: external_id in: query description: A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either `view_id` or `external_id` is required. schema: type: string - name: view in: query description: A [view object](/reference/surfaces/views). This must be a JSON-encoded string. schema: type: string - name: hash in: query description: A string that represents view state to protect against possible race conditions. schema: type: string responses: '200': description: Typical success response includes the updated view payload. content: application/json: schema: title: Default success template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_true' additionalProperties: true description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method. example: ok: true view: app_id: AAD3351BQ blocks: - accessory: action_id: button_4 text: text: Click me type: plain_text type: button block_id: s_block text: emoji: true text: I am but an updated modal type: plain_text type: section bot_id: BADF7A34H callback_id: view_2 clear_on_close: true close: emoji: true text: Close type: plain_text external_id: '' hash: 1569262015.55b5e41b id: VNM522E2U notify_on_close: false previous_view_id: null private_metadata: '' root_view_id: VNN729E3U state: values: {} submit: null team_id: T9M4RL1JM title: emoji: true text: Updated Modal type: plain_text type: modal default: description: Typical error response. content: application/json: schema: title: Default error template required: - ok type: object properties: ok: $ref: '#/components/schemas/defs_ok_false' additionalProperties: true description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method. example: error: not_found ok: false security: - slackAuth: - none summary: Slack Get Views Update x-api-evangelist-processing: GenerateOperationSummariesFromPath: true PascalCaseOperationSummaries: true CaselCaseOperationIds: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK