# Get Available DID

Returns a single Available DID from DIDWW inventory.

Note

Available DID request is not enabled by default. To enable this feature, please contact our Customer Service or Sales
Departments.

## Request

HTTP Method: `GET`

URI Path: `/v3/available_dids/{id}`

Note

For all returned data attributes, see [Available Did Object](available-did-object.html).

### URI Query Parameters

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| id | `string` | Yes | Unique ID number of the Available DID. |
| include | `string` | No | [Inclusion](../../../specification/includes.html#api-includes) |

### Includes

| Value | Description |
| --- | --- |
| did\_group | [DID Group Object](../did-group/did-group-object.html#did-group-object-v35) |
| did\_group.stock\_keeping\_units | [Stock Keeping Unit Object](../../common-definitions/index.html#stock-keeping-unit-object-v35) |
| nanpa\_prefix | [Nanpa Prefix Object](../nanpa/nanpa-prefixes-object.html#nanpa-prefix-object-v35) |

## Examples

Simple requestInclude did\_groupInclude did\_group.stock\_keeping\_units

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144 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/available_dids/75a21935-acfd-4160-8485-9fb7d049f144 -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": "75a21935-acfd-4160-8485-9fb7d049f144",
 7         "type": "available_dids",
 8         "attributes": {
 9             "number": "12124727604"
10         },
11         "relationships": {
12             "did_group": {
13                 "links": {
14                     "self": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/relationships/did_group",
15                     "related": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/did_group"
16                 }
17             },
18             "nanpa_prefix": {
19                 "links": {
20                     "self": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/relationships/nanpa_prefix",
21                     "related": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/nanpa_prefix"
22                 }
23             }
24         }
25     },
26     "meta": {
27         "api_version": "2026-11-19"
28     }
29 }
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144?include=did_group 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/available_dids/75a21935-acfd-4160-8485-9fb7d049f144?include=did_group' -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": "75a21935-acfd-4160-8485-9fb7d049f144",
 7        "type": "available_dids",
 8        "attributes": {
 9            "number": "12124727604"
10        },
11        "relationships": {
12            "did_group": {
13                "links": {
14                    "self": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/relationships/did_group",
15                    "related": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/did_group"
16                },
17                "data": {
18                    "type": "did_groups",
19                    "id": "916c8f4d-2108-4d79-853b-7c545ee83f8c"
20                }
21            },
22            "nanpa_prefix": {
23                "links": {
24                    "self": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/relationships/nanpa_prefix",
25                    "related": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/nanpa_prefix"
26                }
27            }
28        }
29    },
30    "included": [
31        {
32            "id": "916c8f4d-2108-4d79-853b-7c545ee83f8c",
33            "type": "did_groups",
34            "attributes": {
35                "prefix": "212",
36                "features": [
37                    "voice_in",
38                    "t38"
39                ],
40                "is_metered": false,
41                "area_name": "New York",
42                "allow_additional_channels": true,
43                "service_restrictions": null,
44                "number_type": "local",
45                "is_demo": false
46            },
47            "relationships": {
48                "country": {
49                    "links": {
50                        "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/country",
51                        "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/country"
52                    }
53                },
54                "city": {
55                    "links": {
56                        "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/city",
57                        "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/city"
58                    }
59                },
60                "region": {
61                    "links": {
62                        "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/region",
63                        "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/region"
64                    }
65                },
66                "stock_keeping_units": {
67                    "links": {
68                        "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/stock_keeping_units",
69                        "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/stock_keeping_units"
70                    }
71                },
72                "address_requirement": {
73                    "links": {
74                        "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/address_requirement",
75                        "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/address_requirement"
76                    }
77                }
78            },
79            "meta": {
80                "available_dids_enabled": true,
81                "needs_registration": false,
82                "is_available": true,
83                "total_count": 8
84            }
85        }
86    ],
87    "meta": {
88        "api_version": "2026-11-19"
89    }
90}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144?include=did_group.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/available_dids/75a21935-acfd-4160-8485-9fb7d049f144?include=did_group.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": "75a21935-acfd-4160-8485-9fb7d049f144",
  7        "type": "available_dids",
  8        "attributes": {
  9            "number": "12124727604"
 10        },
 11        "relationships": {
 12            "did_group": {
 13                "links": {
 14                    "self": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/relationships/did_group",
 15                    "related": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/did_group"
 16                },
 17                "data": {
 18                    "type": "did_groups",
 19                    "id": "916c8f4d-2108-4d79-853b-7c545ee83f8c"
 20                }
 21            },
 22            "nanpa_prefix": {
 23                "links": {
 24                    "self": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/relationships/nanpa_prefix",
 25                    "related": "https://api.didww.com/v3/available_dids/75a21935-acfd-4160-8485-9fb7d049f144/nanpa_prefix"
 26                }
 27            }
 28        }
 29    },
 30    "included": [
 31        {
 32            "id": "916c8f4d-2108-4d79-853b-7c545ee83f8c",
 33            "type": "did_groups",
 34            "attributes": {
 35                "prefix": "212",
 36                "features": [
 37                    "voice_in",
 38                    "t38"
 39                ],
 40                "is_metered": false,
 41                "area_name": "New York",
 42                "allow_additional_channels": true,
 43                "service_restrictions": null,
 44                "number_type": "local",
 45                "is_demo": false
 46            },
 47            "relationships": {
 48                "country": {
 49                    "links": {
 50                        "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/country",
 51                        "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/country"
 52                    }
 53                },
 54                "city": {
 55                    "links": {
 56                        "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/city",
 57                        "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/city"
 58                    }
 59                },
 60                "region": {
 61                    "links": {
 62                        "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/region",
 63                        "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/region"
 64                    }
 65                },
 66                "stock_keeping_units": {
 67                    "links": {
 68                        "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/stock_keeping_units",
 69                        "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/stock_keeping_units"
 70                    },
 71                    "data": [
 72                        {
 73                            "type": "stock_keeping_units",
 74                            "id": "af589936-3e8d-498c-b127-8054ef026dfa"
 75                        },
 76                        {
 77                            "type": "stock_keeping_units",
 78                            "id": "5dec9d3e-f25a-4ac3-a9b0-efcdd9ec744b"
 79                        },
 80                        {
 81                            "type": "stock_keeping_units",
 82                            "id": "e48e981f-ab6d-48a6-aaf6-e75539fc1011"
 83                        }
 84                    ]
 85                },
 86                "address_requirement": {
 87                    "links": {
 88                        "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/address_requirement",
 89                        "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/address_requirement"
 90                    }
 91                }
 92            },
 93            "meta": {
 94                "available_dids_enabled": true,
 95                "needs_registration": false,
 96                "is_available": true,
 97                "total_count": 8
 98            }
 99        },
100        {
101            "id": "af589936-3e8d-498c-b127-8054ef026dfa",
102            "type": "stock_keeping_units",
103            "attributes": {
104                "setup_price": "0.0",
105                "monthly_price": "0.09",
106                "channels_included_count": 0
107            }
108        },
109        {
110            "id": "5dec9d3e-f25a-4ac3-a9b0-efcdd9ec744b",
111            "type": "stock_keeping_units",
112            "attributes": {
113                "setup_price": "0.0",
114                "monthly_price": "0.19",
115                "channels_included_count": 2
116            }
117        },
118        {
119            "id": "e48e981f-ab6d-48a6-aaf6-e75539fc1011",
120            "type": "stock_keeping_units",
121            "attributes": {
122                "setup_price": "4.42",
123                "monthly_price": "4.42",
124                "channels_included_count": 5
125            }
126        }
127    ],
128    "meta": {
129        "api_version": "2026-11-19"
130    }
131}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 404 | No | [Not Found](../../../specification/errors/index.html#api-not-found) |
| 401 | No | [Unauthorized](../../authentication.html#authentication-v35) |
| 403 | No | Numbers selection is not enabled for the account. |
| 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. |
