List Available DIDs / Phone Numbers

Retrieve a list of available phone numbers ready for purchase.

Available Number Types

Australia (AU)

  • geographic: National Australian Numbers
  • mobile: Virtual Mobile Numbers
  • special-rate: 1300 Numbers
  • tollfree: 1800 Numbers

New Zealand (NZ)

  • geographic: National New Zealand Numbers

Parameters

  • country: Country code (AU or NZ)
  • state: Optional state/region code
  • city: Optional city name
  • number_type: Type of number to search for (see above)

Returns

A list of available numbers (maximum 10) with details including:

  • DID number
  • Country
  • Number type
  • State (if applicable)
  • City (if applicable)
  • Setup fee
  • Monthly fee
  • Maximum channels

Tips

  • You can use GET /api/phone-numbers/cities/{state} to get a list of available cities
  • Results are limited to 10 numbers per request
  • All fees are in AUD
Query Params
string
Defaults to AU

Country code (AU or NZ)

Australian state code (ACT, NSW, NT, QLD, SA, VIC, WA) or New Zealand region (Nth Is, Sth Is)

City name

Type of number to search for

Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json