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

# GetChannelStatusAPI mirrors erdo_channel_status: where the organization's


> email, WhatsApp, SMS and voice each stand, as one machine-readable state per channel with the numbers, senders, domains and registrations behind it. A composite over the per-number list and the sending domains; read-only, and it never reaches a provider.




## OpenAPI

````yaml /api/openapi.json get /v1/channels/status
openapi: 3.0.0
info:
  title: Erdo API
  description: >-
    Erdo's REST API: query and write datasets, run agents, manage threads,
    integrations, pages, evals, workstreams, experiments, and bounded outreach.
    Authenticate with a Bearer API key (erdo_api_...) or scoped token
    (erdo_token_...).
  version: '2026-11-05'
servers:
  - url: https://api.erdo.ai
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/channels/status:
    get:
      summary: >
        GetChannelStatusAPI mirrors erdo_channel_status: where the
        organization's
      description: >
        email, WhatsApp, SMS and voice each stand, as one machine-readable state
        per channel with the numbers, senders, domains and registrations behind
        it. A composite over the per-number list and the sending domains;
        read-only, and it never reaches a provider.
      operationId: GET:mcp.GetChannelStatusAPI
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  business_profile_complete:
                    description: |
                      every registration above depends on the business profile.
                    title: >
                      BusinessProfileComplete and MissingProfileFields are the
                      organization's:
                    type: boolean
                  email:
                    $ref: '#/components/schemas/mcp.ChannelStatus'
                  missing_profile_fields:
                    items:
                      type: string
                    type: array
                  sms:
                    $ref: '#/components/schemas/mcp.ChannelStatus'
                  voice:
                    $ref: '#/components/schemas/mcp.ChannelStatus'
                  whatsapp:
                    $ref: '#/components/schemas/mcp.ChannelStatus'
                type: object
          description: Success response
        default:
          $ref: '#/components/responses/APIError'
components:
  schemas:
    mcp.ChannelStatus:
      properties:
        items:
          items:
            $ref: '#/components/schemas/mcp.ChannelStatusItem'
          type: array
        reason:
          type: string
        remediation:
          $ref: '#/components/schemas/mcp.ChannelRemediation'
        state:
          type: string
      title: |
        ChannelStatus is one channel's state and the items it was derived from.
      type: object
    mcp.ChannelStatusItem:
      properties:
        address:
          title: |
            Address is the number or domain, empty for org-level registrations.
          type: string
        kind:
          description: >
            sending\_domain, shared\_sender, call\_attestation or
            branded\_calling.
          title: |
            Kind is phone_number, whatsapp_sender, shared_whatsapp_sender,
          type: string
        provider_status:
          title: |
            ProviderStatus is the underlying record's own status, unmapped.
          type: string
        reason:
          title: |
            Reason is the provider's words for a rejection or the last error.
          type: string
        remediation:
          $ref: '#/components/schemas/mcp.ChannelRemediation'
        state:
          type: string
      title: >
        ChannelStatusItem is one sender, domain or registration inside a
        channel.
      type: object
    mcp.ChannelRemediation:
      properties:
        action:
          title: |
            Action is one of the Remediation* values.
          type: string
        fields:
          items:
            type: string
          title: >
            Fields names the business-profile fields or inputs involved, when
            known.
          type: array
        next_step:
          title: >
            NextStep is the provider flow's own next step, verbatim, when it has
            one.
          type: string
      title: >
        ChannelRemediation is what has to change, as data: the UI owns the
        words.
      type: object
  responses:
    APIError:
      content:
        application/json:
          schema:
            externalDocs:
              url: https://pkg.go.dev/encore.dev/beta/errs#Error
            properties:
              code:
                description: Error code
                example: not_found
                externalDocs:
                  url: https://pkg.go.dev/encore.dev/beta/errs#ErrCode
                type: string
              details:
                description: Error details
                type: object
              message:
                description: Error message
                type: string
            title: APIError
            type: object
      description: Error response
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An Erdo API key (erdo_api_...) or scoped token (erdo_token_...).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.