---
title: "Search phone numbers"
method: GET
path: "/api/relay/rest/phone_numbers/search"
tags: ["Phone Numbers"]
---

# Search phone numbers

`GET /api/relay/rest/phone_numbers/search`

Searches for available phone numbers to purchase.

#### Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Numbers_.

[Learn more about API scopes](/docs/platform/your-signalwire-api-space).

## Query parameters

- `areacode` string
- `number_type` string
- `starts_with` string
- `contains` string
- `ends_with` string
- `max_results` integer
- `region` string
- `city` string

## Response `200`

The request has succeeded.

- AvailablePhoneNumbersResponse — Response containing available phone numbers for purchase.
  - `links` PaginationLinks — Pagination links for list responses.
    - `self` string, required — Link to the current page.
    - `first` string, required — Link to the first page.
    - `next` string — Link to the next page. Only present when there are more results.
    - `prev` string — Link to the previous page. Only present when not on the first page.
  - `data` AvailablePhoneNumber[] — List of available phone numbers.
    - `number` string, required — The phone number in E.164 format.
    - `region` string — The region of the phone number.
    - `city` string — The city of the phone number.
    - `rate_center` string — The rate center of the phone number.
    - `lata` string — The LATA of the phone number.
    - `capabilities` PhoneNumberCapabilities — Phone number capabilities.
      - `voice` boolean — Whether the phone number can receive voice calls.
      - `sms` boolean — Whether the phone number can send/receive SMS.
      - `mms` boolean — Whether the phone number can send/receive MMS.
      - `fax` boolean — Whether the phone number can send/receive fax.

## Other responses

- `401` — Access is unauthorized.
- `500` — An internal server error occurred.

---

[API](https://skmtc.net/signalwire/apis/signalwire-rest-api.md) · [All operations](https://skmtc.net/signalwire/apis/signalwire-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/signalwire/signalwire-rest-api/revisions/a884f7dcbfc3/schema)