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

# List all channels

> Retrieves a list of all channels accessible to the current user.



## OpenAPI

````yaml /openapi.json get /channels
openapi: 3.1.0
info:
  description: Helo API
  version: 1.0.0-beta.1
  title: Helo API
servers:
  - url: https://api.helohq.com
security: []
tags:
  - name: Activity
    description: >-
      Track and retrieve message activity, including messages, delivery and
      engagement events.
  - name: Broadcasts
    description: Manage and track broadcast email campaigns.
  - name: Channels
    description: Create and manage communication channels for organizing messages.
  - name: Domains
    description: Register, verify, and manage domains for email sending.
  - name: Sending
    description: Send transactional and broadcast emails.
  - name: Statistics
    description: Access activity statistics.
  - name: Webhooks
    description: Create and manage webhooks for event notifications.
paths:
  /channels:
    get:
      tags:
        - Channels
      summary: List all channels
      description: Retrieves a list of all channels accessible to the current user.
      operationId: Channels_list
      parameters:
        - name: limit
          in: query
          description: Maximum number of results to return. Defaults to 25.
          schema:
            type: integer
            format: int32
        - name: offset
          in: query
          description: Number of results to skip for pagination. Defaults to 0.
          schema:
            type: integer
            format: int32
        - name: name
          in: query
          description: Filter channels by name (partial match).
          schema:
            type: string
        - name: channelIds
          in: query
          description: Filter to a specific set of channel IDs.
          explode: false
          schema:
            type: array
            items:
              type: string
              format: uuid
        - name: deliveryType
          in: query
          description: Filter channels by delivery type.
          schema:
            enum:
              - live
              - sandbox
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginationResultOfChannelBasicResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          $ref: '#/components/responses/422'
        '500':
          $ref: '#/components/responses/500'
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: ruby
          source: |-
            Helo.configure do |config|
              config.api_key = ENV.fetch("HELO_API_KEY")
            end

            opts = {
              limit: 10,
              offset: 10,
              name: "example",
              channel_ids: ["550e8400-e29b-41d4-a716-446655440000", "6ba7b810-9dad-11d1-80b4-00c04fd430c8"],
              delivery_type: "live"
            }
            Helo::Channels.list(opts)
        - lang: javascript
          source: |-
            import Helo from "@helo-email/sdk";

            const apiKey = process.env.HELO_API_KEY;
            const helo = new Helo(apiKey);

            const result = await helo.channels.list({
              limit: 10,
              offset: 10,
              name: "example",
              channelIds: ["550e8400-e29b-41d4-a716-446655440000"],
              deliveryType: "live",
            });
        - lang: go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"log\"\n\t\"os\"\n\n\t\"github.com/helo-email/helo-sdk-go\"\n)\n\nfunc main() {\n\tclient := helo.NewHelo(os.Getenv(\"HELO_API_KEY\"))\n\tctx := context.Background()\n\n\tparams := &helo.ChannelsListParams{\n\t\tLimit: 10,\n\t\tOffset: 10,\n\t\tName: \"example\",\n\t\tChannelIds: []string{\"550e8400-e29b-41d4-a716-446655440000\"},\n\t\tDeliveryType: \"live\",\n\t}\n\tresult, err := client.Channels.List(ctx, params)\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\t_ = result\n}"
        - lang: csharp
          source: >-
            using HeloEmail.Sdk;


            var channels = await helo.Channels.List(limit: 20, deliveryType:
            DeliveryType.Live);
        - lang: python
          source: >-
            import sdk_helo_email as helo


            client = helo.Helo()  # reads HELO_API_KEY from the environment


            channels = client.channels.list(limit=20,
            delivery_type=helo.DeliveryType.LIVE)
components:
  schemas:
    PaginationResultOfChannelBasicResponse:
      required:
        - results
        - totalCount
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/ChannelBasicResponse'
        totalCount:
          type: integer
          format: int32
    ChannelBasicResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The unique channel ID.
        name:
          type: string
          description: The display name of the channel.
        deliveryType:
          $ref: '#/components/schemas/DeliveryType'
        createdAt:
          type: string
          format: date-time
          description: When the channel was created.
    ErrorResponse:
      description: Standard error response body.
      type: object
      properties:
        type:
          description: A URI reference identifying the problem type.
          type: string
        title:
          description: Short, human-readable summary of the problem.
          type: string
        instance:
          description: URI reference identifying the specific occurrence of the problem.
          type: string
        status:
          description: HTTP status code.
          type: integer
          format: int32
        code:
          description: Application-specific error code.
          type: string
        detail:
          description: Human-readable explanation of this specific occurrence.
          type: string
        requestId:
          description: Unique request ID, useful for support correlation.
          type: string
        errors:
          description: Field-level validation errors, keyed by field name.
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ValidationError'
    DeliveryType:
      description: |
        Delivery mode for a channel. `live` sends real emails, whereas `sandbox`
        accepts and processes messages without delivering them to recipients.
      enum:
        - live
        - sandbox
    ValidationError:
      description: A single field validation error.
      required:
        - message
      type: object
      properties:
        message:
          description: Description of the validation failure.
          type: string
  responses:
    '400':
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    '401':
      description: Unauthorized
    '403':
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    '422':
      description: Unprocessable Entity
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    '500':
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````