---
title: "List Phone Numbers"
method: POST
path: "/phone-numbers/list"
tags: ["phoneNumbers"]
---

# List Phone Numbers

`POST /phone-numbers/list`

## Request

- Base URL: `https://api.pinnacle.sh`
- URL: `https://api.pinnacle.sh/phone-numbers/list`
- Auth: API key in header `PINNACLE-API-KEY`

List all owned phone numbers with pagination. Results are sorted by creation date, newest first.

## Request body

- ListPhoneNumbersRequest
  - `pageIndex` integer
  - `pageSize` integer

## Response `200`

Returns paginated list of owned phone numbers.

- ListPhoneNumbersResponse
  - `data` OwnedPhoneNumber[], required
    - `number` string, required: Phone number in E.164 format.
    - `sms` boolean, required: Whether SMS messaging is enabled.
    - `mms` boolean, required: Whether MMS messaging is enabled.
    - `voice` boolean, required: Whether voice calling is enabled.
    - `isSandbox` boolean, required: Whether this is a sandbox phone number.
    - `createdAt` string, required: ISO 8601 timestamp of when the phone number was added.
  - `hasMore` boolean, required
  - `count` integer, required

## Other responses

- `400`: Validation failed. The payload has missing required fields and/or invalid types. <br> See https://zod.dev/error-formatting for more information.
- `401`: The request lacks valid authentication credentials or the provided credentials are invalid. <br> Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.
- `500`: An unexpected error occurred on Pinnacle's servers while processing your request. <br> If this error persists, please contact support with the request details.

---

[API](https://skmtc.dev/pinnacle/apis/pinnacle-2.md) - [All operations](https://skmtc.dev/pinnacle/apis/pinnacle-2/llms.txt) - [OpenAPI document](https://skmtc.dev/pinnacle/apis/pinnacle-2/revisions/45416dadab79?raw)