Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.

Query Parameters

country
enum<string>
default:US

ISO country to search in. We offer US and Canadian numbers only (both NANPA +1). Defaults to US. Any other value is rejected. Note SMS/10DLC is available on US numbers only — Canadian numbers are for voice.

Available options:
US,
CA
areaCode
string

National destination code (area code).

contains
string

The number must contain this digit substring (vanity).

startsWith
string

The number (after country code) starts with these digits.

endsWith
string

The number ends with these digits — last-four / vanity suffix.

numberType
enum<string>

Local vs toll-free (and national/mobile where supported).

Available options:
local,
toll_free,
national,
mobile
locality
string

City to browse within.

administrativeArea
string

Two-letter state/province to browse within.

features
enum<string>[]

Required capabilities (repeatable or comma-separated).

Available options:
voice,
sms,
mms,
fax,
emergency
bestEffort
boolean
default:true

Widen a too-narrow filter to nearby matches (default true).

limit
integer
default:20

Result page size (provider load-more, not DB offset paging).

Required range: 1 <= x <= 50

Response

Available numbers.

success
boolean
required
data
object[]
required
message
string
errors
object[]