Get Shared Capacity Groups#

Returns a collection of Shared Capacity Groups.

Request#

HTTP Method: GET

URI Path: /v3/shared_capacity_groups

Note

For all returned data attributes, see Shared Capacity Group Object.

URI Query Parameters#

Name

Type

Is Required?

Description

include

string

No

Inclusion

filter[<filter_name>]

string

No

Filtering

fields[shared_capacity_groups]

string

No

Sparse fieldsets

sort

string

No

Sorting

page[number]

integer

No

Page number.

page[size]

integer

No

Page size. Pagination defaults to 50 records per page. The maximum is 100.

Includes#

Value

Description

dids

DID Object

capacity_pool

Capacity Pool Object

Filters#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

Shared Capacity Group id field.

name

string

Yes

Yes

Shared Capacity Group name field.

external_reference_id

string

No

No

The external_reference_id field.

capacity_pool.id

string

Yes

Yes

The capacity_pool.id field.

Sorting#

Value

Sorts by:

name

The name field.

external_reference_id

The external_reference_id field.

shared_channels_count

The shared_channels_count field.

metered_channels_count

The metered_channels_count field.

created_at

The created_at field.

Prefix a value with - to sort in descending order.

Examples#

http

1GET /v3/shared_capacity_groups 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 -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": "8a581244-de83-4c46-ac0a-32659279169e",
 8      "type": "shared_capacity_groups",
 9      "attributes": {
10        "name": "Mixed group",
11        "shared_channels_count": 3,
12        "created_at": "2018-06-20T08:48:47.811Z",
13        "external_reference_id": null,
14        "metered_channels_count": 5
15      },
16      "relationships": {
17        "capacity_pool": {
18          "links": {
19            "self": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/relationships/capacity_pool",
20            "related": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/capacity_pool"
21          }
22        },
23        "dids": {
24          "links": {
25            "self": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/relationships/dids",
26            "related": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/dids"
27          }
28        }
29      }
30    },
31    {
32      "id": "dd2e8844-6a79-4673-ba1c-c8a4913884cc",
33      "type": "shared_capacity_groups",
34      "attributes": {
35        "name": "Metered group",
36        "shared_channels_count": 0,
37        "created_at": "2018-06-19T11:41:21.644Z",
38        "external_reference_id": null,
39        "metered_channels_count": 30
40      },
41      "relationships": {
42        "capacity_pool": {
43          "links": {
44            "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/capacity_pool",
45            "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/capacity_pool"
46          }
47        },
48        "dids": {
49          "links": {
50            "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/dids",
51            "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/dids"
52          }
53        }
54      }
55    }
56  ],
57  "meta": {
58    "total_records": 2,
59    "api_version": "2026-11-19"
60  },
61  "links": {
62    "first": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
63    "last": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
64  }
65}

Other Responses#

Code

Success

Description

400

No

Bad Request

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.