# Get DID Groups Returns a list of DID Groups, which is essentially a list of the current DIDWW coverage. 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](did-group-object.html). ### URI Query Parameters | Name | Type | Is Required? | Description | | --- | --- | --- | --- | | include | `string` | No | [Inclusion](../../../specification/includes.html#api-includes) | | filter[] | `string`, `boolean`, `Integer` | No | [Filtering](../../../specification/filtering.html#api-filters) | | fields[did\_groups] | `string` | No | [Sparse fieldsets](../../../specification/sparse-fieldsets.html#api-sparse-fieldsets) | | sort | `string` | No | [Sorting](../../../specification/sorting.html#api-sorting) | ### Includes | Value | Description | | --- | --- | | country | [Country Object](../countries/country-object.html#country-object-v34) | | region | [Region Object](../regions/region-object.html#region-object-v34) | | city | [City Object](../city/city-object.html#city-object-v34) | | did\_group\_type | [DID Group Type Object](../did-group-type/did-group-type-object.html#did-group-type-object-v34) | | stock\_keeping\_units | A list of [Stock Keeping Unit Objects](../../common-definitions/index.html#stock-keeping-unit-object-v34) | | address\_requirement | [Address Requirement Object](../../regulation-resources/requirements/address-requirement-object.html#address-requirement-object-v34) | ### Filters | Filter Name | Type | Allow Blank | Allow Array | Filters by: | | --- | --- | --- | --- | --- | | id | `string` | No | Yes | Group `id` field. | | prefix | `string` | Yes | Yes | The group `prefix` field. | | nanpa\_prefix.id | `string` | Yes | Yes | The nanpa prefix `id` field. | | nanpa\_prefix.npanxx | `string` | Yes | Yes | The nanpa prefix `npa` / `nxx` fields. | | area\_name | `string` | Yes | Yes | The `area_name` field (for example London). Case insensitive. | | is\_metered | `boolean` | No | No | The `is_metered` field. | | allow\_additional\_channels | `boolean` | No | No | The `allow_additional_channels` field. | | available\_dids\_enabled | `boolean` | No | No | The `available_dids_enabled` field. | | features | `string` | No | Yes | The `features` field. Can be one or several of `voice_in`, `voice_out`, `t38`, `sms_in`, `p2p`, `a2p`, `emergency`, and `cnam_out`. Example: `voice_in,emergency`. | | needs\_registration | `boolean` | No | No | The `needs_registration` field. | | is\_available | `boolean` | No | No | The `is_available` field. | | country.id | `string` | Yes | Yes | The `country.id` field. | | region.id | `string` | Yes | Yes | The `region.id` field. | | city.id | `string` | Yes | Yes | The `city.id` field. | | did\_group\_type.id | `string` | Yes | Yes | The `did_group_type.id` field. | | meta.total\_count\_gteq | `Integer` | Yes | No | A filter on the list based on the `meta.total_count_gteq` field, where `gteq` stands for greater-equal. | ### Sorting | Value | Sorts by: | | --- | --- | | country.name | The `country.name` field. | | did\_group\_type.name | The `did_group_type.name` field. | | prefix | City `prefix` field. | | is\_metered | The `is_metered` field. | | area\_name | The `area_name` field. | | allow\_additional\_channels | The `allow_additional_channels` field. | ## Examples Simple requestFilter by country.id, did\_group\_type.id - Include sku\_idFilter by city.id, prefix - Include sku\_idFilter by nanpa\_prefix.idFilter by nanpa\_prefix.npanxx [[DIDWW-API-EXAMPLE-START]] http ``` GET /v3/did_groups 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 -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": "ac160b14-e670-490f-b158-d3ba552c623f", "type": "did_groups", "attributes": { "prefix": "241", "features": [ "voice_in", "voice_out", "t38" ], "is_metered": false, "area_name": "Aachen", "allow_additional_channels": true, "service_restrictions": null }, "relationships": { "country": { "links": { "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/country", "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/country" } }, "city": { "links": { "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/city", "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/city" } }, "did_group_type": { "links": { "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/did_group_type", "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/did_group_type" } }, "region": { "links": { "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/region", "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/region" } }, "stock_keeping_units": { "links": { "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/stock_keeping_units", "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/stock_keeping_units" } }, "address_requirement": { "links": { "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/address_requirement", "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/address_requirement" } } }, "meta": { "available_dids_enabled": false, "needs_registration": true, "is_available": true, "total_count": 21 } }], "meta": { "total_records": 1, "api_version": "2026-04-16" }, "links": { "first": "https://api.didww.com/v3/did_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50", "last": "https://api.didww.com/v3/did_groups?page%5Bnumber%5D=32&page%5Bsize%5D=50" } } ``` [[DIDWW-API-EXAMPLE-END]] [[DIDWW-API-EXAMPLE-START]] http ``` GET /v3/did_groups?filter%5Bcountry.id%5D=c8647639-fc9c-47b2-acec-7c9e14465c25&filter%5Bdid_group_type.id%5D=0d51924c-e863-44ff-be59-10547c138955&include=stock_keeping_units 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?filter%5Bcountry.id%5D=c8647639-fc9c-47b2-acec-7c9e14465c25&filter%5Bdid_group_type.id%5D=0d51924c-e863-44ff-be59-10547c138955&include=stock_keeping_units' -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": "1d5aad75-b853-4125-9a1a-da3fedfc5674", "type": "did_groups", "attributes": { "prefix": "7", "features": [ "voice_in", "voice_out", "sms_in", "p2p", "a2p", "cnam_out", "emergency" ], "is_metered": false, "area_name": "Mobile", "allow_additional_channels": true, "service_restrictions": null }, "relationships": { "country": { "links": { "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/country", "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/country" } }, "city": { "links": { "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/city", "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/city" } }, "did_group_type": { "links": { "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/did_group_type", "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/did_group_type" } }, "region": { "links": { "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/region", "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/region" } }, "stock_keeping_units": { "links": { "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/stock_keeping_units", "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/stock_keeping_units" }, "data": [{ "type": "stock_keeping_units", "id": "cb17c069-098e-4be1-a7eb-eb4529e8c5f5" }, { "type": "stock_keeping_units", "id": "e194165e-eda7-4718-9bbe-c5c583bd189a" } ] }, "address_requirement": { "links": { "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/address_requirement", "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/address_requirement" } } }, "meta": { "available_dids_enabled": true, "needs_registration": false, "is_available": true, "total_count": 99 } }], "included": [{ "id": "cb17c069-098e-4be1-a7eb-eb4529e8c5f5", "type": "stock_keeping_units", "attributes": { "setup_price": "0.0", "monthly_price": "0.3", "channels_included_count": 0 } }, { "id": "e194165e-eda7-4718-9bbe-c5c583bd189a", "type": "stock_keeping_units", "attributes": { "setup_price": "0.0", "monthly_price": "0.8", "channels_included_count": 2 } } ], "meta": { "total_records": 1, "api_version": "2026-04-16" }, "links": { "first": "https://api.didww.com/v3/did_groups?filter%5Bcountry.id%5D=c8647639-fc9c-47b2-acec-7c9e14465c25&filter%5Bdid_group_type.id%5D=0d51924c-e863-44ff-be59-10547c138955&include=stock_keeping_units&page%5Bnumber%5D=1&page%5Bsize%5D=50", "last": "https://api.didww.com/v3/did_groups?filter%5Bcountry.id%5D=c8647639-fc9c-47b2-acec-7c9e14465c25&filter%5Bdid_group_type.id%5D=0d51924c-e863-44ff-be59-10547c138955&include=stock_keeping_units&page%5Bnumber%5D=1&page%5Bsize%5D=50" } } ``` [[DIDWW-API-EXAMPLE-END]] [[DIDWW-API-EXAMPLE-START]] http ``` GET /v3/did_groups?filter%5Bcity.id%5D=e696dec7-9c65-4e99-aab7-55a1f98154f0&include=stock_keeping_units&filter%5Bprefix%5D=20 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?filter%5Bcity.id%5D=e696dec7-9c65-4e99-aab7-55a1f98154f0&include=stock_keeping_units&filter%5Bprefix%5D=20' -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": "fc271bcc-1f9c-4c19-8174-28b7c55a208a", "type": "did_groups", "attributes": { "prefix": "20", "features": [ "voice_in", "voice_out", "t38" ], "is_metered": false, "area_name": "London", "allow_additional_channels": true, "service_restrictions": null }, "relationships": { "country": { "links": { "self": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/country", "related": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/country" } }, "city": { "links": { "self": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/city", "related": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/city" } }, "did_group_type": { "links": { "self": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/did_group_type", "related": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/did_group_type" } }, "region": { "links": { "self": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/region", "related": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/region" } }, "stock_keeping_units": { "links": { "self": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/stock_keeping_units", "related": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/stock_keeping_units" }, "data": [{ "type": "stock_keeping_units", "id": "0ba87a94-7143-48cb-a0f6-d50a6a0c8cfa" }, { "type": "stock_keeping_units", "id": "1a86de53-3131-491f-9e4b-3392da45d441" } ] } }, "meta": { "available_dids_enabled": true, "needs_registration": false, "is_available": true, "total_count": 932 } }], "included": [{ "id": "0ba87a94-7143-48cb-a0f6-d50a6a0c8cfa", "type": "stock_keeping_units", "attributes": { "setup_price": "0.0", "monthly_price": "0.3", "channels_included_count": 0 } }, { "id": "1a86de53-3131-491f-9e4b-3392da45d441", "type": "stock_keeping_units", "attributes": { "setup_price": "0.0", "monthly_price": "0.8", "channels_included_count": 2 } } ], "meta": { "total_records": 1, "api_version": "2021-12-15" }, "links": { "first": "https://api.didww.com/v3/did_groups?filter%5Bcity.id%5D=e696dec7-9c65-4e99-aab7-55a1f98154f0&filter%5Bprefix%5D=20&include=stock_keeping_units&page%5Bnumber%5D=1&page%5Bsize%5D=50", "last": "https://api.didww.com/v3/did_groups?filter%5Bcity.id%5D=e696dec7-9c65-4e99-aab7-55a1f98154f0&filter%5Bprefix%5D=20&include=stock_keeping_units&page%5Bnumber%5D=1&page%5Bsize%5D=50" } } ``` [[DIDWW-API-EXAMPLE-END]] [[DIDWW-API-EXAMPLE-START]] http ``` GET /v3/did_groups?filter%5Bnanpa_prefix.id%5D=1d968dcf-8ee7-40fa-8073-cdbc027bc3b3 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?filter%5Bnanpa_prefix.id%5D=1d968dcf-8ee7-40fa-8073-cdbc027bc3b3' -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": "b59a0277-9d74-4417-b477-192794496928", "type": "did_groups", "attributes": { "prefix": "201", "features": [ "voice_in" ], "is_metered": false, "area_name": "Hackensack", "allow_additional_channels": true }, "relationships": { "country": { "links": { "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/country", "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/country" } }, "city": { "links": { "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/city", "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/city" } }, "did_group_type": { "links": { "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/did_group_type", "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/did_group_type" } }, "region": { "links": { "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/region", "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/region" } }, "stock_keeping_units": { "links": { "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/stock_keeping_units", "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/stock_keeping_units" } }, "address_requirement": { "links": { "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/address_requirement", "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/address_requirement" } } }, "meta": { "available_dids_enabled": true, "needs_registration": false, "is_available": true, "total_count": 3 } } ], "meta": { "total_records": 1, "api_version": "2026-04-16" }, "links": { "first": "https://api.didww.com/v3/did_groups?filter%5Bnanpa_prefix.id%5D=1d968dcf-8ee7-40fa-8073-cdbc027bc3b3&page%5Bnumber%5D=1&page%5Bsize%5D=50", "last": "https://api.didww.com/v3/did_groups?filter%5Bnanpa_prefix.id%5D=1d968dcf-8ee7-40fa-8073-cdbc027bc3b3&page%5Bnumber%5D=1&page%5Bsize%5D=50" } } ``` [[DIDWW-API-EXAMPLE-END]] [[DIDWW-API-EXAMPLE-START]] http ``` GET /v3/did_groups?filter%5Bnanpa_prefix.npanxx%5D=201221 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?filter%5Bnanpa_prefix.npanxx%5D=201221' -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": "b59a0277-9d74-4417-b477-192794496928", "type": "did_groups", "attributes": { "prefix": "201", "features": [ "voice_in" ], "is_metered": false, "area_name": "Hackensack", "allow_additional_channels": true }, "relationships": { "country": { "links": { "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/country", "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/country" } }, "city": { "links": { "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/city", "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/city" } }, "did_group_type": { "links": { "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/did_group_type", "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/did_group_type" } }, "region": { "links": { "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/region", "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/region" } }, "stock_keeping_units": { "links": { "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/stock_keeping_units", "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/stock_keeping_units" } }, "address_requirement": { "links": { "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/address_requirement", "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/address_requirement" } } }, "meta": { "available_dids_enabled": true, "needs_registration": false, "is_available": true, "total_count": 3 } } ], "meta": { "total_records": 1, "api_version": "2026-04-16" }, "links": { "first": "https://api.didww.com/v3/did_groups?filter%5Bnanpa_prefix.npanxx%5D=201221&page%5Bnumber%5D=1&page%5Bsize%5D=50", "last": "https://api.didww.com/v3/did_groups?filter%5Bnanpa_prefix.npanxx%5D=201221&page%5Bnumber%5D=1&page%5Bsize%5D=50" } } ``` [[DIDWW-API-EXAMPLE-END]] ## Other Responses | Code | Success | Description | | --- | --- | --- | | 401 | No | [Unauthorized](../../../configuration.html#api-key) | On this page