# 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[<filter\_name>] | `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) |
| page[number] | `integer` | No | [Page number](../../../specification/pagination.html#api-pagination). |
| page[size] | `integer` | No | [Page size](../../../specification/pagination.html#api-pagination). Pagination defaults to `50` records per page. The maximum is `100`. |

### Includes

| Value | Description |
| --- | --- |
| country | [Country Object](../countries/country-object.html#country-object-v35) |
| region | [Region Object](../regions/region-object.html#region-object-v35) |
| city | [City Object](../city/city-object.html#city-object-v35) |
| stock\_keeping\_units | A list of [Stock Keeping Unit Objects](../../common-definitions/index.html#stock-keeping-unit-object-v35) |
| address\_requirement | [Address Requirement Object](../../regulation-resources/requirements/address-requirement-object.html#address-requirement-object-v35) |

### 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` | No | No | The nanpa prefix `id` field. |
| nanpa\_prefix.npanxx | `string` | No | No | The nanpa prefix `npa` / `nxx` fields. Takes exactly one six-digit NPA-NXX value (for example `201221`). |
| 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. |
| number\_type | `string` | No | Yes | The `number_type` field. Can be one or several of `local`, `national`, `mobile`, `toll_free`, `shared_cost`, and `global`. A DID Group matches when its number type is any of the listed values. Example: `local,mobile`. |
| is\_demo | `boolean` | No | No | The `is_demo` 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. |
| number\_type | The `number_type` 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. |
| is\_demo | The `is_demo` field. |
| service\_restrictions | The `service_restrictions` field. |

Note

In version `2026-11-19`, the number type of a DID Group is returned in the `number_type` attribute. The `did_group_type`
include, the `did_group_type.id` filter, the `did_group_type.name` sort, and `did_group_type` in `fields[did_groups]`
are not accepted and return `400 Bad Request`. A `number_type` filter value outside the listed values also returns `400
Bad Request`.

## Examples

Simple requestFilter by country.id, number\_type - Include sku\_idFilter by city.id, prefix - Include sku\_idFilter by
nanpa\_prefix.idFilter by nanpa\_prefix.npanxxFilter by id - With service restrictions

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/did_groups 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 -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": "ac160b14-e670-490f-b158-d3ba552c623f",
 7        "type": "did_groups",
 8        "attributes": {
 9            "prefix": "241",
10            "features": [
11                "voice_in",
12                "voice_out",
13                "t38"
14            ],
15            "is_metered": false,
16            "area_name": "Aachen",
17            "allow_additional_channels": true,
18            "service_restrictions": null,
19            "number_type": "local",
20            "is_demo": false
21        },
22        "relationships": {
23            "country": {
24                "links": {
25                    "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/country",
26                    "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/country"
27                }
28            },
29            "city": {
30                "links": {
31                    "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/city",
32                    "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/city"
33                }
34            },
35            "region": {
36                "links": {
37                    "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/region",
38                    "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/region"
39                }
40            },
41            "stock_keeping_units": {
42                "links": {
43                    "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/stock_keeping_units",
44                    "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/stock_keeping_units"
45                }
46            },
47            "address_requirement": {
48                "links": {
49                    "self": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/relationships/address_requirement",
50                    "related": "https://api.didww.com/v3/did_groups/ac160b14-e670-490f-b158-d3ba552c623f/address_requirement"
51                }
52            }
53        },
54        "meta": {
55            "available_dids_enabled": false,
56            "needs_registration": true,
57            "is_available": true,
58            "total_count": 21
59        }
60
61    }],
62    "meta": {
63        "total_records": 1,
64        "api_version": "2026-11-19"
65    },
66    "links": {
67        "first": "https://api.didww.com/v3/did_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
68        "last": "https://api.didww.com/v3/did_groups?page%5Bnumber%5D=32&page%5Bsize%5D=50"
69    }
70}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/did_groups?filter%5Bcountry.id%5D=c8647639-fc9c-47b2-acec-7c9e14465c25&filter%5Bnumber_type%5D=mobile&include=stock_keeping_units 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?filter%5Bcountry.id%5D=c8647639-fc9c-47b2-acec-7c9e14465c25&filter%5Bnumber_type%5D=mobile&include=stock_keeping_units' -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": "1d5aad75-b853-4125-9a1a-da3fedfc5674",
  7        "type": "did_groups",
  8        "attributes": {
  9            "prefix": "7",
 10            "features": [
 11                "voice_in",
 12                "voice_out",
 13                "sms_in",
 14                "p2p",
 15                "a2p",
 16                "cnam_out",
 17                "emergency"
 18            ],
 19            "is_metered": false,
 20            "area_name": "Mobile",
 21            "allow_additional_channels": true,
 22            "service_restrictions": null,
 23            "number_type": "mobile",
 24            "is_demo": false
 25        },
 26        "relationships": {
 27            "country": {
 28                "links": {
 29                    "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/country",
 30                    "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/country"
 31                }
 32            },
 33            "city": {
 34                "links": {
 35                    "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/city",
 36                    "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/city"
 37                }
 38            },
 39            "region": {
 40                "links": {
 41                    "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/region",
 42                    "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/region"
 43                }
 44            },
 45            "stock_keeping_units": {
 46                "links": {
 47                    "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/stock_keeping_units",
 48                    "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/stock_keeping_units"
 49                },
 50                "data": [{
 51                        "type": "stock_keeping_units",
 52                        "id": "cb17c069-098e-4be1-a7eb-eb4529e8c5f5"
 53                    },
 54                    {
 55                        "type": "stock_keeping_units",
 56                        "id": "e194165e-eda7-4718-9bbe-c5c583bd189a"
 57                    }
 58                ]
 59            },
 60            "address_requirement": {
 61                "links": {
 62                    "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/address_requirement",
 63                    "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/address_requirement"
 64                }
 65            }
 66        },
 67        "meta": {
 68            "available_dids_enabled": true,
 69            "needs_registration": false,
 70            "is_available": true,
 71            "total_count": 99
 72        }
 73    }],
 74    "included": [{
 75            "id": "cb17c069-098e-4be1-a7eb-eb4529e8c5f5",
 76            "type": "stock_keeping_units",
 77            "attributes": {
 78                "setup_price": "0.0",
 79                "monthly_price": "0.3",
 80                "channels_included_count": 0
 81            }
 82        },
 83        {
 84            "id": "e194165e-eda7-4718-9bbe-c5c583bd189a",
 85            "type": "stock_keeping_units",
 86            "attributes": {
 87                "setup_price": "0.0",
 88                "monthly_price": "0.8",
 89                "channels_included_count": 2
 90            }
 91        }
 92    ],
 93    "meta": {
 94        "total_records": 1,
 95        "api_version": "2026-11-19"
 96    },
 97    "links": {
 98        "first": "https://api.didww.com/v3/did_groups?filter%5Bcountry.id%5D=c8647639-fc9c-47b2-acec-7c9e14465c25&filter%5Bnumber_type%5D=mobile&include=stock_keeping_units&page%5Bnumber%5D=1&page%5Bsize%5D=50",
 99        "last": "https://api.didww.com/v3/did_groups?filter%5Bcountry.id%5D=c8647639-fc9c-47b2-acec-7c9e14465c25&filter%5Bnumber_type%5D=mobile&include=stock_keeping_units&page%5Bnumber%5D=1&page%5Bsize%5D=50"
100    }
101}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/did_groups?filter%5Bcity.id%5D=e696dec7-9c65-4e99-aab7-55a1f98154f0&include=stock_keeping_units&filter%5Bprefix%5D=20 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?filter%5Bcity.id%5D=e696dec7-9c65-4e99-aab7-55a1f98154f0&include=stock_keeping_units&filter%5Bprefix%5D=20' -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": "fc271bcc-1f9c-4c19-8174-28b7c55a208a",
 7        "type": "did_groups",
 8        "attributes": {
 9            "prefix": "20",
10            "features": [
11                "voice_in",
12                "voice_out",
13                "t38"
14            ],
15            "is_metered": false,
16            "area_name": "London",
17            "allow_additional_channels": true,
18            "service_restrictions": null,
19            "number_type": "local",
20            "is_demo": false
21        },
22        "relationships": {
23            "country": {
24                "links": {
25                    "self": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/country",
26                    "related": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/country"
27                }
28            },
29            "city": {
30                "links": {
31                    "self": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/city",
32                    "related": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/city"
33                }
34            },
35            "region": {
36                "links": {
37                    "self": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/region",
38                    "related": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/region"
39                }
40            },
41            "stock_keeping_units": {
42                "links": {
43                    "self": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/stock_keeping_units",
44                    "related": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/stock_keeping_units"
45                },
46                "data": [{
47                        "type": "stock_keeping_units",
48                        "id": "0ba87a94-7143-48cb-a0f6-d50a6a0c8cfa"
49                    },
50                    {
51                        "type": "stock_keeping_units",
52                        "id": "1a86de53-3131-491f-9e4b-3392da45d441"
53                    }
54                ]
55            },
56            "address_requirement": {
57                "links": {
58                    "self": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/relationships/address_requirement",
59                    "related": "https://api.didww.com/v3/did_groups/fc271bcc-1f9c-4c19-8174-28b7c55a208a/address_requirement"
60                }
61            }
62        },
63        "meta": {
64            "available_dids_enabled": true,
65            "needs_registration": false,
66            "is_available": true,
67            "total_count": 932
68        }
69    }],
70    "included": [{
71            "id": "0ba87a94-7143-48cb-a0f6-d50a6a0c8cfa",
72            "type": "stock_keeping_units",
73            "attributes": {
74                "setup_price": "0.0",
75                "monthly_price": "0.3",
76                "channels_included_count": 0
77            }
78        },
79        {
80            "id": "1a86de53-3131-491f-9e4b-3392da45d441",
81            "type": "stock_keeping_units",
82            "attributes": {
83                "setup_price": "0.0",
84                "monthly_price": "0.8",
85                "channels_included_count": 2
86            }
87        }
88    ],
89    "meta": {
90        "total_records": 1,
91        "api_version": "2026-11-19"
92    },
93    "links": {
94        "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",
95        "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"
96    }
97}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/did_groups?filter%5Bnanpa_prefix.id%5D=1d968dcf-8ee7-40fa-8073-cdbc027bc3b3 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?filter%5Bnanpa_prefix.id%5D=1d968dcf-8ee7-40fa-8073-cdbc027bc3b3' -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        {
 7            "id": "b59a0277-9d74-4417-b477-192794496928",
 8            "type": "did_groups",
 9            "attributes": {
10                "prefix": "201",
11                "features": [
12                    "voice_in"
13                ],
14                "is_metered": false,
15                "area_name": "Hackensack",
16                "allow_additional_channels": true,
17                "service_restrictions": null,
18                "number_type": "local",
19                "is_demo": false
20            },
21            "relationships": {
22                "country": {
23                    "links": {
24                        "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/country",
25                        "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/country"
26                    }
27                },
28                "city": {
29                    "links": {
30                        "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/city",
31                        "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/city"
32                    }
33                },
34                "region": {
35                    "links": {
36                        "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/region",
37                        "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/region"
38                    }
39                },
40                "stock_keeping_units": {
41                    "links": {
42                        "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/stock_keeping_units",
43                        "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/stock_keeping_units"
44                    }
45                },
46                "address_requirement": {
47                    "links": {
48                        "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/address_requirement",
49                        "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/address_requirement"
50                    }
51                }
52            },
53            "meta": {
54                "available_dids_enabled": true,
55                "needs_registration": false,
56                "is_available": true,
57                "total_count": 3
58            }
59        }
60    ],
61    "meta": {
62        "total_records": 1,
63        "api_version": "2026-11-19"
64    },
65    "links": {
66        "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",
67        "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"
68    }
69}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/did_groups?filter%5Bnanpa_prefix.npanxx%5D=201221 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?filter%5Bnanpa_prefix.npanxx%5D=201221' -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        {
 7            "id": "b59a0277-9d74-4417-b477-192794496928",
 8            "type": "did_groups",
 9            "attributes": {
10                "prefix": "201",
11                "features": [
12                    "voice_in"
13                ],
14                "is_metered": false,
15                "area_name": "Hackensack",
16                "allow_additional_channels": true,
17                "service_restrictions": null,
18                "number_type": "local",
19                "is_demo": false
20            },
21            "relationships": {
22                "country": {
23                    "links": {
24                        "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/country",
25                        "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/country"
26                    }
27                },
28                "city": {
29                    "links": {
30                        "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/city",
31                        "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/city"
32                    }
33                },
34                "region": {
35                    "links": {
36                        "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/region",
37                        "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/region"
38                    }
39                },
40                "stock_keeping_units": {
41                    "links": {
42                        "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/stock_keeping_units",
43                        "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/stock_keeping_units"
44                    }
45                },
46                "address_requirement": {
47                    "links": {
48                        "self": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/relationships/address_requirement",
49                        "related": "https://api.didww.com/v3/did_groups/b59a0277-9d74-4417-b477-192794496928/address_requirement"
50                    }
51                }
52            },
53            "meta": {
54                "available_dids_enabled": true,
55                "needs_registration": false,
56                "is_available": true,
57                "total_count": 3
58            }
59        }
60    ],
61    "meta": {
62        "total_records": 1,
63        "api_version": "2026-11-19"
64    },
65    "links": {
66        "first": "https://api.didww.com/v3/did_groups?filter%5Bnanpa_prefix.npanxx%5D=201221&page%5Bnumber%5D=1&page%5Bsize%5D=50",
67        "last": "https://api.didww.com/v3/did_groups?filter%5Bnanpa_prefix.npanxx%5D=201221&page%5Bnumber%5D=1&page%5Bsize%5D=50"
68    }
69}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/did_groups?filter%5Bid%5D=1d5aad75-b853-4125-9a1a-da3fedfc5674 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?filter%5Bid%5D=1d5aad75-b853-4125-9a1a-da3fedfc5674' -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        {
 7            "id": "1d5aad75-b853-4125-9a1a-da3fedfc5674",
 8            "type": "did_groups",
 9            "attributes": {
10                "prefix": "7",
11                "features": [
12                    "voice_in",
13                    "voice_out",
14                    "sms_in",
15                    "p2p"
16                ],
17                "is_metered": false,
18                "area_name": "Mobile",
19                "allow_additional_channels": true,
20                "service_restrictions": "*DIDWW United Kingdom Mobile numbers can only be used with DIDWW Voice and SMS termination services to make outbound calls and send messages.\r\n\r\n*Porting of United Kingdom Mobile numbers outside of DIDWW is not supported.\r\n\r\n*May be unreachable from outside the country.\r\n\r\n*Verification of social media accounts is not supported.",
21                "number_type": "mobile",
22                "is_demo": false
23            },
24            "relationships": {
25                "country": {
26                    "links": {
27                        "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/country",
28                        "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/country"
29                    }
30                },
31                "city": {
32                    "links": {
33                        "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/city",
34                        "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/city"
35                    }
36                },
37                "region": {
38                    "links": {
39                        "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/region",
40                        "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/region"
41                    }
42                },
43                "stock_keeping_units": {
44                    "links": {
45                        "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/stock_keeping_units",
46                        "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/stock_keeping_units"
47                    }
48                },
49                "address_requirement": {
50                    "links": {
51                        "self": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/relationships/address_requirement",
52                        "related": "https://api.didww.com/v3/did_groups/1d5aad75-b853-4125-9a1a-da3fedfc5674/address_requirement"
53                    }
54                }
55            },
56            "meta": {
57                "available_dids_enabled": false,
58                "needs_registration": false,
59                "is_available": true,
60                "total_count": 2695
61            }
62        }
63    ],
64    "meta": {
65        "total_records": 1,
66        "api_version": "2026-11-19"
67    },
68    "links": {
69        "first": "https://api.didww.com/v3/did_groups?filter%5Bid%5D=1d5aad75-b853-4125-9a1a-da3fedfc5674&page%5Bnumber%5D=1&page%5Bsize%5D=50",
70        "last": "https://api.didww.com/v3/did_groups?filter%5Bid%5D=1d5aad75-b853-4125-9a1a-da3fedfc5674&page%5Bnumber%5D=1&page%5Bsize%5D=50"
71    }
72}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 400 | No | [Bad Request](../../../specification/errors/index.html#api-bad-request) |
| 401 | No | [Unauthorized](../../authentication.html#authentication-v35) |
| 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. |
