List DID Groups API Reference

This defines the List DID Groups API:

  • Request - Get list of DID groups.
  • Response - ensure that your request to the Fax API was successful.


A List DID Groups API request looks like:{COUNTRY_CODE}/didgroups?api_key=xxxxx&didGroupIds=12,34,67&stateId=12&cityNamePattern=New York%&areaCode=204

This request contains:


The following table shows the parameters you use in the request:

Parameter Description Required
COUNTRY_CODE Indicates the country code of the DID group in its ISO 3166-1 alpha-3 format (e.g. “GBR” for United Kingdom, “USA” for United States of America, “BEL” for Belgium, etc.). For example, CAN for Canada. Yes.
didGroupIds Can be used if you want information about specific DID groups. Note that you can specify multiple ids by supplying comma separated didGroupIds in the query parameter. For example, didGroupIds=123,1245,456. No.
stateId The numerical identifier for the didGroup's state. Please see the listState operation to retrieve a valid state identifier. For example, stateId=10. No.
cityNamePattern A string pattern for the beginning of city name: "New York%" will return all New York DID groups. On the contrary, "w York%" will return none. For example, cityNamePattern=New York%. No.
areaCode The area code of the DID group. For example, areaCode=204. No.

Authentication information

The following table shows the information for authentication:

Parameter Description Required
api_key Your Key. For example, api_key=f@x2r0ckkz. Yes.

You find your Key in Dashboard.


To ensure privacy, you must use HTTPS for all Faxto API requests.


You submit all requests with a POST or GET call using UTF-8 encoding and URL encoded values.


We support JSON ONLY responses

  "status": "success",
  "data": [
    "did_group_id": 67,
    "area_code": "204",
    "city_name": "WINNIPEG"
    "did_group_id": 13868,
    "area_code": "226",
    "city_name": "WINDSOR"
    "did_group_id": 9581,
    "area_code": "289",
    "city_name": "WOODBRIDGE"
    "did_group_id": 20287,
    "area_code": "306",
    "city_name": "SASKATOON"

Keys and Values

Key Value Response Type
status The status of the API request JSON
data Array containing DID groups JSON

Response Messages

HTTP Status Code Reason
200 Successful response
401 Unauthorized.
403 Rate limit exceeded
404 Resource not Found
500 Internal server error