Phone Numbers

Search available Canadian phone numbers to provision

Optionally filtered by area_codes: up to 25 distinct codes (repeats count once), each an active Canadian area code (GET /v1/phone-numbers/area-codes) or a toll-free prefix (833, 844, 855, 866, 877, 888). Toll-free prefixes are accepted although the area-code list does not include them: they are sold at the toll-free tier, and searching by prefix is how to find one. 1-800 numbers are not offered yet, so 800 is refused like an unknown code. More than 25 codes returns 422 TOO_MANY_AREA_CODES; any other code returns 422 VALIDATION_ERROR naming it in details.area_codes. Each account may search 30 times a minute; beyond that, 429 RATE_LIMITED with Retry-After.

Requires phone_numbers:r.

get/v1/phone-numbers/search

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/phone-numbers/search
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Query parameters

area_codesstring

Comma-separated area codes to filter by (e.g. 416,647): at most 25, each an active Canadian area code or a toll-free prefix (833, 844, 855, 866, 877, 888)

limitinteger

Response

Available numbers. A bare array, not wrapped in data.

phone_numberstring required

E.164

country_codestring required
area_codestring nullable required
regionstring nullable required

Province or territory, when the area code maps to one.

capabilitiesstring[] required
monthly_cost_centsinteger required

Recurring rent in CAD cents, at the tier (local or toll-free) this number would be sold at.

upfront_cost_centsinteger required

The first month's rent, charged when the number is provisioned.

activation_fee_centsinteger required

One-time activation fee charged with the first month. Not refunded on release.

currency'CAD' required

Changes

No recorded changes to this operation across all 1 revision of this API.