Skip to main content
POST
https://mtxbiyilvgwhbdptysex.supabase.co/functions/v1
/
search-phone-numbers
curl -X POST https://mtxbiyilvgwhbdptysex.supabase.co/functions/v1/search-phone-numbers \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "area_code": "604",
    "country": "CA",
    "limit": 5
  }'
{
  "numbers": [
    {
      "phone_number": "+16045551234",
      "friendly_name": "(604) 555-1234",
      "locality": "Vancouver",
      "region": "BC",
      "capabilities": {
        "voice": true,
        "sms": true,
        "mms": true
      },
      "monthly_cost": 2.00
    },
    {
      "phone_number": "+16045555678",
      "friendly_name": "(604) 555-5678",
      "locality": "Vancouver",
      "region": "BC",
      "capabilities": {
        "voice": true,
        "sms": true,
        "mms": true
      },
      "monthly_cost": 2.00
    }
  ]
}
Search for available phone numbers to add to your account. Filter by area code, country, number type, and pattern matching.

Request Body

area_code
string
3-digit area code to search in.Example: 604
contains
string
Pattern the number should contain. Useful for vanity numbers.Example: 555 or CAFE
country
string
default:"US"
Country code. Currently supports US (United States) and CA (Canada).
type
string
default:"local"
Number type: local or toll_free.
limit
integer
default:10
Maximum numbers to return. Max: 50.

Response

numbers
array
Array of available phone numbers with details.

Number Object

phone_number
string
The phone number in E.164 format.
friendly_name
string
Human-readable formatted number.
locality
string
City or region for local numbers.
region
string
State or province code.
capabilities
object
What the number supports: voice, sms, mms.
monthly_cost
number
Monthly cost in USD.
curl -X POST https://mtxbiyilvgwhbdptysex.supabase.co/functions/v1/search-phone-numbers \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "area_code": "604",
    "country": "CA",
    "limit": 5
  }'
{
  "numbers": [
    {
      "phone_number": "+16045551234",
      "friendly_name": "(604) 555-1234",
      "locality": "Vancouver",
      "region": "BC",
      "capabilities": {
        "voice": true,
        "sms": true,
        "mms": true
      },
      "monthly_cost": 2.00
    },
    {
      "phone_number": "+16045555678",
      "friendly_name": "(604) 555-5678",
      "locality": "Vancouver",
      "region": "BC",
      "capabilities": {
        "voice": true,
        "sms": true,
        "mms": true
      },
      "monthly_cost": 2.00
    }
  ]
}