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

# List channels in a workspace

> Returns the channels in the selected workspace. Use `id` (`ch_...`) for HookMyApp API calls.
Use the provider-specific display fields, such as `whatsappDisplayPhoneNumber` or
`instagramUsername`, for customer-facing labels.




## OpenAPI

````yaml api-reference/openapi.yaml GET /meta/channels
openapi: 3.1.0
info:
  title: HookMyApp API
  version: 1.0.0
  description: >
    The HookMyApp REST API. Everything the dashboard and the CLI can do, your

    code and your AI agents can do too.


    ## Authentication


    Two kinds of Bearer credentials exist. Do not mix them up:


    - **API key (`hmok_...`)** authenticates *you* (or your agent) to
      `https://api.hookmyapp.com`.
      Create one in the dashboard under **Org → API keys → Create API Key**
      (full org access, optional expiration date, reveal or
      revoke it any time from that page), or without a
      browser via the [agent auth flow](#tag/agent-auth) described in
      [`GET /auth.md`](https://api.hookmyapp.com/auth.md). That flow can mint a
      scope-limited key. Send it as `Authorization: Bearer hmok_...`, or on
      `/mcp` as `X-API-Key: hmok_...`. Use it for org, workspace, customer,
      channel and webhook management.
    - **Channel token (`hmat_...`)** sends messages from one connected channel.
      Mint it with `GET /meta/channels/{id}/token`. It is not valid on
      `https://api.hookmyapp.com`.

    Browser sessions from the dashboard use the same endpoints with a session

    cookie or WorkOS JWT instead of `hmok_`.


    ## IDs


    Every ID on the wire is a typed public ID, never an internal UUID:

    `ws_` workspace/customer, `ch_` channel, `org_` organization,

    `cred_` connection credential, `ac_` agent credential.


    ## Workspace context


    Workspace-scoped routes (channels, webhook config, and deliveries) resolve
    the

    workspace from the `X-Workspace-Id: ws_XXXXXXXX` header.


    ## Errors


    Errors return a stable machine-readable `code` plus a human `message`.

    Agent tokens that exceed their granted scopes get `403
    AGENT_SCOPE_INSUFFICIENT`.


    ## Webhook signatures


    Deliveries to your webhook are signed with `X-HookMyApp-Signature-256`,

    an HMAC-SHA256 of the raw body keyed on the channel `WEBHOOK_HMAC_SECRET`.

    The Verify Token is a separate value used only for the GET ownership probe.
servers:
  - url: https://api.hookmyapp.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Agent auth
    description: Register an agent credential (`hmok_`) with email OTP, no browser needed
  - name: Organizations
    description: Your organization and its summary
  - name: Customers
    description: Customer workspaces you run messaging for (SaaS Mode)
  - name: Onboarding links
    description: Links your customers open to connect their own channels
  - name: Workspaces
    description: Team workspaces
  - name: Channels
    description: Connected WhatsApp and Instagram channels, and their channel tokens
  - name: Webhook config
    description: Where inbound messages are delivered for a channel
  - name: Deliveries
    description: Inspect inbound delivery logs and app responses
paths:
  /meta/channels:
    get:
      tags:
        - Channels
      summary: List channels in a workspace
      description: >
        Returns the channels in the selected workspace. Use `id` (`ch_...`) for
        HookMyApp API calls.

        Use the provider-specific display fields, such as
        `whatsappDisplayPhoneNumber` or

        `instagramUsername`, for customer-facing labels.
      operationId: listChannels
      parameters:
        - $ref: '#/components/parameters/WorkspaceHeader'
      responses:
        '200':
          description: Channels in the workspace
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Channel'
components:
  parameters:
    WorkspaceHeader:
      name: X-Workspace-Id
      in: header
      required: true
      schema:
        type: string
        pattern: ^ws_[A-Za-z0-9]{8}$
      description: Workspace ID for the request
  schemas:
    Channel:
      type: object
      properties:
        id:
          type: string
          description: ch_ publicId
        type:
          type: string
          enum:
            - whatsapp
            - instagram
            - messenger
        workspaceId:
          type: string
          description: ws_ publicId
        metaResourceId:
          type: string
          description: >
            Advanced Meta provider identifier. For WhatsApp this is the WABA ID.

            For Instagram this is the Instagram account Graph ID. Use `id`
            (`ch_...`) for

            HookMyApp API calls and friendly fields for display.
        metaWabaId:
          type:
            - string
            - 'null'
          description: >-
            WhatsApp WABA ID, retained for compatibility. Null for non-WhatsApp
            channels.
        updatedAt:
          type: string
          format: date-time
        whatsappWabaName:
          type:
            - string
            - 'null'
        whatsappDisplayPhoneNumber:
          type:
            - string
            - 'null'
        whatsappPhoneNumberId:
          type:
            - string
            - 'null'
        whatsappVerifiedName:
          type:
            - string
            - 'null'
        whatsappProfilePictureUrl:
          type:
            - string
            - 'null'
          description: |
            Short-lived signed HookMyApp URL for the channel's profile
            picture. Fetch it soon after reading the response — mint a fresh
            one by re-reading the channel when it expires.
        whatsappQualityRating:
          type:
            - string
            - 'null'
        instagramUsername:
          type:
            - string
            - 'null'
        instagramProfileName:
          type:
            - string
            - 'null'
        instagramProfilePictureUrl:
          type:
            - string
            - 'null'
        connectionType:
          type: string
        metaConnected:
          type: boolean
          description: >-
            Whether Meta currently appears connected for this channel. This is
            Meta health, not the HookMyApp lifecycle state.
        forwardingEnabled:
          type: boolean
        forwardingDisabledReason:
          type:
            - string
            - 'null'
        channelStatus:
          type: string
          enum:
            - connected
            - disconnected
            - archived
          description: >-
            HookMyApp lifecycle state. Use this to decide whether the channel is
            active in HookMyApp.
        metaRetryDisabled:
          type: boolean
        credentialPublicId:
          type:
            - string
            - 'null'
          description: cred_ publicId
        webhookUrl:
          type:
            - string
            - 'null'
        verifyToken:
          type:
            - string
            - 'null'
        hmacSecret:
          type:
            - string
            - 'null'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: '`Authorization: Bearer hmok_...` API key or a dashboard session token'

````