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/{id}

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

fields[did_groups]

string

No

Sparse fieldsets

Includes#

Value

Description

country

Country Object

region

Region Object

city

City Object

stock_keeping_units

A list of Stock Keeping Unit Objects

address_requirement

Address Requirement Object

Note

In version 2026-11-19, the number type of a DID Group is returned in the number_type attribute. The did_group_type relationship is not available: requesting it with include or in fields[did_groups] returns 400 Bad Request.

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
5Authorization: Bearer [access 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 "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"

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            "number_type": "local",
19            "is_demo": false
20        },
21        "relationships": {
22            "country": {
23                "links": {
24                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/country",
25                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/country"
26                }
27            },
28            "city": {
29                "links": {
30                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/city",
31                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/city"
32                }
33            },
34            "region": {
35                "links": {
36                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/region",
37                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/region"
38                }
39            },
40            "stock_keeping_units": {
41                "links": {
42                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/stock_keeping_units",
43                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/stock_keeping_units"
44                }
45            },
46            "address_requirement": {
47                "links": {
48                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/address_requirement",
49                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/address_requirement"
50                }
51            }
52        },
53        "meta": {
54            "available_dids_enabled": false,
55            "needs_registration": true,
56            "is_available": true,
57            "total_count": 7
58        }
59    },
60    "meta": {
61        "api_version": "2026-11-19"
62    }
63}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized

429

No

The request budget of the account for the current window is spent (too_many_requests). Retry-After gives the number of seconds to wait.