Slack Get API

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
 

# --- truncated at 32 KB (297 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/slack/refs/heads/main/openapi/slack-get-api-openapi.yml