---
title: "Search Available Numbers"
method: GET
path: "/setup/numbers/available"
tags: ["setup"]
---

# Search Available Numbers

`GET /setup/numbers/available`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/setup/numbers/available`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

## Query parameters

- `area_code` string, required
- `approval_gated` boolean

## Headers

- `organization-id` string, nullable
- `x-user-id` string, nullable
- `timezone` string
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- NumberInventoryPublic
  - `provider` 'twilio' | 'telnyx', required
  - `area_code` string, required
  - `numbers` AvailablePhoneNumberPublic[], required
    - `phone_number` string, required
    - `number_type` 'toll_free' | 'local', required
    - `locality` string, nullable
    - `region` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/upsmith/apis/upsmith-api.md) - [All operations](https://skmtc.dev/upsmith/apis/upsmith-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upsmith/apis/upsmith-api/revisions/cce8b07a5787?raw)