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

# List Numbers

> Retrieve a paginated list of all AI phone numbers associated with your account. Use this endpoint to get an overview of all your AI numbers and their details.

## List Numbers

Retrieve a paginated list of all AI phone numbers associated with your account. Use this endpoint to get an overview of all your AI numbers and their details.

<ParamField body="query" path="page" type="integer" required>
  The page number to retrieve (starts from 1)
</ParamField>

<ParamField body="query" path="per_page" type="integer" required>
  Number of numbers to return per page (maximum 100)
</ParamField>

<ParamField body="header" path="Authorization" type="string" required>
  Bearer token in the format: `Bearer {access_token}`
</ParamField>

<ParamField body="header" path="Content-Type" type="string" required>
  Must be set to `application/json`
</ParamField>

<CodeGroup>
  ```bash cURL theme={null}
  curl --location 'https://app.aisync.link/api/ai/number/list?page=1&per_page=25' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer {{bearer_token}}'
  ```
</CodeGroup>

<ResponseField name="data" type="array">
  Array of phone number objects containing number details
</ResponseField>

<ResponseField name="current_page" type="integer">
  The current page number
</ResponseField>

<ResponseField name="per_page" type="integer">
  Number of items per page
</ResponseField>

<ResponseField name="total" type="integer">
  Total number of phone numbers available
</ResponseField>

<Note>
  Use pagination parameters to efficiently retrieve large lists of phone numbers. The maximum number of numbers per page is 100.
</Note>


## OpenAPI

````yaml GET /api/ai/number/list
openapi: 3.1.0
info:
  title: AI Sync OAuth API
  description: OAuth 2.0 API for authenticating and authorizing third-party applications
  version: 1.0.0
servers:
  - url: https://app.aisync.link
    description: Production server
security: []
paths:
  /api/ai/number/list:
    get:
      tags:
        - AI Numbers
      summary: List Numbers
      description: >-
        Retrieve a paginated list of all AI phone numbers associated with your
        account. Use this endpoint to get an overview of all your AI numbers and
        their details.
      operationId: listNumbers
      parameters:
        - name: page
          in: query
          description: The page number to retrieve (starts from 1)
          required: true
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per_page
          in: query
          description: Number of numbers to return per page (maximum 100)
          required: true
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
      responses:
        '200':
          description: List of phone numbers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberListResponse'
        '401':
          description: Invalid or expired token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    NumberListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Number'
          description: Array of phone number objects containing number details
        current_page:
          type: integer
          description: The current page number
        per_page:
          type: integer
          description: Number of items per page
        total:
          type: integer
          description: Total number of phone numbers available
      required:
        - data
        - current_page
        - per_page
        - total
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error code
        error_description:
          type: string
          description: Human-readable error description
        message:
          type: string
          description: Error message
      required:
        - error
    Number:
      type: object
      properties:
        number_id:
          type: string
          description: Unique identifier for the phone number
        phone_number:
          type: string
          description: The phone number in E.164 format
        country:
          type: string
          description: Country code or name for the phone number
        status:
          type: string
          description: >-
            Status of the phone number (typically 'active', 'inactive', or
            'pending')
        agent_id:
          type: string
          description: The AI agent ID associated with this number (if any)
        created_at:
          type: string
          format: date-time
          description: ISO 8601 timestamp of when the number was created
        updated_at:
          type: string
          format: date-time
          description: ISO 8601 timestamp of when the number was last updated
      required:
        - number_id
        - phone_number
        - status
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Bearer token authentication. Include the access token in the
        Authorization header as 'Bearer {access_token}'

````