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/
Note
For all returned data attributes, see Available Did Object.
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID number of the Available DID. |
include |
|
No |
Includes#
Value |
Description |
|---|---|
did_group |
|
did_group.stock_keeping_units |
|
nanpa_prefix |
Examples#
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
5Api-Key: [API 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 "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
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-04-16"
28 }
29 }
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
5Api-Key: [API 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 "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
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 },
45 "relationships": {
46 "country": {
47 "links": {
48 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/country",
49 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/country"
50 }
51 },
52 "city": {
53 "links": {
54 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/city",
55 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/city"
56 }
57 },
58 "did_group_type": {
59 "links": {
60 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/did_group_type",
61 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/did_group_type"
62 }
63 },
64 "region": {
65 "links": {
66 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/region",
67 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/region"
68 }
69 },
70 "stock_keeping_units": {
71 "links": {
72 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/stock_keeping_units",
73 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/stock_keeping_units"
74 }
75 },
76 "address_requirement": {
77 "links": {
78 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/address_requirement",
79 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/address_requirement"
80 }
81 }
82 },
83 "meta": {
84 "available_dids_enabled": true,
85 "needs_registration": false,
86 "is_available": true,
87 "total_count": 8
88 }
89 }
90 ],
91 "meta": {
92 "api_version": "2026-04-16"
93 }
94}
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
5Api-Key: [API 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 "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
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 },
45 "relationships": {
46 "country": {
47 "links": {
48 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/country",
49 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/country"
50 }
51 },
52 "city": {
53 "links": {
54 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/city",
55 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/city"
56 }
57 },
58 "did_group_type": {
59 "links": {
60 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/did_group_type",
61 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/did_group_type"
62 }
63 },
64 "region": {
65 "links": {
66 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/region",
67 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/region"
68 }
69 },
70 "stock_keeping_units": {
71 "links": {
72 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/stock_keeping_units",
73 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/stock_keeping_units"
74 },
75 "data": [
76 {
77 "type": "stock_keeping_units",
78 "id": "af589936-3e8d-498c-b127-8054ef026dfa"
79 },
80 {
81 "type": "stock_keeping_units",
82 "id": "5dec9d3e-f25a-4ac3-a9b0-efcdd9ec744b"
83 },
84 {
85 "type": "stock_keeping_units",
86 "id": "e48e981f-ab6d-48a6-aaf6-e75539fc1011"
87 }
88 ]
89 },
90 "address_requirement": {
91 "links": {
92 "self": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/relationships/address_requirement",
93 "related": "https://api.didww.com/v3/did_groups/916c8f4d-2108-4d79-853b-7c545ee83f8c/address_requirement"
94 }
95 }
96 },
97 "meta": {
98 "available_dids_enabled": true,
99 "needs_registration": false,
100 "is_available": true,
101 "total_count": 8
102 }
103 },
104 {
105 "id": "af589936-3e8d-498c-b127-8054ef026dfa",
106 "type": "stock_keeping_units",
107 "attributes": {
108 "setup_price": "0.0",
109 "monthly_price": "0.09",
110 "channels_included_count": 0
111 }
112 },
113 {
114 "id": "5dec9d3e-f25a-4ac3-a9b0-efcdd9ec744b",
115 "type": "stock_keeping_units",
116 "attributes": {
117 "setup_price": "0.0",
118 "monthly_price": "0.19",
119 "channels_included_count": 2
120 }
121 },
122 {
123 "id": "e48e981f-ab6d-48a6-aaf6-e75539fc1011",
124 "type": "stock_keeping_units",
125 "attributes": {
126 "setup_price": "4.42",
127 "monthly_price": "4.42",
128 "channels_included_count": 5
129 }
130 }
131 ],
132 "meta": {
133 "api_version": "2026-04-16"
134 }
135}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |