Get DID Group by SID

This request returns data for a DID group, targeted by secure ID.

get	/phonenumber/did_group/{did_group_sid}

Sample

A sample GET request to get a DID Group, targeted by secure ID:

curl -X GET \
'https://api.carrierx.com/core/v2/phonenumber/did_groups/41e21049-e5eb-433c-a93d-d57417b1863c' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a serialized copy of the DID Group object:

{
    "callback_url": null,
    "did_group_sid": "41e21049-e5eb-433c-a93d-d57417b1863c",
    "name": "N/A",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f"
}

This request is enabled for Field Filtering.

Required Scopes

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

• phonenumber.manage
• phonenumber.read

Path Arguments

Parameter	Data Type	Description
did_group_sid required	string	The secure ID of the DID group.

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.