Retrieving Number Groups

Retrieving All Number Groups

Using the GET method, you can retrieve your Groups.

Retrieve All - GET https://api.telmetrics.com/v3/api/groups

The following sample request can be used to retrieve all Groups.

curl -H "x-organization-token: {authorization_token}" \
     -X GET \
     "https://api.telmetrics.com/v3/api/groups"

If the request is handled successfully, the following response will be returned:

{
    "results": [
        {
            "id": 11623258,
            "name": "ABC Company",
            "time_zone_id": "Hawaii",
            "rich_data_type": "basic",
            "dni_type": "None",
            "billing_group_id": 4062,
            "status": "active",
            "created_datetime": "2018-04-06T16:03:01.947"
        },
        {
            "id": 11623246,
            "name": "123 Company",
            "time_zone_id": "Eastern",
            "rich_data_type": "rich",
            "dni_type": "None",
            "billing_group_id": 4062,
            "tracking_javascript": "<script type=\"text/javascript\" src=\"#{dni-api-url}/sdk?identifier=83c91966-9bba-43e2-8da1-78067d9ab793\" async></script>",
            "status": "active",
            "created_datetime": "2018-04-06T11:28:33.523",
            "modified_datetime": "2018-04-06T11:30:58.093"
        }
      ...
     ]
}

Retrieving a Single Number Group

Using the GET method, you can retrieve an individual Group.

Retrieve Individual - GET https://api.telmetrics.com/v3/api/groups/{groupid}

The following sample request can be used to retrieve a single Group:

curl -H "x-organization-token: {authorization_token}" \
     -X GET \
     "https://api.telmetrics.com/v3/api/groups/11623258"

If the request is handled successfully, the following response will be returned:

{
    "id": 11623258,
    "name": "ABC Company",
    "time_zone_id": "Eastern",
    "rich_data_type": "basic",
    "dni_type": "None",
    "billing_group_id": 4062,
    "status": "active",
    "created_datetime": "2018-04-06T16:03:01.947"
}