> ## 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.

# Retrieve a channel

> Fetches the details and configuration of a specific channel.



## OpenAPI

````yaml /openapi.json get /channels/{id}
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/{id}:
    get:
      tags:
        - Channels
      summary: Retrieve a channel
      description: Fetches the details and configuration of a specific channel.
      operationId: Channels_retrieve
      parameters:
        - name: id
          in: path
          required: true
          description: The channel ID.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChannelDetailsResponse'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '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

            id = "550e8400-e29b-41d4-a716-446655440000"
            Helo::Channels.retrieve(id)
        - 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.retrieve(
              "550e8400-e29b-41d4-a716-446655440000",
            );
        - 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\tresult, err := client.Channels.Retrieve(ctx, \"550e8400-e29b-41d4-a716-446655440000\")\n\tif err != nil {\n\t\tlog.Fatal(err)\n\t}\n\t_ = result\n}"
        - lang: csharp
          source: var channel = await helo.Channels.Retrieve("channel-id");
        - lang: python
          source: |-
            import sdk_helo_email as helo

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

            channel = client.channels.retrieve("channel-id")
components:
  schemas:
    ChannelDetailsResponse:
      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.
        updatedAt:
          type: string
          format: date-time
          description: When the channel was last updated.
        tracking:
          $ref: '#/components/schemas/ChannelTracking'
    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
    ChannelTracking:
      type: object
      required:
        - links
        - opens
      properties:
        links:
          type: boolean
          description: Whether link-click tracking is enabled.
        opens:
          type: boolean
          description: Whether open tracking is enabled.
    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'
    ValidationError:
      description: A single field validation error.
      required:
        - message
      type: object
      properties:
        message:
          description: Description of the validation failure.
          type: string
  responses:
    '401':
      description: Unauthorized
    '403':
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    '404':
      description: Not Found
      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

````