Get DID Groups

This request returns a list of DID groups.

get	/phonenumber/did_groups

Sample

A sample GET request to get DID groups matching the criteria in the request URL:

curl -X GET \
'https://api.carrierx.com/core/v2/phonenumber/did_groups?limit=1' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a list of DID Group objects:

{
    "count": 1,
    "has_more": true,
    "items": [
        {
            "callback_url": null,
            "did_group_sid": "41e21049-e5eb-433c-a93d-d57417b1863c",
            "name": "N/A",
            "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f"
        }
    ],
    "limit": 1,
    "offset": 0,
    "pagination": {
        "next": "https://api.carrierx.com/core/v2/phonenumber/did_groups?limit=1&offset=1"
    },
    "total": 2
}

Required Scopes

This request is enabled for Pagination, Result Filtering, and Field Filtering.

To get information about DID Group objects, the partner must have one of the following scopes enabled:

• phonenumber.manage
• phonenumber.read

Query Arguments

Parameter	Data Type	Description
with_related	boolean	Determines if the partner information related to the DID group should be shown. Values accepted in this field are true and false. The default value is false.