Get Shared Capacity Group#
Returns a single Channels Group.
Request#
HTTP Method: GET
URI Path: /v3/shared_capacity_groups/{id}
Note
For all returned data attributes, see Shared Capacity Group Object.
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID number allocated to this Shared Capacity Group. |
include |
|
No |
Includes#
Value |
Description |
|---|---|
dids |
|
capacity_pool |
Examples#
http
1GET /v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e 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/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e -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": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
7 "type": "shared_capacity_groups",
8 "attributes": {
9 "name": "Sample group",
10 "shared_channels_count": 3,
11 "created_at": "2018-06-19T11:41:21.644Z",
12 "external_reference_id": null,
13 "metered_channels_count": 5
14 },
15 "relationships": {
16 "capacity_pool": {
17 "links": {
18 "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/capacity_pool",
19 "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/capacity_pool"
20 }
21 },
22 "dids": {
23 "links": {
24 "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/dids",
25 "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/dids"
26 }
27 }
28 }
29 },
30 "meta": {
31 "api_version": "2026-11-19"
32 }
33}
http
1GET /v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e?include=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/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e?include=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 "id": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
7 "type": "shared_capacity_groups",
8 "attributes": {
9 "name": "Sample group",
10 "shared_channels_count": 3,
11 "created_at": "2018-06-19T11:41:21.644Z",
12 "external_reference_id": null,
13 "metered_channels_count": 5
14 },
15 "relationships": {
16 "capacity_pool": {
17 "links": {
18 "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/capacity_pool",
19 "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/capacity_pool"
20 }
21 },
22 "dids": {
23 "links": {
24 "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/dids",
25 "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/dids"
26 },
27 "data": [
28 {
29 "type": "dids",
30 "id": "44957076-778a-4802-b60c-d22db0cda284"
31 }
32 ]
33 }
34 }
35 },
36 "included": [
37 {
38 "id": "44957076-778a-4802-b60c-d22db0cda284",
39 "type": "dids",
40 "attributes": {
41 "blocked": false,
42 "capacity_limit": 1,
43 "description": "string",
44 "terminated": false,
45 "awaiting_registration": false,
46 "number": "437xxxxxxxxx",
47 "expires_at": "2017-06-25T08:21:41.795Z",
48 "channels_included_count": 2,
49 "created_at": "2017-06-25T08:21:41.795Z",
50 "dedicated_channels_count": 0,
51 "billing_cycles_count": null,
52 "emergency_enabled": false
53 },
54 "relationships": {
55 "did_group": {
56 "links": {
57 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/did_group",
58 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/did_group"
59 }
60 },
61 "order": {
62 "links": {
63 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/order",
64 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/order"
65 }
66 },
67 "voice_in_trunk": {
68 "links": {
69 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk",
70 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk"
71 }
72 },
73 "voice_in_trunk_group": {
74 "links": {
75 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk_group",
76 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk_group"
77 }
78 },
79 "capacity_pool": {
80 "links": {
81 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/capacity_pool",
82 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/capacity_pool"
83 }
84 },
85 "shared_capacity_group": {
86 "links": {
87 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/shared_capacity_group",
88 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/shared_capacity_group"
89 }
90 },
91 "sms_trunk": {
92 "links": {
93 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/sms_trunk",
94 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/sms_trunk"
95 }
96 },
97 "sms_trunk_group": {
98 "links": {
99 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/sms_trunk_group",
100 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/sms_trunk_group"
101 }
102 },
103 "address_verification": {
104 "links": {
105 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/address_verification",
106 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/address_verification"
107 }
108 },
109 "emergency_calling_service": {
110 "links": {
111 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_calling_service",
112 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_calling_service"
113 }
114 },
115 "emergency_verification": {
116 "links": {
117 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_verification",
118 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_verification"
119 }
120 },
121 "identity": {
122 "links": {
123 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/identity",
124 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/identity"
125 }
126 }
127 }
128 }
129 ],
130 "meta": {
131 "api_version": "2026-11-19"
132 }
133}
http
1GET /v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e?include=capacity_pool 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/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e?include=capacity_pool' -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": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
7 "type": "shared_capacity_groups",
8 "attributes": {
9 "name": "Sample group",
10 "shared_channels_count": 3,
11 "created_at": "2018-06-19T11:41:21.644Z",
12 "external_reference_id": null,
13 "metered_channels_count": 5
14 },
15 "relationships": {
16 "capacity_pool": {
17 "links": {
18 "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/capacity_pool",
19 "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/capacity_pool"
20 },
21 "data": {
22 "type": "capacity_pools",
23 "id": "b8db1d7c-f415-4530-a340-c774bcc1c55f"
24 }
25 },
26 "dids": {
27 "links": {
28 "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/dids",
29 "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/dids"
30 }
31 }
32 }
33 },
34 "included": [
35 {
36 "id": "b8db1d7c-f415-4530-a340-c774bcc1c55f",
37 "type": "capacity_pools",
38 "attributes": {
39 "name": "Extended",
40 "renew_date": "2018-07-21",
41 "total_channels_count": 10,
42 "assigned_channels_count": 6,
43 "minimum_limit": 5,
44 "minimum_qty_per_order": 1,
45 "setup_price": "0.0",
46 "monthly_price": "25.0",
47 "metered_rate": "0.02"
48 },
49 "relationships": {
50 "countries": {
51 "links": {
52 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/countries",
53 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/countries"
54 }
55 },
56 "shared_capacity_groups": {
57 "links": {
58 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/shared_capacity_groups",
59 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/shared_capacity_groups"
60 }
61 },
62 "qty_based_pricings": {
63 "links": {
64 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/qty_based_pricings",
65 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/qty_based_pricings"
66 }
67 }
68 }
69 }
70 ],
71 "meta": {
72 "api_version": "2026-11-19"
73 }
74}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |
|
429 |
No |
The request budget of the account for the current window is spent ( |