Search Available Numbers

Search for available phone numbers in a specific country.

GET /v1/api/twilio/available-numbers

Search Available Numbers

cURL

curl --request GET \
  --url https://api.trillet.ai/v1/api/twilio/available-numbers \
  --header 'x-api-key: <api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'

{
  "numbers": [
    {
      "phoneNumber": "[phone]",
      "friendlyName": "[phone]",
      "locality": "San Francisco",
      "region": "CA"
    },
    {
      "phoneNumber": "[phone]",
      "friendlyName": "[phone]",
      "locality": "San Francisco",
      "region": "CA"
    }
  ],
  "filters": {
    "supported": ["contains", "areaCode"]
  }
}

Headers

x-api-key · string · required

API key used for authenticating requests to the API.

x-workspace-id · string · required

Workspace identifier for the API.

Query Parameters

country · string · required

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

type · string · required

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

contains · string

Search for numbers containing specific digits or patterns.

limit · number

Maximum number of results to return.

Response Fields

numbers · array

Array of available phone numbers.

phoneNumber · string

The phone number in E.164 format.

friendlyName · string

A human-readable formatted version of the number.

locality · string

City or locality associated with the number.

region · string

State or region associated with the number.

filters · object

Available filter options for the country.

supported · array

List of supported filter types for the selected country.

{
  "numbers": [
    {
      "phoneNumber": "[phone]",
      "friendlyName": "[phone]",
      "locality": "San Francisco",
      "region": "CA"
    },
    {
      "phoneNumber": "[phone]",
      "friendlyName": "[phone]",
      "locality": "San Francisco",
      "region": "CA"
    }
  ],
  "filters": {
    "supported": ["contains", "areaCode"]
  }
}