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

# List phone numbers

> List phone numbers in your workspace.



## OpenAPI

````yaml get /phone_numbers
openapi: 3.0.3
info:
  title: Vogent - OpenAPI 3.0
  description: Test Description
  version: 1.0.11
servers:
  - url: https://api.vogent.ai/api
security:
  - bearerAuth: []
paths:
  /phone_numbers:
    get:
      summary: List phone numbers
      description: List phone numbers in your workspace.
      parameters:
        - in: query
          name: limit
          schema:
            type: integer
            nullable: false
            default: 100
          description: The maximum number of phone numbers to list.
          required: false
        - in: query
          name: cursor
          schema:
            type: string
          required: false
          description: >-
            The pagination cursor returned by the previous request. Feed the
            result provided by vogent verbatim.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PhoneNumber'
                  cursor:
                    type: string
                    nullable: true
                    description: >-
                      A cursor you can pass to fetch the next page. If no next
                      page exists, the cursor will be null.
                required:
                  - data
                  - cursor
        '400':
          description: Invalid input
        '422':
          description: Validation exception
components:
  schemas:
    PhoneNumber:
      type: object
      properties:
        id:
          type: string
        number:
          type: string
          example: '+18001234567'
          description: >-
            The number in e.164 format, or the SIP username, if the type is
            SIP_USERNAME.
        type:
          $ref: '#/components/schemas/PhoneNumberType'
        agentId:
          type: string
          nullable: true
          description: The ID of the linked agent, if the phone number is linked to one.
      required:
        - id
        - number
        - agentId
        - type
    PhoneNumberType:
      type: string
      enum:
        - PSTN
        - SIP_USERNAME
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        In the form `Bearer <api_key_here>`. You can find your api key in your
        dashboard.

````