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

# List phone numbers

> Every number in your workspace, newest first, including purchases still provisioning and ones that failed.



## OpenAPI

````yaml /api-reference/openapi.json get /phone_numbers
openapi: 3.0.0
info:
  contact: {}
  description: >-
    Public REST API for Brilo. Authenticate by sending your API key as a Bearer
    token in the `Authorization` header.
  title: Brilo API
  version: '2025-03-02'
servers:
  - description: Production
    url: https://api.brilo.ai/v1
security: []
tags: []
paths:
  /phone_numbers:
    get:
      tags:
        - Agents (public)
      summary: List phone numbers
      description: >-
        Every number in your workspace, newest first, including purchases still
        provisioning and ones that failed.
      operationId: listPhoneNumbers
      parameters:
        - description: Rows to skip.
          in: query
          name: offset
          required: false
          schema:
            default: 0
            description: Rows to skip.
            maximum: 100000
            minimum: 0
            type: integer
        - description: Page size, at most 200.
          in: query
          name: limit
          required: false
          schema:
            default: 50
            description: Page size, at most 200.
            maximum: 200
            minimum: 1
            type: integer
        - description: Only numbers attached to this agent.
          in: query
          name: agent_id
          required: false
          schema:
            description: Only numbers attached to this agent.
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
            type: string
        - description: Only numbers in this state.
          in: query
          name: status
          required: false
          schema:
            description: Only numbers in this state.
            enum:
              - provisioning
              - active
              - releasing
              - failed
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    items:
                      additionalProperties: false
                      properties:
                        agent_id:
                          nullable: true
                          type: string
                        created_at:
                          type: string
                        currency:
                          nullable: true
                          type: string
                        failure:
                          additionalProperties: false
                          description: >-
                            Why a failed purchase failed. Null unless status is
                            failed.
                          nullable: true
                          properties:
                            error_code:
                              description: >-
                                carrier_purchase_failed,
                                phone_number_unavailable, provisioning_failed,
                                stripe_error or provisioning_timeout.
                              type: string
                            message:
                              type: string
                          required:
                            - error_code
                            - message
                          type: object
                        id:
                          description: >-
                            Stable from the first response: the purchase id
                            becomes the number id.
                          type: string
                        imported:
                          type: boolean
                        managed_by_plan:
                          description: >-
                            Part of an Agent Phone Plan: give it up by
                            cancelling the plan.
                          type: boolean
                        monthly_price:
                          nullable: true
                          type: number
                        phone_number:
                          type: string
                        refunded:
                          description: >-
                            A failed purchase whose payment was refunded in
                            full.
                          type: boolean
                        release_at:
                          description: >-
                            When a releasing number goes away. PATCH release_at
                            null to keep it.
                          nullable: true
                          type: string
                        revision:
                          nullable: true
                          type: string
                        status:
                          enum:
                            - provisioning
                            - active
                            - releasing
                            - failed
                          type: string
                      required:
                        - id
                        - phone_number
                        - status
                        - agent_id
                        - monthly_price
                        - currency
                        - release_at
                        - managed_by_plan
                        - imported
                        - failure
                        - refunded
                        - revision
                        - created_at
                      type: object
                    type: array
                  limit:
                    maximum: 9007199254740991
                    minimum: -9007199254740991
                    type: integer
                  offset:
                    maximum: 9007199254740991
                    minimum: -9007199254740991
                    type: integer
                  total:
                    maximum: 9007199254740991
                    minimum: -9007199254740991
                    type: integer
                required:
                  - data
                  - total
                  - offset
                  - limit
                type: object
          description: ''
        '400':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  details:
                    additionalProperties: {}
                    type: object
                  error_code:
                    type: string
                  errors:
                    items:
                      additionalProperties: false
                      properties:
                        error_code:
                          type: string
                        field:
                          type: string
                        message:
                          type: string
                      required:
                        - field
                        - error_code
                        - message
                      type: object
                    type: array
                  hint:
                    type: string
                  message:
                    type: string
                  next_action:
                    additionalProperties: false
                    properties:
                      body:
                        additionalProperties: {}
                        type: object
                      method:
                        type: string
                      path:
                        type: string
                      tool:
                        type: string
                    required:
                      - tool
                      - method
                      - path
                    type: object
                  status:
                    maximum: 9007199254740991
                    minimum: -9007199254740991
                    type: integer
                required:
                  - status
                  - error_code
                  - message
                type: object
          description: validation_failed
        '503':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  details:
                    additionalProperties: {}
                    type: object
                  error_code:
                    type: string
                  errors:
                    items:
                      additionalProperties: false
                      properties:
                        error_code:
                          type: string
                        field:
                          type: string
                        message:
                          type: string
                      required:
                        - field
                        - error_code
                        - message
                      type: object
                    type: array
                  hint:
                    type: string
                  message:
                    type: string
                  next_action:
                    additionalProperties: false
                    properties:
                      body:
                        additionalProperties: {}
                        type: object
                      method:
                        type: string
                      path:
                        type: string
                      tool:
                        type: string
                    required:
                      - tool
                      - method
                      - path
                    type: object
                  status:
                    maximum: 9007199254740991
                    minimum: -9007199254740991
                    type: integer
                required:
                  - status
                  - error_code
                  - message
                type: object
          description: billing_unavailable
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: Enter your API key (Bearer token)
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.