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

# List phone numbers

> Get all phone numbers on your account.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/phone-numbers
openapi: 3.0.3
info:
  title: TopCalls Voice API
  description: >
    TopCalls Voice Gateway API for creating and managing AI-powered phone calls.


    ## Authentication


    All API requests require authentication. Include your API key in the
    `Authorization` header:


    ```

    Authorization: Bearer tc_live_xxxxx

    ```


    ## Rate Limits


    Direct call creation via `POST /v1/calls` is limited to your account's

    `max_calls_per_minute` setting (default: 20) per minute. Exceeding it
    returns

    `429 Too Many Requests` with a `Retry-After` header.

    All endpoints are additionally subject to a flat limit of 120 requests per

    minute per account (all methods).


    On a `429`, wait for the number of seconds in the `Retry-After` header, then

    retry the same request. For automated clients, back off progressively on

    repeated `429`s. Limits are per account and are shared by all API keys.


    ## Error Format


    All errors follow RFC 7807 Problem+JSON format:


    ```json

    {
      "type": "https://api.topcalls.ai/errors/insufficient_quota",
      "title": "Insufficient Quota",
      "status": 402,
      "detail": "You need 5 minutes but have 3.5 remaining"
    }

    ```
  version: 1.0.0
  contact:
    name: TopCalls Support
    url: https://topcalls.ai
  license:
    name: Proprietary
servers:
  - url: https://api.topcalls.ai
    description: Production
security: []
tags:
  - name: Calls
    description: Create and manage phone calls
  - name: Phone Numbers
    description: Manage phone numbers and carriers
  - name: Account
    description: Account information and usage
  - name: Webhooks
    description: Webhook configuration and events
  - name: Configuration
    description: Available AI models, voices, and platform capabilities
paths:
  /v1/phone-numbers:
    get:
      tags:
        - Phone Numbers
      summary: List phone numbers
      description: Get all phone numbers on your account.
      operationId: listPhoneNumbers
      parameters:
        - name: status
          in: query
          description: Filter by status
          schema:
            type: string
            enum:
              - active
              - inactive
              - pending
              - failed
              - deleted
        - name: source
          in: query
          description: Filter by source
          schema:
            type: string
            enum:
              - topcalls
              - byoc
              - manual
              - import
        - name: limit
          in: query
          description: Maximum number of results (default 50)
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: offset
          in: query
          description: Pagination offset
          schema:
            type: integer
            minimum: 0
            default: 0
      responses:
        '200':
          description: List of phone numbers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPhoneNumbersResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      security:
        - bearerAuth: []
components:
  schemas:
    ListPhoneNumbersResponse:
      type: object
      properties:
        phone_numbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber'
        count:
          type: integer
          description: Total number of phone numbers
    PhoneNumber:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Phone number UUID
        account_id:
          type: string
          format: uuid
          description: Account UUID
        number:
          type: string
          description: Phone number in E.164 format
          example: '+18005551234'
        source:
          type: string
          enum:
            - topcalls
            - byoc
            - manual
            - import
            - twilio
          description: |
            Phone number source:
            - `topcalls` - TopCalls default carrier
            - `byoc` - Bring Your Own Carrier
            - `manual` - Manually added
            - `import` - Imported from external source
        status:
          type: string
          enum:
            - active
            - inactive
            - pending
            - failed
            - deleted
          description: |
            Phone number status:
            - `active` - Ready to use
            - `inactive` - Disabled but still provisioned
            - `pending` - Provisioning in progress
            - `failed` - Provisioning failed
            - `deleted` - Soft deleted
        phone_number_sid:
          type: string
          format: uuid
          nullable: true
          description: Provisioned phone number ID in the telephony system
        voip_carrier_sid:
          type: string
          format: uuid
          nullable: true
          description: Carrier UUID
        carrier_name:
          type: string
          nullable: true
          description: Carrier display name
        label:
          type: string
          nullable: true
          description: User-friendly label
        error_message:
          type: string
          nullable: true
          description: Error details when status is 'failed'
        created_by_user_id:
          type: string
          format: uuid
          nullable: true
          description: User who created this number
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Problem:
      type: object
      required:
        - status
        - title
      properties:
        type:
          type: string
          format: uri
          description: Error type URI
        title:
          type: string
          description: Error title
        status:
          type: integer
          description: HTTP status code
        detail:
          type: string
          description: Human-readable error detail
        code:
          type: string
          description: >
            Machine-readable error code for programmatic handling. Present on

            errors that carry a stable identifier (e.g. `PROMPT_SAFETY_FRAUD`,

            `job_not_found`, `too_many_ids`, `no_matches`). Distinct from the

            per-field `errors[].code` used for validation failures. Scenario-

            specific — see each endpoint's response examples for the exact
            value.
        instance:
          type: string
          format: uuid
          description: Request instance ID
        errors:
          type: array
          description: Validation errors (for 400 responses)
          items:
            type: object
            properties:
              path:
                type: string
                description: Field path (e.g., "phone_number", "metadata.from_number")
              message:
                type: string
                description: Error message
              code:
                type: string
                description: Error code (e.g., "invalid_string", "custom")
        details:
          type: string
          description: Additional error details (for provider errors)
  responses:
    Unauthorized:
      description: Unauthorized (missing or invalid API key)
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 401
            title: Unauthorized
            detail: Invalid or missing API key
    Forbidden:
      description: Forbidden (missing required scope)
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
          example:
            status: 403
            title: Forbidden
            detail: 'Missing required scope: calls:write'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Use `Authorization: Bearer tc_live_xxxxx`

````