Get DID#
Returns a single DID owned by your account.
Request#
HTTP Method: GET
URI Path: /v3/dids/{id}
Note
For all returned data attributes, see Did Object.
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID identifier of the DID. |
include |
|
No |
Related resources to include in the response. See Inclusion. |
Includes#
Value |
Description |
|---|---|
order |
|
voice_in_trunk |
|
voice_in_trunk.voice_in_trunk_group |
|
voice_in_trunk.pop |
|
voice_in_trunk_group |
|
capacity_pool |
|
shared_capacity_group |
|
did_group |
|
identity |
|
emergency_calling_service |
|
emergency_verification |
|
did_group.country |
|
did_group.city |
|
did_group.region |
|
did_group.did_group_type |
|
did_group.stock_keeping_units |
Object Relationships#
Value |
Description |
|---|---|
order |
|
voice_in_trunk |
|
voice_in_trunk.voice_in_trunk_group |
|
voice_in_trunk.pop |
|
voice_in_trunk_group |
|
capacity_pool |
|
shared_capacity_group |
|
did_group |
|
identity |
|
emergency_calling_service |
Emergency Calling Service resource |
emergency_verification |
Emergency Verification resource |
did_group.country |
|
did_group.city |
|
did_group.region |
|
did_group.did_group_type |
|
did_group.stock_keeping_units |
Examples#
http
1GET /v3/dids/44957076-778a-4802-b60c-d22db0cda284 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/dids/44957076-778a-4802-b60c-d22db0cda284 -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": "44957076-778a-4802-b60c-d22db0cda284",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": 1,
11 "description": "string",
12 "terminated": false,
13 "awaiting_registration": false,
14 "number": "437xxxxxxxxx",
15 "expires_at": "2017-06-25T08:21:41.795Z",
16 "channels_included_count": 2,
17 "created_at": "2017-06-25T08:21:41.795Z",
18 "dedicated_channels_count": 0,
19 "emergency_enabled": false
20 },
21 "relationships": {
22 "did_group": {
23 "links": {
24 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/did_group",
25 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/did_group"
26 }
27 },
28 "order": {
29 "links": {
30 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/order",
31 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/order"
32 }
33 },
34 "voice_in_trunk": {
35 "links": {
36 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk",
37 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk"
38 }
39 },
40 "voice_in_trunk_group": {
41 "links": {
42 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk_group",
43 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk_group"
44 }
45 },
46 "capacity_pool": {
47 "links": {
48 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/capacity_pool",
49 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/capacity_pool"
50 }
51 },
52 "shared_capacity_group": {
53 "links": {
54 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/shared_capacity_group",
55 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/shared_capacity_group"
56 }
57 },
58 "address_verification": {
59 "links": {
60 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/address_verification",
61 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/address_verification"
62 }
63 },
64 "emergency_calling_service": {
65 "links": {
66 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_calling_service",
67 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_calling_service"
68 }
69 },
70 "emergency_verification": {
71 "links": {
72 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_verification",
73 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_verification"
74 }
75 },
76 "identity": {
77 "links": {
78 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/identity",
79 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/identity"
80 }
81 }
82 }
83 },
84 "meta": {
85 "api_version": "2026-04-16"
86 }
87}
http
1GET /v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d?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/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d?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": "2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": 1,
11 "description": "string",
12 "terminated": false,
13 "awaiting_registration": false,
14 "number": "437xxxxxxxxx",
15 "expires_at": "2017-06-25T08:21:41.795Z",
16 "channels_included_count": 2,
17 "created_at": "2017-06-25T08:21:41.795Z",
18 "dedicated_channels_count": 0,
19 "emergency_enabled": false
20 },
21 "relationships": {
22 "did_group": {
23 "links": {
24 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/did_group",
25 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/did_group"
26 },
27 "data": {
28 "type": "did_groups",
29 "id": "d04b6466-3d98-4be1-aac5-93ee241f57ca"
30 }
31 },
32 "order": {
33 "links": {
34 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/order",
35 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/order"
36 }
37 },
38 "voice_in_trunk": {
39 "links": {
40 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/voice_in_trunk",
41 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/voice_in_trunk"
42 }
43 },
44 "voice_in_trunk_group": {
45 "links": {
46 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/voice_in_trunk_group",
47 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/voice_in_trunk_group"
48 }
49 },
50 "capacity_pool": {
51 "links": {
52 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/capacity_pool",
53 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/capacity_pool"
54 }
55 },
56 "shared_capacity_group": {
57 "links": {
58 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/shared_capacity_group",
59 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/shared_capacity_group"
60 }
61 },
62 "address_verification": {
63 "links": {
64 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/address_verification",
65 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/address_verification"
66 }
67 },
68 "emergency_calling_service": {
69 "links": {
70 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/emergency_calling_service",
71 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/emergency_calling_service"
72 }
73 },
74 "emergency_verification": {
75 "links": {
76 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/emergency_verification",
77 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/emergency_verification"
78 }
79 },
80 "identity": {
81 "links": {
82 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/identity",
83 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/identity"
84 }
85 }
86 }
87 },
88 "included": [
89 {
90 "id": "d04b6466-3d98-4be1-aac5-93ee241f57ca",
91 "type": "did_groups",
92 "links": {
93 "self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca"
94 },
95 "attributes": {
96 "prefix": "721",
97 "local_prefix": "",
98 "features": [
99 "voice_in"
100 ],
101 "is_metered": false,
102 "area_name": "National",
103 "allow_additional_channels": true
104 }
105 }
106 ],
107 "meta": {
108 "api_version": "2026-04-16"
109 }
110}
http
1GET /v3/dids/44957076-778a-4802-b60c-d22db0cda284?include=identity 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/dids/44957076-778a-4802-b60c-d22db0cda284?include=identity' -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": "44957076-778a-4802-b60c-d22db0cda284",
7 "type": "dids",
8 "attributes": {
9 "blocked": false,
10 "capacity_limit": 1,
11 "description": "string",
12 "terminated": false,
13 "awaiting_registration": false,
14 "number": "437xxxxxxxxx",
15 "expires_at": "2017-06-25T08:21:41.795Z",
16 "channels_included_count": 2,
17 "created_at": "2017-06-25T08:21:41.795Z",
18 "dedicated_channels_count": 0,
19 "emergency_enabled": false
20 },
21 "relationships": {
22 "identity": {
23 "links": {
24 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/identity",
25 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/identity"
26 },
27 "data": {
28 "type": "identities",
29 "id": "9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41"
30 }
31 }
32 }
33 },
34 "included": [
35 {
36 "id": "9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41",
37 "type": "identities",
38 "links": {
39 "self": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41"
40 },
41 "attributes": {
42 "first_name": "John",
43 "last_name": "Doe",
44 "birth_date": "1985-02-10",
45 "email": "john.doe@example.com"
46 }
47 }
48 ],
49 "meta": {
50 "api_version": "2026-04-16"
51 }
52}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |