Slack Connect API

openapi: 3.1.0
info:
  version: '1.0'
  title: Slack Admin Access Connect 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: Connect
paths:
  /rtm.connect:
    get:
      tags:
      - Connect
      description: Starts a Real Time Messaging session.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/rtm.connect
      operationId: getRtmConnect
      parameters:
      - name: token
        in: query
        description: 'Authentication token. Requires scope: `rtm:stream`'
        required: true
        schema:
          type: string
      - name: batch_presence_aware
        in: query
        description: Batch presence deliveries via subscription. Enabling changes the shape of `presence_change` events. See [batch presence](/docs/presence-and-status#batching).
        schema:
          type: boolean
      - name: presence_sub
        in: query
        description: Only deliver presence events when requested by subscription. See [presence subscriptions](/docs/presence-and-status#subscriptions).
        schema:
          type: boolean
      responses:
        '200':
          description: Typical success response
          content:
            application/json:
              schema:
                title: rtm.connect schema
                required:
                - ok
                - self
                - team
                - url
                type: object
                properties:
                  ok:
                    $ref: '#/components/schemas/defs_ok_true'
                  self:
                    type: object
                    additionalProperties: false
                  team:
                    type: object
                    additionalProperties: false
                  url:
                    type: string
                    format: uri
                additionalProperties: false
                description: Schema for successful response from rtm.connect method
              example:
                ok: true
                self:
                  id: U4X318ZMZ
                  name: robotoverlord
                team:
                  domain: slackdemo
                  id: T2U81E2FP
                  name: SlackDemo
                url: wss://...
        default:
          description: Typical error response
          content:
            application/json:
              schema:
                title: rtm.connect error schema
                required:
                - error
                - ok
                type: object
                properties:
                  callstack:
                    type: string
                    description: 'Note: PHP callstack is only visible in dev/qa'
                  error:
                    type: string
                    enum:
                    - not_authed
                    - invalid_auth
                    - account_inactive
                    - token_revoked
                    - no_permission
                    - invalid_arg_name
                    - invalid_array_arg
                    - invalid_charset
                    - invalid_form_data
                    - invalid_post_type
                    - missing_post_type
                    - team_added_to_org
                    - invalid_json
                    - json_not_object
                    - request_timeout
                    - upgrade_required
                    - fatal_error
                  ok:
                    $ref: '#/components/schemas/defs_ok_false'
                additionalProperties: false
                description: Schema for error response from rtm.connect method
              example:
                error: invalid_auth
                ok: false
      security:
      - slackAuth:
        - rtm:stream
      summary: Slack Get Rtm Connect
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK