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

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

curl

curl -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

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": {
        "id": "2187c36d-28fb-436f-8861-5a0f5b5a3ee1",
        "type": "did_groups",
        "attributes": {
            "prefix": "241",
            "features": [
                "voice_in",
                "cnam_out"
            ],
            "is_metered": false,
            "area_name": "Aachen",
            "allow_additional_channels": true,
            "service_restrictions": "Restriction Message A"
        },
        "relationships": {
            "country": {
                "links": {
                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/country",
                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/country"
                }
            },
            "city": {
                "links": {
                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/city",
                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/city"
                }
            },
            "did_group_type": {
                "links": {
                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/did_group_type",
                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/did_group_type"
                }
            },
            "region": {
                "links": {
                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/region",
                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/region"
                }
            },
            "stock_keeping_units": {
                "links": {
                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/stock_keeping_units",
                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/stock_keeping_units"
                }
            },
            "address_requirement": {
                "links": {
                    "self": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/relationships/address_requirement",
                    "related": "https://api.didww.com/v3/did_groups/2187c36d-28fb-436f-8861-5a0f5b5a3ee1/address_requirement"
                }
            }
        },
        "meta": {
            "available_dids_enabled": false,
            "needs_registration": true,
            "is_available": true,
            "total_count": 7
        }
    },
    "meta": {
        "api_version": "2026-04-16"
    }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized