Get DID Group#

Returns a single DID Group. DID Groups are phone numbers that share a common city or area code.

Request#

HTTP Method: GET

URI Path: /v3/did_groups/

Note

For all returned data attributes, see Did Group Object.

URI Query Parameters#

Name

Type

Is Required?

Description

id

string

Yes

Unique ID number of a DID Group.

include

string

No

Inclusion

Includes#

Value

Description

country

Country Object

region

Region Object

city

City Object

did_group_type

DID Group Type Object

stock_keeping_units

A list of Stock Keeping Unit Objects

address_requirement

Address Requirement Object

Example#

http

1GET /v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1 HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API Token]

curl

1curl -i -X GET https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1 -H "Accept: application/vnd.api+json" -H "Api-Key: [API Token]" -H "Content-Type: application/vnd.api+json"

response

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5    "data": {
 6        "id": "2187c36d-28fb-436f-8861-5a0f5b5a3ee1",
 7        "type": "did_groups",
 8        "attributes": {
 9            "prefix": "241",
10            "features": [
11                "voice_in",
12                "cnam_out"
13            ],
14            "is_metered": false,
15            "area_name": "Aachen",
16            "allow_additional_channels": true,
17            "service_restrictions": "Restriction Message A"
18        },
19        "relationships": {
20            "country": {
21                "links": {
22                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/country",
23                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/country"
24                }
25            },
26            "city": {
27                "links": {
28                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/city",
29                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/city"
30                }
31            },
32            "did_group_type": {
33                "links": {
34                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/did_group_type",
35                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/did_group_type"
36                }
37            },
38            "region": {
39                "links": {
40                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/region",
41                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/region"
42                }
43            },
44            "stock_keeping_units": {
45                "links": {
46                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/stock_keeping_units",
47                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/stock_keeping_units"
48                }
49            },
50            "address_requirement": {
51                "links": {
52                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/address_requirement",
53                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/address_requirement"
54                }
55            }
56        },
57        "meta": {
58            "available_dids_enabled": false,
59            "needs_registration": true,
60            "is_available": true,
61            "total_count": 7
62        }
63    },
64    "meta": {
65        "api_version": "2026-04-16"
66    }
67}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized