Docs
Numbersv4

Search available numbers

GET/numbers/available

US local numbers you can buy that support every product in products. Results are live inventory: a number can be taken between the search and the purchase. OAuth apps need numbers:read.

Headers

AuthorizationRequiredstring

Your API key, sent as a bearer token: Authorization: Bearer <api_key>. Editing this stays in sync with the API key box on the right.

Bearer

Query parameters

productsRequiredstring

Comma-separated sms, voice.

area_codeoptionalstring

Three-digit US area code.

regionoptionalstring

Two-letter US state code.

localityoptionalstring

City.

containsoptionalstring

Digits the number contains.

limitoptionalinteger

Maximum numbers to return.

Returns

dataoptionalAvailableNumber[]

Array of AvailableNumber

numberRequiredstring

The number in E.164 format.

productsRequiredTelecomProduct[]

Products the number supports.

localityRequiredstring | null

Rate center (city) the number belongs to.

regionRequiredstring | null

Two-letter US state code.

has_moreoptionalboolean
next_cursoroptionalstring | null

Response codes

200Available numbers; `has_more` is always false
400`products_required`, `invalid_products`, `invalid_area_code`, `invalid_region`, or `invalid_contains`.
401Your API key is missing or invalid. Pass it as a bearer token.
403`feature_not_enabled`: Blooio SMS and Blooio Voice aren't enabled on this organization.
422`invalid_search`: the carrier refused the search.
502`upstream_unavailable`: the carrier network couldn't be reached. Retry with backoff.

Sends a live request with your values and shows the real response below. Your key is stored only in this browser.

Request
curl -X GET https://api.blooio.com/v4/numbers/available?products=sms%2Cvoice&area_code=string&region=string&locality=string&contains=string&limit=20 \
Response objectexample
{  "data": [    {      "number": "+15551234567",      "products": [        "sms"      ],      "locality": "string",      "region": "string"    }  ],  "has_more": true,  "next_cursor": "string"}