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

# List Phone Numbers

List all phone numbers configured for your organization.

### Headers

<ParamField header="X-API-Key" type="string" required>
  Your API key for authentication.
</ParamField>

<ParamField header="X-Organization-Id" type="string" required>
  The organization ID.
</ParamField>

### Query Parameters

<ParamField query="status" type="string">
  Filter by status: `free` or `assigned`.
</ParamField>

### Permissions

* `phone_numbers:read` (all roles)

### Response

<ResponseField name="success" type="boolean">
  Indicates if the request was successful.
</ResponseField>

<ResponseField name="data" type="array">
  List of phone number summary objects.
</ResponseField>

<ResponseField name="pagination" type="object">
  Pagination metadata.

  <Expandable title="properties">
    <ResponseField name="next_cursor" type="string">
      Cursor for the next page (null if no more pages).
    </ResponseField>

    <ResponseField name="has_more" type="boolean">
      Whether more results exist after this page.
    </ResponseField>

    <ResponseField name="page_size" type="integer">
      Number of items in this page.
    </ResponseField>

    <ResponseField name="total_count" type="integer">
      Total number of items.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json Response theme={null}
  {
    "success": true,
    "data": [
      {
        "phone_number_id": "phon_a1b2c3d4e5f6",
        "phone_number": "+15551234567",
        "provider": "twilio",
        "status": "assigned",
        "supports_inbound": true,
        "supports_outbound": true,
        "assigned_agent_id": "agent_b2c3d4e5f6a7",
        "created_at": "2024-01-15T10:30:00Z"
      },
      {
        "phone_number_id": "phon_b2c3d4e5f6a7",
        "phone_number": "+15559876543",
        "provider": "sip",
        "status": "free",
        "supports_inbound": true,
        "supports_outbound": true,
        "assigned_agent_id": null,
        "created_at": "2024-01-10T09:00:00Z"
      }
    ],
    "pagination": {
      "next_cursor": null,
      "has_more": false,
      "page_size": 2,
      "total_count": 2
    }
  }
  ```
</ResponseExample>