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

string

Yes

Unique ID number allocated to this Shared Capacity Group.

include

string

No

Inclusion

Includes#

Value

Description

dids

DID Object

capacity_pool

Capacity Pool Object

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}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized

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.