openapi: 3.1.0 info: version: '1.0' title: Slack Admin Access Lists 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: Lists paths: /admin.apps.approved.list: get: tags: - Lists 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: - Lists 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: - Lists 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.emoji.list: get: tags: - Lists 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: - Lists 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: - Lists 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: - Lists 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: - Lists 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: - Lists 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: - Lists 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.users.list: get: tags: - Lists 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: - Lists 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.resources.list: get: tags: - Lists 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: - Lists 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: - Lists 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 /bookmarks.list: get: tags: - Lists summary: List Bookmarks description: Lists bookmarks for a channel. operationId: getBookmarksList parameters: - name: token in: query description: 'Authentication token. Requires scope: `bookmarks:read`' required: true schema: type: string - name: channel_id in: query description: Channel to list bookmarks for. required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: type: object properties: ok: type: boolean bookmarks: type: array items: type: object example: ok: true bookmarks: - id: Bk123 channel_id: C123 title: Example type: link link: https://example.com default: description: Error response content: application/json: schema: type: object properties: ok: type: boolean error: type: string example: ok: false error: invalid_auth security: - slackAuth: - bookmarks:read /chat.scheduledMessages.list: get: tags: - Lists 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.list: get: tags: - Lists 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 /emoji.list: get: tags: - Lists summary: List Emoji description: Lists custom emoji for a team. operationId: getEmojiList parameters: - name: token in: query description: 'Authentication token. Requires scope: `emoji:read`' required: true schema: type: string - name: include_categories in: query description: If true, includes emoji categories. schema: type: boolean responses: '200': description: Successful response returning custom emoji map content: application/json: schema: type: object properties: ok: type: boolean emoji: type: object description: A map of emoji names to their image URLs or aliases. additionalProperties: type: string cache_ts: type: string description: A timestamp for caching purposes. example: ok: true emoji: bowtie: https://emoji.slack-edge.com/T123/bowtie/a1234.png squirrel: https://emoji.slack-edge.com/T123/squirrel/b5678.png glitch_crab: alias:crab cache_ts: 1449272148.xxxxxxx default: description: Error response content: application/json: schema: type: object properties: ok: type: boolean error: type: string example: ok: false error: not_authed security: - slackAuth: - emoji:read /files.list: get: tags: - Lists 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.list: get: tags: - Lists 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 /slackLists.create: post: tags: - Lists summary: Create List description: Creates a new Slack List for tracking work items, tasks, or records. operationId: postSlackListsCreate parameters: - name: token in: header description: 'Authentication token. Requires scope: `lists:write`' required: true schema: type: string requestBody: required: true content: application/json: schema: required: - title - channel_id type: object properties: title: type: string description: Title of the list. channel_id: type: string description: Channel to create the list in. columns: type: array description: Column definitions for the list. items: type: object responses: '200': description: Successful response content: application/json: schema: type: object properties: ok: type: boolean list: type: object example: ok: true default: description: Error response content: application/json: schema: type: object properties: ok: type: boolean error: type: string example: ok: false error: invalid_auth security: - slackAuth: - lists:write /slackLists.update: post: tags: - Lists summary: Update List description: Updates an existing Slack List's title or column configuration. operationId: postSlackListsUpdate parameters: - name: token in: header description: 'Authentication token. Requires scope: `lists:write`' required: true schema: type: string requestBody: required: true content: application/json: schema: required: - list_id type: object properties: list_id: type: string description: ID of the list to update. title: type: string description: New title of the list. responses: '200': description: Successful response content: application/json: schema: type: object properties: ok: type: boolean example: ok: true default: description: Error response content: application/json: schema: type: object properties: ok: type: boolean error: type: string example: ok: false error: list_not_found security: - slackAuth: - lists:write /slackLists.items.create: post: tags: - Lists summary: Create List Item description: Creates a new item (row) in a Slack List. operationId: postSlackListsItemsCreate parameters: - name: token in: header description: 'Authentication token. Requires scope: `lists:write`' required: true schema: type: string requestBody: required: true content: application/json: schema: required: - list_id - column_values type: object properties: list_id: type: string description: ID of the list to add the item to. column_values: type: object description: Map of column IDs to their values for the new item. responses: '200': description: Successful response content: application/json: schema: type: object properties: ok: type: boolean item: type: object example: ok: true default: description: Error response content: application/json: schema: type: object properties: ok: type: boolean error: type: string example: ok: false error: list_not_found security: - slackAuth: - lists:write /slackLists.items.update: post: tags: - Lists summary: Update List Item description: Updates an existing item (row) in a Slack List. operationId: postSlackListsItemsUpdate parameters: - name: token in: header description: 'Authentication token. Requires scope: `lists:write`' required: true schema: type: string requestBody: required: true content: application/json: schema: required: - list_id - item_id - column_values type: object properties: list_id: type: string description: ID of the list. item_id: type: string description: ID of the item to update. column_values: type: object description: Map of column IDs to their new values. responses: '200': description: Successful response content: application/json: schema: type: object properties: ok: type: boolean example: ok: true default: description: Error response content: application/json: schema: type: object properties: ok: type: boolean error: type: string example: ok: false error: item_not_found security: - slackAuth: - lists:write /slackLists.items.delete: post: tags: - Lists summary: Delete List Item description: Deletes a single item (row) from a Slack List. operationId: postSlackListsItemsDelete parameters: - name: token in: header description: 'Authentication token. Requires scope: `lists:write`' required: true schema: type: string requestBody: required: true content: application/x-www-form-urlencoded: schema: required: - list_id - item_id type: object properties: list_id: type: string description: ID of the list. item_id: type: string description: ID of the item to delete. responses: '200': description: Successful response content: application/json: schema: type: object properties: ok: type: boolean example: ok: true default: description: Error response content: application/json: schema: type: object properties: ok: type: boolean error: type: string example: ok: false error: item_not_found security: - slackAuth: - lists:write /slackLists.items.list: get: tags: - Lists summary: List Items description: Lists all items in a Slack List with optional filtering and pagination. operationId: getSlackListsItemsList parameters: - name: token in: query description: 'Authentication token. Requires scope: `lists:read`' required: true schema: type: string - name: list_id in: query description: ID of the list to retrieve items from. required: true schema: type: string - name: cursor in: query description: Pagination cursor for retrieving additional pages. schema: type: string - name: limit in: query description: Maximum number of items to return. schema: type: integer responses: '200': description: Successful response content: application/json: schema: type: object properties: ok: type: boolean items: type: array items: type: object response_metadata: type: object example: ok: true items: [] default: description: Error response content: application/json: schema: type: object properties: ok: type: boolean error: type: string example: ok: false error: list_not_found security: - slackAuth: - lists:read /pins.list: get: tags: - Lists 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.list: get: tags: - Lists 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.list: get: tags: - Lists 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 /stars.list: get: tags: - Lists 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 /usergroups.list: get: tags: - Lists 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: - Lists 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.list: get: tags: - Lists 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