Slack Open API

openapi: 3.1.0
info:
  version: '1.0'
  title: Slack Admin Access Open 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: Open
paths:
  /conversations.open:
    post:
      tags:
      - Open
      description: Opens or resumes a direct message or multi-person direct message.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/conversations.open
      operationId: postConversationsOpen
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `conversations:write`'
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                channel:
                  type: string
                  description: Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead.
                users:
                  type: string
                  description: Comma separated lists of users. If only one user is included, this creates a 1:1 DM.  The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a `channel` when not supplying `users`.
                return_im:
                  type: boolean
                  description: Boolean, indicates you want the full IM channel definition in the response.
          application/json:
            schema:
              type: object
              properties:
                channel:
                  type: string
                  description: Resume a conversation by supplying an `im` or `mpim`'s ID. Or provide the `users` field instead.
                users:
                  type: string
                  description: Comma separated lists of users. If only one user is included, this creates a 1:1 DM.  The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a `channel` when not supplying `users`.
                return_im:
                  type: boolean
                  description: Boolean, indicates you want the full IM channel definition in the response.
      responses:
        '200':
          description: Typical success response
          content:
            application/json:
              schema:
                title: conversations.open success schema
                required:
                - channel
                - ok
                type: object
                properties:
                  already_open:
                    type: boolean
                  channel:
                    type: object
                  no_op:
                    type: boolean
                  ok:
                    $ref: '#/components/schemas/defs_ok_true'
                additionalProperties: false
                description: Schema for successful response from conversations.open method when opening channels, ims, mpims
              example:
                channel:
                  id: D069C7QFK
                ok: true
        default:
          description: Typical error response
          content:
            application/json:
              schema:
                title: conversations.open error schema
                required:
                - error
                - ok
                type: object
                properties:
                  callstack:
                    type: string
                    description: 'Note: PHP callstack is only visible in dev/qa'
                  error:
                    type: string
                    enum:
                    - method_not_supported_for_channel_type
                    - user_not_found
                    - user_not_visible
                    - user_disabled
                    - users_list_not_supplied
                    - not_enough_users
                    - too_many_users
                    - invalid_user_combination
                    - not_authed
                    - invalid_auth
                    - account_inactive
                    - invalid_arg_name
                    - invalid_array_arg
                    - invalid_charset
                    - invalid_form_data
                    - invalid_post_type
                    - missing_post_type
                    - team_added_to_org
                    - invalid_json
                    - json_not_object
                    - request_timeout
                    - upgrade_required
                    - channel_not_found
                  ok:
                    $ref: '#/components/schemas/defs_ok_false'
                additionalProperties: false
                description: Schema for error response from conversations.open method
              example:
                error: channel_not_found
                ok: false
      security:
      - slackAuth:
        - channels:write
        - groups:write
        - im:write
        - mpim:write
      summary: Slack Post Conversations Open
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /dialog.open:
    get:
      tags:
      - Open
      description: Open a dialog with a user
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/dialog.open
      operationId: getDialogOpen
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `none`'
        required: true
        schema:
          type: string
      - name: dialog
        in: query
        description: The dialog definition. This must be a JSON-encoded string.
        required: true
        schema:
          type: string
      - name: trigger_id
        in: query
        description: Exchange a trigger to post to the user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Typical success response is quite minimal.
          content:
            application/json:
              schema:
                title: dialog.open schema
                required:
                - ok
                type: object
                properties:
                  ok:
                    $ref: '#/components/schemas/defs_ok_true'
                additionalProperties: false
                description: Schema for successful response from dialog.open method
              example:
                ok: true
        default:
          description: Typical error response, before getting to any possible validation errors.
          content:
            application/json:
              schema:
                title: dialog.open error schema
                required:
                - error
                - ok
                type: object
                properties:
                  callstack:
                    type: string
                    description: 'Note: PHP callstack is only visible in dev/qa'
                  error:
                    type: string
                    enum:
                    - validation_errors
                    - missing_trigger
                    - missing_dialog
                    - trigger_exchanged
                    - trigger_expired
                    - invalid_trigger
                    - app_missing_action_url
                    - cannot_create_dialog
                    - failed_sending_dialog
                    - not_authed
                    - invalid_auth
                    - account_inactive
                    - token_revoked
                    - no_permission
                    - org_login_required
                    - invalid_arg_name
                    - invalid_array_arg
                    - invalid_charset
                    - invalid_form_data
                    - invalid_post_type
                    - missing_post_type
                    - team_added_to_org
                    - invalid_json
                    - json_not_object
                    - request_timeout
                    - upgrade_required
                    - fatal_error
                  ok:
                    $ref: '#/components/schemas/defs_ok_false'
                additionalProperties: false
                description: Schema for error response from dialog.open method
              example:
                error: missing_trigger
                ok: false
      security:
      - slackAuth:
        - none
      summary: Slack Get Dialog Open
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /views.open:
    get:
      tags:
      - Open
      description: Open a view for a user.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/views.open
      operationId: getViewsOpen
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `none`'
        required: true
        schema:
          type: string
      - name: trigger_id
        in: query
        description: Exchange a trigger to post to the user.
        required: true
        schema:
          type: string
      - name: view
        in: query
        description: A [view payload](/reference/surfaces/views). This must be a JSON-encoded string.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Typical success response includes the opened view payload.
          content:
            application/json:
              schema:
                title: Default success template
                required:
                - ok
                type: object
                properties:
                  ok:
                    $ref: '#/components/schemas/defs_ok_true'
                additionalProperties: true
                description: This method either only returns a brief _OK_ response or a verbose schema is not available for this method.
              example:
                ok: true
                view:
                  app_id: AA4928AQ
                  blocks:
                  - block_id: a_block_id
                    element:
                      action_id: an_action_id
                      type: plain_text_input
                    label:
                      emoji: true
                      text: A simple label
                      type: plain_text
                    optional: false
                    type: input
                  bot_id: BA13894H
                  callback_id: identify_your_modals
                  clear_on_close: false
                  external_id: ''
                  hash: '156772938.1827394'
                  id: VMHU10V25
                  notify_on_close: false
                  private_metadata: Shh it is a secret
                  root_view_id: VMHU10V25
                  state:
                    values: {}
                  submit:
                    text: Create
                    type: plain_text
                  team_id: T8N4K1JN
                  title:
                    text: Quite a plain modal
                    type: plain_text
                  type: modal
        default:
          description: Typical error response, before getting to any possible validation errors.
          content:
            application/json:
              schema:
                title: Default error template
                required:
                - ok
                type: object
                properties:
                  ok:
                    $ref: '#/components/schemas/defs_ok_false'
                additionalProperties: true
                description: This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.
              example:
                error: invalid_arguments
                ok: false
                response_metadata:
                  messages:
                  - invalid `trigger_id`
      security:
      - slackAuth:
        - none
      summary: Slack Get Views Open
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK