Search Available Numbers

GEThttps://api.trillet.ai/v1/api/twilio/available-numbers

Headers

x-api-keystringrequired

API key used for authenticating requests to the API.

x-workspace-idstringrequired

Workspace identifier for the API.

Query Parameters

countrystringrequired

Country code to search for numbers (e.g., "US", "CA", "AU", "GB").

typestringrequired

Type of phone number. Options: "local", "tollFree", "mobile". Not required for AU.

containsstring

Search for numbers containing specific digits or patterns.

limitnumber

Maximum number of results to return.

Response Fields

numbersarray

Array of available phone numbers.

phoneNumberstring

The phone number in E.164 format.

friendlyNamestring

A human-readable formatted version of the number.

localitystring

City or locality associated with the number.

regionstring

State or region associated with the number.

filtersobject

Available filter options for the country.

supportedarray

List of supported filter types for the selected country.

{
  "numbers": [
    {
      "phoneNumber": "+14155551234",
      "friendlyName": "(415) 555-1234",
      "locality": "San Francisco",
      "region": "CA"
    },
    {
      "phoneNumber": "+14155555678",
      "friendlyName": "(415) 555-5678",
      "locality": "San Francisco",
      "region": "CA"
    }
  ],
  "filters": {
    "supported": ["contains", "areaCode"]
  }
}