Numbers & Inventory
List NANP regions
Retrieve a list of states or provinces within a country (e.g., US states, Canadian provinces).
Important notes:
- Only applicable for countries with has_provinces_or_states: true
- Returns 404 for countries without regional divisions
- A state's numbers are listed by numbers_search_show with the state's region_id
When to use:
- Building state/province selection for US, Canada, etc.
- Filtering DID search by region
regions[].id feeds numbers_search_show (region_id). regions[].name feeds numbers_search_show (state_name_contains, United States only).
get/api/v2/numbers/countries/{country_id}/regions
Request
- Base URL: https://app.didlogic.com
- URL: https://app.didlogic.com/api/v2/numbers/countries/{country_id}/regions
- Auth: HTTP bearer
Path parameters
country_idinteger required
Country id from numbers_countries_index
Response
returns list of regions
Example response
{
"regions": [
{
"id": 31,
"name": "New York",
"short_name": "NY"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.