> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hq.zone/llms.txt
> Use this file to discover all available pages before exploring further.

# List Slack channels

> Lists the Slack channels the HQ bot is a member of (each with id, name, and whether
it is private), which is also the set of channels HQ can post to, for use in pickers
such as the schedule editor. The response includes a connected flag that is false
when the workspace has no active Slack installation, in which case the channel list
is empty. Scoped to the caller's workspace; requires the agents:read scope.



## OpenAPI

````yaml GET /v1/api/slack/channels
openapi: 3.1.0
info:
  title: HQ API
  description: >-
    Public HTTP API for HQ. Authenticate with a Personal Access Token
    (`Authorization: Bearer hq_pat_...`) for server-side integrations, or an
    OAuth 2.1 authorization-code + PKCE flow for browser apps acting on a user's
    behalf. Both grant from the same resource:action scope vocabulary; an
    endpoint's required scope is listed under its `security`.
  license:
    name: Apache-2.0
    identifier: Apache-2.0
  version: 1.0.0
servers:
  - url: https://api.hq.zone
    description: HQ API (production)
security: []
tags:
  - name: me
    description: The signed-in user's own account
  - name: conversations
    description: Conversations and their messages
  - name: documents
    description: The content-addressed documents library
  - name: schedules
    description: Scheduled prompts and recurring tasks
  - name: agents
    description: Agents, their skills and integrations
  - name: memory
    description: What the assistant remembers (L5 governance)
  - name: tokens
    description: Personal Access Token management
  - name: billing
    description: Usage and billing
  - name: notifications
    description: In-app notification center
  - name: admin
    description: Workspace administration
  - name: integrations
    description: Workspace integrations (Slack, MCP, skills)
  - name: onboarding
    description: New-workspace onboarding wizard
  - name: auth
    description: Sign-in, sessions, and OAuth
paths:
  /v1/api/slack/channels:
    get:
      tags:
        - integrations
      summary: List Slack channels
      description: >-
        Lists the Slack channels the HQ bot is a member of (each with id, name,
        and whether

        it is private), which is also the set of channels HQ can post to, for
        use in pickers

        such as the schedule editor. The response includes a connected flag that
        is false

        when the workspace has no active Slack installation, in which case the
        channel list

        is empty. Scoped to the caller's workspace; requires the agents:read
        scope.
      operationId: list_channels
      responses:
        '200':
          description: Channels the HQ bot belongs to
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelsResp'
      security:
        - bearer_pat:
            - agents:read
        - oauth2:
            - agents:read
components:
  schemas:
    ChannelsResp:
      type: object
      required:
        - connected
        - channels
      properties:
        channels:
          type: array
          items:
            $ref: '#/components/schemas/ChannelJson'
        connected:
          type: boolean
          description: |-
            Whether this workspace has a live (non-revoked) Slack install.
            `false` means the picker should prompt to connect Slack rather
            than show an empty list.
    ChannelJson:
      type: object
      required:
        - id
        - name
        - is_private
      properties:
        id:
          type: string
        is_private:
          type: boolean
        name:
          type: string
  securitySchemes:
    bearer_pat:
      type: http
      scheme: bearer
      bearerFormat: hq_pat
      description: 'Personal Access Token. Send as `Authorization: Bearer hq_pat_...`.'
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hq.zone/v1/oauth/authorize
          tokenUrl: https://api.hq.zone/v1/oauth/token
          refreshUrl: https://api.hq.zone/v1/oauth/token
          scopes:
            admin: Administer the workspace (users, settings, integrations)
            agents:read: View the agents in your workspace
            agents:write: Create and configure agents
            billing:read: View usage and billing information
            conversations:read: Read your conversations and their messages
            conversations:write: Start conversations and send messages on your behalf
            documents:read: Read your documents library
            documents:write: Upload and manage documents in your library
            memory:read: Read what the assistant remembers about you
            memory:write: Correct or delete what the assistant remembers
            schedules:read: View your scheduled tasks
            schedules:write: Create and manage scheduled tasks
            tables:read: Read your tables and their rows
            tables:write: Create tables and add, edit, or delete rows

````