Slack Get API

openapi: 3.2.0
info:
  title: Slack Get API
  version: '1.0'
  description: 'Operations tagged Get across 10 of this provider''s published API definitions: slack-auth-openapi.yml, slack-dialog-openapi.yml, slack-oauth-openapi.yml, slack-reminders-openapi.yml, slack-stars-openapi.yml, slack-team-openapi.yml, slack-test-api-openapi.yml, slack-usergroups-openapi.yml, slack-users-openapi.yml, slack-views-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Get
paths:
  /auth.revoke:
    get:
      tags:
      - Get
      description: Revokes a token.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/auth.revoke
      operationId: getAuthRevoke
      parameters:
      - name: token
        in: query
        description: 'Authentication token. Requires scope: `none`'
        required: true
        schema:
          type: string
      - name: test
        in: query
        description: Setting this parameter to `1` triggers a _testing mode_ where the specified token will not actually be revoked.
        schema:
          type: boolean
      responses:
        '200':
          description: Typical success response
          content:
            application/json:
              schema:
                title: auth.revoke schema
                required:
                - ok
                - revoked
                type: object
                properties:
                  ok:
                    $ref: '#/components/schemas/defs_ok_true'
                  revoked:
                    type: boolean
                additionalProperties: false
                description: Schema for successful response from auth.revoke method
              example:
                ok: true
                revoked: true
        default:
          description: Typical error response
          content:
            application/json:
              schema:
                title: auth.revoke 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
                    - 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 auth.revoke method
              example:
                error: invalid_auth
                ok: false
      security:
      - slackAuth:
        - none
      summary: Slack Get Auth Revoke
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /auth.test:
    get:
      tags:
      - Get
      description: Checks authentication & identity.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/auth.test
      operationId: getAuthTest
      parameters:
      - name: token
        in: header
        description: 'Authentication token. Requires scope: `none`'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Standard success response when used with a user token
          content:
            application/json:
              schema:
                title: auth.test success schema
                required:
                - ok
                - team
                - team_id
                - url
                - user
                - user_id
                type: object
                properties:
                  bot_id:
                    $ref: '#/components/schemas/defs_bot_id'
                  is_enterprise_install:
                    type: boolean
                  ok:
                    $ref: '#/components/schemas/defs_ok_true'
                  team:
                    type: string
                  team_id:
                    $ref: '#/components/schemas/defs_team'
                  url:
                    type: string
                  user:
                    type: string
                  user_id:
                    $ref: '#/components/schemas/defs_user_id'
                additionalProperties: false
                description: Schema for successful response auth.test method
              example:
                ok: true
                team: Subarachnoid Workspace
                team_id: T12345678
                url: https://subarachnoid.slack.com/
                user: grace
                user_id: W12345678
        default:
          description: Standard failure response when used with an invalid token
          content:
            application/json:
              schema:
                title: auth.test 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
                    - token_revoked
                    - 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
                  ok:
                    $ref: '#/components/schemas/defs_ok_false'
                additionalProperties: false
                description: Schema for error response auth.test method
              example:
                error: invalid_auth
                ok: false
      security:
      - slackAuth:
        - none
      summary: Slack Get Auth Test
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /dialog.open:
    get:
      tags:
      - Get
      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
  /oauth.token:
    get:
      tags:
      - Get
      description: Exchanges a temporary OAuth verifier code for a workspace token.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/oauth.token
      operationId: getOauthToken
      parameters:
      - name: client_id
        in: query
        description: Issued when you created your application.
        schema:
          type: string
      - name: client_secret
        in: query
        description: Issued when you created your application.
        schema:
          type: string
      - name: code
        in: query
        description: The `code` param returned via the OAuth callback.
        schema:
          type: string
      - name: redirect_uri
        in: query
        description: This must match the originally submitted URI (if one was sent).
        schema:
          type: string
      - name: single_channel
        in: query
        description: Request the user to add your app only to a single channel.
        schema:
          type: boolean
      responses:
        '200':
          description: Success example using a workspace app produces a very different kind of 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:
                access_token:
                - TOKEN
                app_id: A012345678
                app_user_id: U0AB12ABC
                authorizing_user_id: U0HTT3Q0G
                installer_user_id: U061F7AUR
                ok: true
                permissions:
                - resource_id: 0
                  resource_type: channel
                  scopes:
                  - channels:read
                  - chat:write:user
                single_channel_id: C061EG9T2
                team_id: T061EG9Z9
                team_name: Subarachnoid Workspace
                token_type: app
        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_client_id
                ok: false
      security:
      - slackAuth:
        - none
      summary: Slack Get Oauth Token
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /reminders.info:
    get:
      tags:
      - Get
      description: Gets information about a reminder.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/reminders.info
      operationId: getRemindersInfo
      parameters:
      - name: token
        in: query
        description: 'Authentication token. Requires scope: `reminders:read`'
        schema:
          type: string
      - name: reminder
        in: query
        description: The ID of the reminder
        schema:
          type: string
      responses:
        '200':
          description: Typical success response
          content:
            application/json:
              schema:
                title: reminders.info schema
                required:
                - ok
                - reminder
                type: object
                properties:
                  ok:
                    $ref: '#/components/schemas/defs_ok_true'
                  reminder:
                    $ref: '#/components/schemas/objs_reminder'
                additionalProperties: false
                description: Schema for successful response from reminders.info method
              example:
                ok: true
        default:
          description: Typical error response
          content:
            application/json:
              schema:
                title: reminders.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:
                    - not_found
                    - 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.info method
              example:
                error: invalid_auth
                ok: false
      security:
      - slackAuth:
        - reminders:read
      summary: Slack Get Reminders Info
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /reminders.list:
    get:
      tags:
      - Get
      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:
      - Get
      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
  /team.accessLogs:
    get:
      tags:
      - Get
      description: Gets the access logs for the current team.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/team.accessLogs
      operationId: getTeamAccesslogs
      parameters:
      - name: token
        in: query
        description: 'Authentication token. Requires scope: `admin`'
        required: true
        schema:
          type: string
      - name: before
        in: query
        description: End of time range of logs to include in results (inclusive).
        schema:
          type: string
      - name: count
        in: query
        schema:
          type: string
      - name: page
        in: query
        schema:
          type: string
      responses:
        '200':
          description: This response demonstrates pagination and two access log entries.
          content:
            application/json:
              schema:
                title: team.accessLogs schema
                required:
                - logins
                - ok
                - paging
                type: object
                properties:
                  logins:
                    minItems: 1
                    uniqueItems: true
                    type: array
                    items:
                      type: object
                      additionalProperties: false
                  ok:
                    $ref: '#/components/schemas/defs_ok_true'
                  paging:
                    $ref: '#/components/schemas/objs_paging'
                additionalProperties: false
                description: Schema for successful response from team.accessLogs method
              example:
                logins:
                - count: 1
                  country: US
                  date_first: 1422922864
                  date_last: 1422922864
                  ip: 127.0.0.1
                  isp: BigCo ISP
                  region: CA
                  user_agent: SlackWeb Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.35 Safari/537.36
                  user_id: U45678
                  username: alice
                - count: 1
                  country: US
                  date_first: 1422922493
                  date_last: 1422922493
                  ip: 127.0.0.1
                  isp: BigCo ISP
                  region: CA
                  user_agent: SlackWeb Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_3 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Version/8.0 Mobile/12B466 Safari/600.1.4
                  user_id: U12345
                  username: white_rabbit
                ok: true
                paging:
                  count: 100
                  page: 1
                  pages: 1
                  total: 2
        default:
          description: 'A workspace must be on a paid plan to use this method, otherwise the `paid_only` error is thrown:'
          content:
            application/json:
              schema:
                title: team.accessLogs 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:
                    - paid_only
                    - over_pagination_limit
                    - 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 team.accessLogs method
              example:
                error: paid_only
                ok: false
      security:
      - slackAuth:
        - admin
      summary: Slack Get Team Accesslogs
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /team.billableInfo:
    get:
      tags:
      - Get
      description: Gets billable users information for the current team.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/team.billableInfo
      operationId: getTeamBillableinfo
      parameters:
      - name: token
        in: query
        description: 'Authentication token. Requires scope: `admin`'
        required: true
        schema:
          type: string
      - name: user
        in: query
        description: A user to retrieve the billable information for. Defaults to all users.
        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:
                billable_info:
                  U02UCPE1R:
                    billing_active: true
                  U02UEBSD2:
                    billing_active: true
                  U0632EWRW:
                    billing_active: false
                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
      summary: Slack Get Team Billableinfo
      x-api-evangelist-processing:
        GenerateOperationSummariesFromPath: true
        PascalCaseOperationSummaries: true
        CaselCaseOperationIds: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /team.info:
    get:
      tags:
      - Get
      description: Gets information about the current team.
      externalDocs:
        description: API method documentation
        url: https://api.slack.com/methods/team.info
      operationId: getTeamInfo
      parameters:
      - name: token
        in: query
        description: 'Authentication token. Requires scope: `team:read`'
        required: true
        schema:
          type: string
      - name: team
        in: query
        description: Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels
        schema:
          type: string
      responses:
        '200':
          description: Typical success response
          content:
            application/json:
              schema:
                title: team.info schema
       

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