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

# List Phone Numbers

> List your team's phone numbers, newest first.



## OpenAPI

````yaml get /v1/agent/phone-numbers
openapi: 3.1.0
info:
  title: FishAudio OpenAPI
  version: '1'
servers:
  - description: Fish Audio API
    url: https://api.fish.audio
security: []
tags: []
paths:
  /v1/agent/phone-numbers:
    get:
      tags:
        - Phone Numbers
      summary: List Phone Numbers
      description: >-
        List your team's phone numbers, newest first. Released numbers are gone

        for good and never appear. Look an id up by E.164 with `phone_number`,
        or

        filter with `agent_id` to see one agent's numbers. Paginate with
        `cursor`

        (follow `next_cursor` while `has_more` is true) or with `page` for
        offset

        pagination with a `total` count — the two are mutually exclusive.
      parameters:
        - in: query
          name: phone_number
          description: Exact E.164 match, e.g. +14155550123.
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            default: null
            title: Phone Number
          deprecated: false
        - in: query
          name: agent_id
          description: Only numbers bound to this agent.
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            default: null
            title: Agent Id
          deprecated: false
        - in: query
          name: cursor
          description: ''
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            default: null
            title: Cursor
          deprecated: false
        - in: query
          name: page
          description: 1-based page number; mutually exclusive with cursor.
          required: false
          schema:
            anyOf:
              - minimum: 1
                type: integer
              - type: 'null'
            default: null
            title: Page
          deprecated: false
        - in: query
          name: include_total
          description: ''
          required: false
          schema:
            default: false
            title: Include Total
            type: boolean
          deprecated: false
        - in: query
          name: page_size
          description: ''
          required: false
          schema:
            default: 30
            maximum: 100
            minimum: 1
            title: Page Size
            type: integer
          deprecated: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                properties:
                  phone_numbers:
                    items:
                      $ref: '#/components/schemas/PublicPhoneNumberEntity'
                    title: Phone Numbers
                    type: array
                  has_more:
                    title: Has More
                    type: boolean
                  next_cursor:
                    anyOf:
                      - type: string
                      - type: 'null'
                    default: null
                    title: Next Cursor
                  total:
                    anyOf:
                      - type: integer
                      - type: 'null'
                    default: null
                    title: Total
                required:
                  - phone_numbers
                  - has_more
                type: object
        '400':
          description: Bad request syntax or unsupported method
          headers: {}
          content:
            application/json:
              schema:
                properties:
                  status:
                    title: Status
                    type: integer
                  message:
                    title: Message
                    type: string
                required:
                  - status
                  - message
                type: object
        '401':
          description: No permission -- see authorization schemes
          headers: {}
          content:
            application/json:
              schema:
                properties:
                  status:
                    title: Status
                    type: integer
                  message:
                    title: Message
                    type: string
                required:
                  - status
                  - message
                type: object
        '404':
          description: Nothing matches the given URI
          headers: {}
          content:
            application/json:
              schema:
                properties:
                  status:
                    title: Status
                    type: integer
                  message:
                    title: Message
                    type: string
                required:
                  - status
                  - message
                type: object
      security:
        - BearerAuth: []
components:
  schemas:
    PublicPhoneNumberEntity:
      properties:
        phone_number_id:
          title: Phone Number Id
          type: string
        workspace_id:
          title: Workspace Id
          type: string
        phone_number:
          description: E.164, e.g. +14155550123.
          title: Phone Number
          type: string
        provider:
          enum:
            - livekit
            - twilio
          title: Provider
          type: string
        label:
          default: ''
          title: Label
          type: string
        agent_id:
          anyOf:
            - type: string
            - type: 'null'
          description: Inbound calls route to this agent; unbound numbers ring busy.
          title: Agent Id
        status:
          enum:
            - provisioning
            - active
            - error
            - released
          title: Status
          type: string
        status_detail:
          default: ''
          description: What failed when status is `error`; empty otherwise.
          title: Status Detail
          type: string
        created_at:
          format: date-time
          title: Created At
          type: string
        updated_at:
          format: date-time
          title: Updated At
          type: string
      required:
        - phone_number_id
        - workspace_id
        - phone_number
        - provider
        - agent_id
        - status
        - created_at
        - updated_at
      title: PublicPhoneNumberEntity
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````