Get DIDs#
Returns a list of DIDs owned by your account.
Request#
HTTP Method: GET
URI Path: /v3/dids
Note
For all returned data attributes, see Did Object.
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
include |
|
No |
|
filter[<filter_name>] |
|
No |
|
fields[dids] |
|
No |
|
sort |
|
No |
|
page[number] |
|
No |
|
page[size] |
|
No |
Page size. Pagination defaults to |
Includes#
Value |
Description |
|---|---|
order |
|
voice_in_trunk |
|
voice_in_trunk.voice_in_trunk_group |
|
voice_in_trunk_group |
|
sms_trunk |
|
sms_trunk_group |
|
capacity_pool |
|
shared_capacity_group |
|
did_group |
|
identity |
|
emergency_calling_service |
|
emergency_verification |
|
address_verification |
|
did_group.country |
|
did_group.city |
|
did_group.region |
|
did_group.stock_keeping_units |
Filters#
Filter Name |
Type |
Allow Blank |
Allow Array |
Filters by: |
|---|---|---|---|---|
id |
|
No |
Yes |
The DID |
number |
|
No |
Yes |
The DID |
description |
|
Yes |
No |
DIDs whose |
terminated |
|
No |
No |
The |
awaiting_registration |
|
No |
No |
The |
blocked |
|
No |
No |
The |
billing_cycles_count |
|
Yes |
Yes |
The |
did_group.id |
|
No |
Yes |
The ID field of |
country.id |
|
Yes |
Yes |
The ID field of |
region.id |
|
No |
Yes |
The ID field of |
city.id |
|
No |
Yes |
The ID field of |
order.id |
|
No |
Yes |
The ID field of |
voice_in_trunk.id |
|
No |
Yes |
The ID field of |
trunk.id |
|
No |
Yes |
Legacy alias of |
voice_in_trunk_group.id |
|
No |
Yes |
The ID field of |
trunk_group.id |
|
No |
Yes |
Legacy alias of |
sms_trunk.id |
|
No |
Yes |
The ID field of |
sms_trunk_group.id |
|
No |
Yes |
The ID field of |
shared_capacity_group.id |
|
No |
Yes |
The ID field of |
capacity_pool.id |
|
No |
Yes |
The ID field of |
order.reference |
|
No |
Yes |
The reference field of |
did_group.features |
|
No |
Yes |
DID Group |
address_verification.id |
|
No |
Yes |
The ID field of |
emergency_enabled |
|
No |
No |
Filters by the |
emergency_calling_service.id |
|
No |
Yes |
The ID field of |
Sorting#
Value |
Sorts by: |
|---|---|
blocked |
Blocked status |
awaiting_registration |
Awaiting registration status |
terminated |
Termination status |
capacity_limit |
Capacity limit |
billing_cycles_count |
Billing cycles count |
description |
Description text |
number |
DID number |
expires_at |
Expiration timestamp |
channels_included_count |
Included channels count |
dedicated_channels_count |
Dedicated channels count |
created_at |
Creation timestamp |
Examples#
http
1GET /v3/dids 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/dids -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": "ac40fb08-ac14-4a6c-8f20-fe650870c266",
8 "type": "dids",
9 "attributes": {
10 "blocked": false,
11 "capacity_limit": 1,
12 "description": "string",
13 "terminated": false,
14 "awaiting_registration": false,
15 "number": "437xxxxxxxxx",
16 "expires_at": "2017-06-25T08:21:41.795Z",
17 "channels_included_count": 2,
18 "created_at": "2017-06-25T08:21:41.795Z",
19 "dedicated_channels_count": 0,
20 "billing_cycles_count": null,
21 "emergency_enabled": false
22 },
23 "relationships": {
24 "did_group": {
25 "links": {
26 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/did_group",
27 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/did_group"
28 }
29 },
30 "order": {
31 "links": {
32 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/order",
33 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/order"
34 }
35 },
36 "voice_in_trunk": {
37 "links": {
38 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/voice_in_trunk",
39 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/voice_in_trunk"
40 }
41 },
42 "voice_in_trunk_group": {
43 "links": {
44 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/voice_in_trunk_group",
45 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/voice_in_trunk_group"
46 }
47 },
48 "capacity_pool": {
49 "links": {
50 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/capacity_pool",
51 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/capacity_pool"
52 }
53 },
54 "shared_capacity_group": {
55 "links": {
56 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/shared_capacity_group",
57 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/shared_capacity_group"
58 }
59 },
60 "sms_trunk": {
61 "links": {
62 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/sms_trunk",
63 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/sms_trunk"
64 }
65 },
66 "sms_trunk_group": {
67 "links": {
68 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/sms_trunk_group",
69 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/sms_trunk_group"
70 }
71 },
72 "address_verification": {
73 "links": {
74 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/address_verification",
75 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/address_verification"
76 }
77 },
78 "emergency_calling_service": {
79 "links": {
80 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/emergency_calling_service",
81 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/emergency_calling_service"
82 }
83 },
84 "emergency_verification": {
85 "links": {
86 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/emergency_verification",
87 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/emergency_verification"
88 }
89 },
90 "identity": {
91 "links": {
92 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/identity",
93 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/identity"
94 }
95 }
96 }
97 },
98 {
99 "id": "b37f0fcf-24d0-4799-8e81-a69bcc889f2e",
100 "type": "dids",
101 "attributes": {
102 "blocked": false,
103 "capacity_limit": 1,
104 "description": "string",
105 "terminated": false,
106 "awaiting_registration": false,
107 "number": "437xxxxxxxxx",
108 "expires_at": "2017-06-25T08:21:41.795Z",
109 "channels_included_count": 2,
110 "created_at": "2017-06-25T08:21:41.795Z",
111 "dedicated_channels_count": 0,
112 "billing_cycles_count": null,
113 "emergency_enabled": false
114 },
115 "relationships": {
116 "did_group": {
117 "links": {
118 "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/did_group",
119 "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/did_group"
120 }
121 },
122 "order": {
123 "links": {
124 "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/order",
125 "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/order"
126 }
127 },
128 "voice_in_trunk": {
129 "links": {
130 "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/voice_in_trunk",
131 "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/voice_in_trunk"
132 }
133 },
134 "voice_in_trunk_group": {
135 "links": {
136 "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/voice_in_trunk_group",
137 "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/voice_in_trunk_group"
138 }
139 },
140 "capacity_pool": {
141 "links": {
142 "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/capacity_pool",
143 "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/capacity_pool"
144 }
145 },
146 "shared_capacity_group": {
147 "links": {
148 "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/shared_capacity_group",
149 "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/shared_capacity_group"
150 }
151 },
152 "sms_trunk": {
153 "links": {
154 "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/sms_trunk",
155 "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/sms_trunk"
156 }
157 },
158 "sms_trunk_group": {
159 "links": {
160 "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/sms_trunk_group",
161 "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/sms_trunk_group"
162 }
163 },
164 "address_verification": {
165 "links": {
166 "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/address_verification",
167 "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/address_verification"
168 }
169 },
170 "emergency_calling_service": {
171 "links": {
172 "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/emergency_calling_service",
173 "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/emergency_calling_service"
174 }
175 },
176 "emergency_verification": {
177 "links": {
178 "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/emergency_verification",
179 "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/emergency_verification"
180 }
181 },
182 "identity": {
183 "links": {
184 "self": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/relationships/identity",
185 "related": "https://api.didww.com/v3/dids/b37f0fcf-24d0-4799-8e81-a69bcc889f2e/identity"
186 }
187 }
188 }
189 }
190 ],
191 "meta": {
192 "total_records": 2,
193 "api_version": "2026-11-19"
194 },
195 "links": {
196 "first": "https://api.didww.com/v3/dids?page%5Bnumber%5D=1&page%5Bsize%5D=50",
197 "last": "https://api.didww.com/v3/dids?page%5Bnumber%5D=1&page%5Bsize%5D=50"
198 }
199 }
http
1GET /v3/dids?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/dids?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 {
7 "id": "2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d",
8 "type": "dids",
9 "attributes": {
10 "blocked": false,
11 "capacity_limit": 1,
12 "description": "string",
13 "terminated": false,
14 "awaiting_registration": false,
15 "number": "437xxxxxxxxx",
16 "expires_at": "2017-06-25T08:21:41.795Z",
17 "channels_included_count": 2,
18 "created_at": "2017-06-25T08:21:41.795Z",
19 "dedicated_channels_count": 0,
20 "billing_cycles_count": null,
21 "emergency_enabled": false
22 },
23 "relationships": {
24 "did_group": {
25 "links": {
26 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/did_group",
27 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/did_group"
28 },
29 "data": {
30 "type": "did_groups",
31 "id": "d04b6466-3d98-4be1-aac5-93ee241f57ca"
32 }
33 },
34 "order": {
35 "links": {
36 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/order",
37 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/order"
38 }
39 },
40 "voice_in_trunk": {
41 "links": {
42 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/voice_in_trunk",
43 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/voice_in_trunk"
44 }
45 },
46 "voice_in_trunk_group": {
47 "links": {
48 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/voice_in_trunk_group",
49 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/voice_in_trunk_group"
50 }
51 },
52 "capacity_pool": {
53 "links": {
54 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/capacity_pool",
55 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/capacity_pool"
56 }
57 },
58 "shared_capacity_group": {
59 "links": {
60 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/shared_capacity_group",
61 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/shared_capacity_group"
62 }
63 },
64 "sms_trunk": {
65 "links": {
66 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/sms_trunk",
67 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/sms_trunk"
68 }
69 },
70 "sms_trunk_group": {
71 "links": {
72 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/sms_trunk_group",
73 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/sms_trunk_group"
74 }
75 },
76 "address_verification": {
77 "links": {
78 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/address_verification",
79 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/address_verification"
80 }
81 },
82 "emergency_calling_service": {
83 "links": {
84 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/emergency_calling_service",
85 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/emergency_calling_service"
86 }
87 },
88 "emergency_verification": {
89 "links": {
90 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/emergency_verification",
91 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/emergency_verification"
92 }
93 },
94 "identity": {
95 "links": {
96 "self": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/relationships/identity",
97 "related": "https://api.didww.com/v3/dids/2b1f91d7-8f7a-4933-b1e4-43bbe6aff89d/identity"
98 }
99 }
100 }
101 }
102 ],
103 "included": [
104 {
105 "id": "d04b6466-3d98-4be1-aac5-93ee241f57ca",
106 "type": "did_groups",
107 "attributes": {
108 "prefix": "721",
109 "features": [
110 "voice_in"
111 ],
112 "is_metered": false,
113 "area_name": "National",
114 "allow_additional_channels": true,
115 "service_restrictions": null,
116 "number_type": "national",
117 "is_demo": false
118 },
119 "relationships": {
120 "country": {
121 "links": {
122 "self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/country",
123 "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/country"
124 }
125 },
126 "city": {
127 "links": {
128 "self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/city",
129 "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/city"
130 }
131 },
132 "region": {
133 "links": {
134 "self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/region",
135 "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/region"
136 }
137 },
138 "stock_keeping_units": {
139 "links": {
140 "self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/stock_keeping_units",
141 "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/stock_keeping_units"
142 }
143 },
144 "address_requirement": {
145 "links": {
146 "self": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/relationships/address_requirement",
147 "related": "https://api.didww.com/v3/did_groups/d04b6466-3d98-4be1-aac5-93ee241f57ca/address_requirement"
148 }
149 }
150 },
151 "meta": {
152 "available_dids_enabled": false,
153 "needs_registration": false,
154 "is_available": true,
155 "total_count": 7
156 }
157 }
158 ],
159 "meta": {
160 "total_records": 1,
161 "api_version": "2026-11-19"
162 },
163 "links": {
164 "first": "https://api.didww.com/v3/dids?include=did_group&page%5Bnumber%5D=1&page%5Bsize%5D=50",
165 "last": "https://api.didww.com/v3/dids?include=did_group&page%5Bnumber%5D=1&page%5Bsize%5D=50"
166 }
167}
http
1GET /v3/dids?include=emergency_calling_service 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/dids?include=emergency_calling_service' -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": "ac40fb08-ac14-4a6c-8f20-fe650870c266",
8 "type": "dids",
9 "attributes": {
10 "blocked": false,
11 "capacity_limit": 1,
12 "description": "string",
13 "terminated": false,
14 "awaiting_registration": false,
15 "number": "437xxxxxxxxx",
16 "expires_at": "2017-06-25T08:21:41.795Z",
17 "channels_included_count": 2,
18 "created_at": "2017-06-25T08:21:41.795Z",
19 "dedicated_channels_count": 0,
20 "billing_cycles_count": null,
21 "emergency_enabled": true
22 },
23 "relationships": {
24 "did_group": {
25 "links": {
26 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/did_group",
27 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/did_group"
28 }
29 },
30 "order": {
31 "links": {
32 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/order",
33 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/order"
34 }
35 },
36 "voice_in_trunk": {
37 "links": {
38 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/voice_in_trunk",
39 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/voice_in_trunk"
40 }
41 },
42 "voice_in_trunk_group": {
43 "links": {
44 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/voice_in_trunk_group",
45 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/voice_in_trunk_group"
46 }
47 },
48 "capacity_pool": {
49 "links": {
50 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/capacity_pool",
51 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/capacity_pool"
52 }
53 },
54 "shared_capacity_group": {
55 "links": {
56 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/shared_capacity_group",
57 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/shared_capacity_group"
58 }
59 },
60 "sms_trunk": {
61 "links": {
62 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/sms_trunk",
63 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/sms_trunk"
64 }
65 },
66 "sms_trunk_group": {
67 "links": {
68 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/sms_trunk_group",
69 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/sms_trunk_group"
70 }
71 },
72 "address_verification": {
73 "links": {
74 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/address_verification",
75 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/address_verification"
76 }
77 },
78 "emergency_calling_service": {
79 "links": {
80 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/emergency_calling_service",
81 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/emergency_calling_service"
82 },
83 "data": {
84 "type": "emergency_calling_services",
85 "id": "7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c"
86 }
87 },
88 "emergency_verification": {
89 "links": {
90 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/emergency_verification",
91 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/emergency_verification"
92 }
93 },
94 "identity": {
95 "links": {
96 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/identity",
97 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/identity"
98 }
99 }
100 }
101 }
102 ],
103 "included": [
104 {
105 "id": "7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
106 "type": "emergency_calling_services",
107 "attributes": {
108 "number_type": "local",
109 "name": "E911 Service - New York Office",
110 "reference": "SHB-485120",
111 "status": "active",
112 "activated_at": "2026-01-15T10:30:00.000Z",
113 "canceled_at": null,
114 "renew_date": "2026-07-15",
115 "created_at": "2026-01-10T08:00:00.000Z"
116 },
117 "relationships": {
118 "country": {
119 "links": {
120 "self": "https://api.didww.com/v3/emergency_calling_services/7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c/relationships/country",
121 "related": "https://api.didww.com/v3/emergency_calling_services/7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c/country"
122 }
123 },
124 "order": {
125 "links": {
126 "self": "https://api.didww.com/v3/emergency_calling_services/7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c/relationships/order",
127 "related": "https://api.didww.com/v3/emergency_calling_services/7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c/order"
128 }
129 },
130 "emergency_requirement": {
131 "links": {
132 "self": "https://api.didww.com/v3/emergency_calling_services/7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c/relationships/emergency_requirement",
133 "related": "https://api.didww.com/v3/emergency_calling_services/7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c/emergency_requirement"
134 }
135 },
136 "emergency_verification": {
137 "links": {
138 "self": "https://api.didww.com/v3/emergency_calling_services/7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c/relationships/emergency_verification",
139 "related": "https://api.didww.com/v3/emergency_calling_services/7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c/emergency_verification"
140 }
141 },
142 "dids": {
143 "links": {
144 "self": "https://api.didww.com/v3/emergency_calling_services/7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c/relationships/dids",
145 "related": "https://api.didww.com/v3/emergency_calling_services/7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c/dids"
146 }
147 }
148 },
149 "meta": {
150 "setup_price": "0.0",
151 "monthly_price": "2.5"
152 }
153 }
154 ],
155 "meta": {
156 "total_records": 1,
157 "api_version": "2026-11-19"
158 },
159 "links": {
160 "first": "https://api.didww.com/v3/dids?include=emergency_calling_service&page%5Bnumber%5D=1&page%5Bsize%5D=50",
161 "last": "https://api.didww.com/v3/dids?include=emergency_calling_service&page%5Bnumber%5D=1&page%5Bsize%5D=50"
162 }
163}
http
1GET /v3/dids?include=identity 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/dids?include=identity' -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": "ac40fb08-ac14-4a6c-8f20-fe650870c266",
8 "type": "dids",
9 "attributes": {
10 "blocked": false,
11 "capacity_limit": 1,
12 "description": "string",
13 "terminated": false,
14 "awaiting_registration": false,
15 "number": "437xxxxxxxxx",
16 "expires_at": "2017-06-25T08:21:41.795Z",
17 "channels_included_count": 2,
18 "created_at": "2017-06-25T08:21:41.795Z",
19 "dedicated_channels_count": 0,
20 "billing_cycles_count": null,
21 "emergency_enabled": false
22 },
23 "relationships": {
24 "did_group": {
25 "links": {
26 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/did_group",
27 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/did_group"
28 }
29 },
30 "order": {
31 "links": {
32 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/order",
33 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/order"
34 }
35 },
36 "voice_in_trunk": {
37 "links": {
38 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/voice_in_trunk",
39 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/voice_in_trunk"
40 }
41 },
42 "voice_in_trunk_group": {
43 "links": {
44 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/voice_in_trunk_group",
45 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/voice_in_trunk_group"
46 }
47 },
48 "capacity_pool": {
49 "links": {
50 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/capacity_pool",
51 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/capacity_pool"
52 }
53 },
54 "shared_capacity_group": {
55 "links": {
56 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/shared_capacity_group",
57 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/shared_capacity_group"
58 }
59 },
60 "sms_trunk": {
61 "links": {
62 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/sms_trunk",
63 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/sms_trunk"
64 }
65 },
66 "sms_trunk_group": {
67 "links": {
68 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/sms_trunk_group",
69 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/sms_trunk_group"
70 }
71 },
72 "address_verification": {
73 "links": {
74 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/address_verification",
75 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/address_verification"
76 }
77 },
78 "emergency_calling_service": {
79 "links": {
80 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/emergency_calling_service",
81 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/emergency_calling_service"
82 }
83 },
84 "emergency_verification": {
85 "links": {
86 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/emergency_verification",
87 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/emergency_verification"
88 }
89 },
90 "identity": {
91 "links": {
92 "self": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/relationships/identity",
93 "related": "https://api.didww.com/v3/dids/ac40fb08-ac14-4a6c-8f20-fe650870c266/identity"
94 },
95 "data": {
96 "type": "identities",
97 "id": "9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41"
98 }
99 }
100 }
101 }
102 ],
103 "included": [
104 {
105 "id": "9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41",
106 "type": "identities",
107 "attributes": {
108 "first_name": "John",
109 "last_name": "Doe",
110 "phone_number": "1276813663",
111 "id_number": null,
112 "birth_date": "1985-02-10",
113 "company_name": null,
114 "company_website": null,
115 "company_reg_number": null,
116 "vat_id": null,
117 "description": null,
118 "personal_tax_id": null,
119 "identity_type": "personal",
120 "created_at": "2025-04-11T13:03:17.029Z",
121 "external_reference_id": null,
122 "verified": false,
123 "contact_email": "john.doe@example.com"
124 },
125 "relationships": {
126 "country": {
127 "links": {
128 "self": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/relationships/country",
129 "related": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/country"
130 }
131 },
132 "birth_country": {
133 "links": {
134 "self": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/relationships/birth_country",
135 "related": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/birth_country"
136 }
137 },
138 "proofs": {
139 "links": {
140 "self": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/relationships/proofs",
141 "related": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/proofs"
142 }
143 },
144 "addresses": {
145 "links": {
146 "self": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/relationships/addresses",
147 "related": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/addresses"
148 }
149 },
150 "permanent_documents": {
151 "links": {
152 "self": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/relationships/permanent_documents",
153 "related": "https://api.didww.com/v3/identities/9f1d6db1-2a8d-4c72-b7d6-8f3b2d7e6b41/permanent_documents"
154 }
155 }
156 }
157 }
158 ],
159 "meta": {
160 "total_records": 1,
161 "api_version": "2026-11-19"
162 },
163 "links": {
164 "first": "https://api.didww.com/v3/dids?include=identity&page%5Bnumber%5D=1&page%5Bsize%5D=50",
165 "last": "https://api.didww.com/v3/dids?include=identity&page%5Bnumber%5D=1&page%5Bsize%5D=50"
166 }
167}
http
1GET /v3/dids?filter%5Bsms_trunk.id%5D=b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34&include=sms_trunk 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/dids?filter%5Bsms_trunk.id%5D=b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34&include=sms_trunk' -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": "5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71",
8 "type": "dids",
9 "attributes": {
10 "blocked": false,
11 "capacity_limit": null,
12 "description": "Support line",
13 "terminated": false,
14 "awaiting_registration": false,
15 "number": "4420xxxxxxxx",
16 "expires_at": "2026-11-20T09:15:00.000Z",
17 "channels_included_count": 2,
18 "created_at": "2026-10-20T09:15:00.000Z",
19 "dedicated_channels_count": 0,
20 "billing_cycles_count": null,
21 "emergency_enabled": false
22 },
23 "relationships": {
24 "did_group": {
25 "links": {
26 "self": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/relationships/did_group",
27 "related": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/did_group"
28 }
29 },
30 "order": {
31 "links": {
32 "self": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/relationships/order",
33 "related": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/order"
34 }
35 },
36 "voice_in_trunk": {
37 "links": {
38 "self": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/relationships/voice_in_trunk",
39 "related": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/voice_in_trunk"
40 }
41 },
42 "voice_in_trunk_group": {
43 "links": {
44 "self": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/relationships/voice_in_trunk_group",
45 "related": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/voice_in_trunk_group"
46 }
47 },
48 "capacity_pool": {
49 "links": {
50 "self": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/relationships/capacity_pool",
51 "related": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/capacity_pool"
52 }
53 },
54 "shared_capacity_group": {
55 "links": {
56 "self": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/relationships/shared_capacity_group",
57 "related": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/shared_capacity_group"
58 }
59 },
60 "sms_trunk": {
61 "links": {
62 "self": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/relationships/sms_trunk",
63 "related": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/sms_trunk"
64 },
65 "data": {
66 "type": "sms_trunks",
67 "id": "b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34"
68 }
69 },
70 "sms_trunk_group": {
71 "links": {
72 "self": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/relationships/sms_trunk_group",
73 "related": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/sms_trunk_group"
74 }
75 },
76 "address_verification": {
77 "links": {
78 "self": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/relationships/address_verification",
79 "related": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/address_verification"
80 }
81 },
82 "emergency_calling_service": {
83 "links": {
84 "self": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/relationships/emergency_calling_service",
85 "related": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/emergency_calling_service"
86 }
87 },
88 "emergency_verification": {
89 "links": {
90 "self": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/relationships/emergency_verification",
91 "related": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/emergency_verification"
92 }
93 },
94 "identity": {
95 "links": {
96 "self": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/relationships/identity",
97 "related": "https://api.didww.com/v3/dids/5b8b1c8e-2f0d-4a57-9d1e-3c6f8a0b2e71/identity"
98 }
99 }
100 }
101 }
102 ],
103 "included": [
104 {
105 "id": "b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34",
106 "type": "sms_trunks",
107 "attributes": {
108 "name": "Support inbox",
109 "external_reference_id": null,
110 "blocked": false,
111 "priority": 100,
112 "allow_any_did_as_source": false,
113 "allow_in": true,
114 "allow_out": false,
115 "created_at": "2026-10-20T09:00:00.000Z",
116 "updated_at": "2026-10-20T09:00:00.000Z",
117 "configuration": {
118 "type": "sms_to_email",
119 "attributes": {
120 "send_to": "sms@example.com",
121 "subject": "New SMS",
122 "message": "New SMS received"
123 }
124 }
125 },
126 "relationships": {
127 "outgoing_dids": {
128 "links": {
129 "self": "https://api.didww.com/v3/sms_trunks/b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34/relationships/outgoing_dids",
130 "related": "https://api.didww.com/v3/sms_trunks/b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34/outgoing_dids"
131 }
132 },
133 "incoming_dids": {
134 "links": {
135 "self": "https://api.didww.com/v3/sms_trunks/b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34/relationships/incoming_dids",
136 "related": "https://api.didww.com/v3/sms_trunks/b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34/incoming_dids"
137 }
138 },
139 "sms_trunk_group": {
140 "links": {
141 "self": "https://api.didww.com/v3/sms_trunks/b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34/relationships/sms_trunk_group",
142 "related": "https://api.didww.com/v3/sms_trunks/b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34/sms_trunk_group"
143 }
144 },
145 "sender_id_verifications": {
146 "links": {
147 "self": "https://api.didww.com/v3/sms_trunks/b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34/relationships/sender_id_verifications",
148 "related": "https://api.didww.com/v3/sms_trunks/b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34/sender_id_verifications"
149 }
150 }
151 }
152 }
153 ],
154 "meta": {
155 "total_records": 1,
156 "api_version": "2026-11-19"
157 },
158 "links": {
159 "first": "https://api.didww.com/v3/dids?filter%5Bsms_trunk.id%5D=b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34&include=sms_trunk&page%5Bnumber%5D=1&page%5Bsize%5D=50",
160 "last": "https://api.didww.com/v3/dids?filter%5Bsms_trunk.id%5D=b3e1f6a2-7c4d-4e89-a0b5-2d9f8c1e6a34&include=sms_trunk&page%5Bnumber%5D=1&page%5Bsize%5D=50"
161 }
162}
Other Responses#
Code |
Success |
Description |
|---|---|---|
400 |
No |
|
401 |
No |
|
429 |
No |
The request budget of the account for the current window is spent ( |