---
title: "List phone numbers"
method: GET
path: "/phone-numbers"
tags: ["Phone Numbers"]
---

# List phone numbers

`GET /phone-numbers`

## Request

- Base URL: `https://app.freyavoice.ai/api/v2`
- URL: `https://app.freyavoice.ai/api/v2/phone-numbers`
- Auth: HTTP bearer

Returns phone numbers for a workspace with pagination, filtering, and optional counts by column.

## Query parameters

- `workspaceId` string, uuid, required: Workspace ID
- `limit` string: Page size
- `offset` string: Offset for pagination
- `filters` string: Base64-encoded filter state
- `search` string: Global search term
- `sortBy` string: Sort field name
- `sortOrder` 'asc' | 'desc': Sort direction
- `export` string: Set to 'true' to return a file export
- `exportFormat` 'csv' | 'xlsx' | 'markdown': Export file format
- `exportColumns` string: JSON array of column definitions {id,label}
- `countBy` string: Column ID to return counts for (e.g., 'configType')

## Response `200`

Phone numbers with pagination

- object
  - `success` true, required
  - `data` object, required
    - `message` string, required
    - `result` object, required
      - `phoneNumbers` object[], required
        - `id` string, required
        - `number` string, required
        - `friendlyName` string, nullable
        - `workspaceId` string, required
        - `userId` string, required
        - `config` object, nullable
          - `capabilities` object
            - `voice` string
            - `sms` boolean
          - `voiceConfig` string
          - `messagingConfig` string
          - `emergencyCalls` boolean
          - `configType` 'agents' | 'workflows'
          - `inboundAgentId` string
          - `outboundAgentId` string
          - `inboundWorkflowId` string
          - `outboundWorkflowId` string
          - `originationUri` string
          - `sipInbound` object
            - `enabled` boolean, required
          - `sipOutbound` object
            - `enabled` boolean, required
            - `endpoint` string
            - `port` number
            - `username` string
            - `password` string
            - `transportProtocol` 'UDP' | 'TCP' | 'TLS'
            - `secureMedia` boolean
            - `headers` object[]
              - …
        - `createdAt` string, required
        - `updatedAt` string, required
        - `inboundAgentName` string, nullable
        - `outboundAgentName` string, nullable
        - `inboundWorkflowName` string, nullable
        - `outboundWorkflowName` string, nullable
      - `pagination` object, required
        - `total` number, required
        - `limit` number, required
        - `offset` number, required
        - `hasNext` boolean, required
        - `hasPrevious` boolean, required
      - `counts` object

## Other responses

- `400`: Validation error
- `401`: Missing or invalid token
- `500`: Server error

---

[API](https://skmtc.dev/freyavoice/apis/freyavoice-api.md) - [All operations](https://skmtc.dev/freyavoice/apis/freyavoice-api/llms.txt) - [OpenAPI document](https://skmtc.dev/freyavoice/apis/freyavoice-api/revisions/153d120f0c73?raw)