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

# Telephony Overview

> Per-number lifecycle: connection state, termination, agent link, sync state

A per-number lifecycle overview for your organization: one row per `ASSIGNED` number on
your bridges, exposing `connection_state`, termination kind, agent link, and the
projection `sync_state`. This endpoint is DB-only - it never live-probes the projection
planes, so it stays fast and never errors on a missing projection. Secrets are masked.

<Note>
  **Prerequisites:** API Token + Org-Handle. See [Authentication](/api/get-started/authentication).
</Note>

### Headers

| Name          | Type   | Required | Description                |
| ------------- | ------ | -------- | -------------------------- |
| Authorization | string | Yes      | `Token <your-api-key>`     |
| Org-Handle    | string | Yes      | Organization domain handle |
| Product-Id    | string | No       | Optional product filter    |

### Row fields

| Field             | Type    | Description                            |
| ----------------- | ------- | -------------------------------------- |
| number\_id        | integer | Number id                              |
| number            | string  | E.164 number                           |
| bridge\_slug      | string  | Bridge the number is on                |
| connection\_state | string  | e.g. `LINKED`, `NOT_LINKED`            |
| termination\_kind | string  | `sip` (carrier) or `agent`             |
| agent\_id         | string  | Linked agent handle (null for carrier) |
| sync\_state       | string  | Projection sync state                  |
| sync\_detail      | string  | Extra sync detail (nullable)           |

<ResponseExample>
  ```json 200 theme={null}
  {
    "status_code": 200,
    "message": "Telephony overview fetched successfully.",
    "data": [
      {
        "number_id": 501,
        "number": "+15551234567",
        "bridge_slug": "support-bridge",
        "connection_state": "LINKED",
        "termination_kind": "sip",
        "agent_id": null,
        "sync_state": "synced",
        "sync_detail": null
      }
    ]
  }
  ```

  ```json 206 theme={null}
  { "message": "Please provide Org-Handle in headers" }
  ```
</ResponseExample>

```bash cURL theme={null}
curl -s "https://unpod.ai/api/v2/platform/telephony/overview/" \
  -H "Authorization: Token <your-api-key>" \
  -H "Org-Handle: <your-org-handle>"
```


## OpenAPI

````yaml GET /api/v2/platform/telephony/overview/
openapi: 3.0.3
info:
  title: Unpod API
  description: REST API for Unpod Voice AI Platform
  version: 2.0.0
servers:
  - url: https://unpod.ai/
    description: QA
  - url: https://unpod.ai/
    description: Production
security: []
tags:
  - name: Organisation
  - name: Spaces
  - name: Agents
  - name: Tasks
  - name: Runs
  - name: Call Logs
  - name: Analytics
  - name: Providers
  - name: Bridges
  - name: Numbers
  - name: Trunks
  - name: Telephony
  - name: Billing
paths:
  /api/v2/platform/telephony/overview/:
    get:
      tags:
        - Telephony
      summary: Telephony Overview
      operationId: getTelephonyOverview
      parameters:
        - $ref: '#/components/parameters/OrgHandle'
        - $ref: '#/components/parameters/ProductId'
      responses:
        '200':
          description: Per-number lifecycle overview for the organization
          content:
            application/json:
              example:
                status_code: 200
                message: Telephony overview fetched successfully.
                data:
                  - number_id: 501
                    number: '+15551234567'
                    bridge_slug: support-bridge
                    connection_state: LINKED
                    termination_kind: sip
                    agent_id: null
                    sync_state: synced
                    sync_detail: null
        '206':
          description: Business logic error (missing header / org not found)
          content:
            application/json:
              example:
                message: Please provide Org-Handle in headers
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - TokenAuth: []
components:
  parameters:
    OrgHandle:
      name: Org-Handle
      in: header
      required: true
      schema:
        type: string
        example: unpod.tv
      description: Organization domain handle
    ProductId:
      name: Product-Id
      in: header
      required: false
      schema:
        type: string
        example: unpod.dev
      description: Product scope for the auto-resolved bridge (default unpod.dev)
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API token
      content:
        application/json:
          example:
            status_code: 401
            message: Authentication credentials were not provided.
  securitySchemes:
    TokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: 'Format: Token <your-api-key>'

````