Slack Bots API

The Bots API from Slack — 1 operation(s) for bots.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

slack-bots-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  version: '1.0'
  title: Slack Admin Access Bots 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: Bots
paths:
  /bots.info:
    get:
      tags:
      - Bots
      description: Gets information about a bot user.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/bots.info
      operationId: getBotsInfo
      parameters:
      - name: token
        in: query
        description: 'Authentication token. Requires scope: `users:read`'
        required: true
        schema:
          type: string
      - name: bot
        in: query
        description: Bot user to get info on
        schema:
          type: string
      responses:
        '200':
          description: When successful, returns bot info by bot ID.
          content:
            application/json:
              schema:
                title: bots.info schema
                required:
                - bot
                - ok
                type: object
                properties:
                  bot:
                    type: object
                    additionalProperties: false
                  ok:
                    $ref: '#/components/schemas/defs_ok_true'
                additionalProperties: false
                description: Schema for successful response from bots.info method
              example:
                bot:
                  app_id: A161CLERW
                  deleted: false
                  icons:
                    image_36: https://...
                    image_48: https://...
                    image_72: https://...
                  id: B061F7JD2
                  name: beforebot
                  updated: 1449272004
                  user_id: U012ABCDEF
                ok: true
        default:
          description: When no bot can be found, it returns an error.
          content:
            application/json:
              schema:
                title: bots.info error schema
                required:
                - error
                - ok
                type: object
                properties:
                  callstack:
                    type: string
                    description: 'Note: PHP callstack is only visible in dev/qa'
                  error:
                    type: string
                    enum:
                    - bot_not_found
                    - not_authed
                    - invalid_auth
                    - account_inactive
                    - token_revoked
                    - no_permission
                    - org_login_required
                    - invalid_arg_name
                    - invalid_array_arg
                    - invalid_charset
                    - invalid_form_data
                    - invalid_post_type
                    - missing_post_type
                    - team_added_to_org
                    - invalid_json
                    - json_not_object
                    - request_timeout
                    - upgrade_required
                    - fatal_error
                  ok:
                    $ref: '#/components/schemas/defs_ok_false'
                additionalProperties: false
                description: Schema for error response from bots.info method
              example:
                error: bot_not_found
                ok: false
      security:
      - slackAuth:
        - users:read
      summary: Slack Get Bots Info
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK