---
title: "Search available numbers"
method: GET
path: "/v1/messaging/phone-numbers/available"
tags: ["Phone Numbers"]
---

# Search available numbers

`GET /v1/messaging/phone-numbers/available`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/messaging/phone-numbers/available`
- Auth: HTTP bearer

Search the provider's inventory for numbers available to purchase in a
country (default US). Optional filters narrow the results. The country
must be offerable (see GET /v1/phone-numbers/countries). Voice
capability is always required; pass `sms=true` to only see numbers that
can also text (SMS support is per-number, not per-country). Numbers a
purchase would refuse are left out, and any result's `phoneNumber` can
be bought exactly by passing it to POST /v1/phone-numbers/purchase.

Works without an API key. Keyless calls get up to 12 results with the
middle digits masked (`maskedNumber`), each with a `claimId` and a
`claimUrl`: a signup link that lands a person on the dashboard's
confirm step with that number picked, so an agent can search for a
user and hand them one link. Keyless calls are rate limited per IP and
results are cached for a few minutes. With an API key you get full
numbers and no claim fields.


**Billing:** Read (free unless it says otherwise) · **Rate limit:** 120/min

## Query parameters

- `sms` boolean: true narrows the pool to SMS-capable numbers. Each result still carries its full `features` list for per-number capability badging.
- `type` string: Alias of numberType, kept for existing callers
- `limit` integer
- `masked` boolean: true returns the keyless shape (masked numbers with claimId and claimUrl) even when you send an API key, e.g. to hand a user a signup link for a number.
- `prefix` string: Alias of areaCode, kept for existing callers
- `country` string: ISO code, or `auto` on the keyless shape to search the caller's own country (from their IP) near their city, falling back to US.
- `areaCode` string: Area code or national dialing code the number must start with, e.g. 415 or 91
- `contains` string: Pattern to match within the number
- `locality` string: A city name, matched against the numbering plan (accents and common aliases allowed) and searched by that city's area codes; a name no city of the plan matches returns no numbers. `areaCode` takes a city name too.
- `numberType` 'local' | 'mobile' | 'national' | 'toll_free': Number type; defaults to the country's WhatsApp-safe type (the same name as on purchase, availability and kyc)

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: Operation result (see each operation). While a Studio render is processing: `stage` (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), `phase` (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), `progress` (a percent, 0–100) and `progress_fraction` (0–1), `eta_seconds` (seconds left, never below 0) and `estimate_seconds`
    - `near` string, nullable: With `country=auto`: the caller's city the results were narrowed to, or null when there was no stock there.
    - `masked` boolean: true on keyless calls.
    - `claimId` string: Keyless calls only: a claim for any number matching this search's country, type and area.
    - `country` string
    - `numbers` object[]
      - `claimId` string: Keyless calls only. Opaque, expires after 7 days. Pass it as `claimId` on a keyless POST /v1/phone-numbers/purchase.
      - `claimUrl` string: Keyless calls only. Signup link that opens the dashboard's confirm step for this number. The number is not held: if it is gone by then, the buyer picks another in the same area.
      - `features` string[]: Provider capability list for this number (e.g. voice, sms, mms).
      - `locality` string: Town or rate center the number belongs to, as the carrier names it (e.g. WACO).
      - `bestEffort` boolean: true when the carrier added this number because too few matched your filters, so it may be outside the requested prefix or locality.
      - `numberType` string: Keyless calls only. Without a `numberType` filter a keyless search mixes every type the country sells, so each result names its own.
      - `phoneNumber` string: E.164. Pass it as `phoneNumber` on POST /v1/phone-numbers/purchase to buy this exact number.
      - `maskedNumber` string: Keyless calls only, in place of `phoneNumber`: the number with its middle digits masked, e.g. +44 20 •••• 0123.
    - `claimUrl` string: Keyless calls only: signup link for any number matching this search.
    - `numberType` string
    - `requireSms` boolean: Echo of the `sms` filter applied to this search.
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)