# 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](shared-capacity-group-object.html).

### URI Query Parameters

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| include | `string` | No | [Inclusion](../../../specification/includes.html#api-includes) |
| filter[<filter\_name>] | `string` | No | [Filtering](../../../specification/filtering.html#api-filters) |
| fields[shared\_capacity\_groups] | `string` | No | [Sparse fieldsets](../../../specification/sparse-fieldsets.html#api-sparse-fieldsets) |
| sort | `string` | No | [Sorting](../../../specification/sorting.html#api-sorting) |
| page[number] | `integer` | No | [Page number](../../../specification/pagination.html#api-pagination). |
| page[size] | `integer` | No | [Page size](../../../specification/pagination.html#api-pagination). Pagination defaults to `50` records per page. The maximum is `100`. |

### Includes

| Value | Description |
| --- | --- |
| dids | [DID Object](../did/did-object.html#did-object-v35) |
| capacity\_pool | [Capacity Pool Object](../capacity-pool/capacity-pool-object.html#capacity-pool-object-v35) |

### 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

Simple RequestInclude DIDsInclude Capacity Pool

[[DIDWW-API-EXAMPLE-START]]

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}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/shared_capacity_groups?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?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    {
  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          "data": [
 29            {
 30              "type": "dids",
 31              "id": "44957076-778a-4802-b60c-d22db0cda284"
 32            }
 33          ]
 34        }
 35      }
 36    },
 37    {
 38      "id": "dd2e8844-6a79-4673-ba1c-c8a4913884cc",
 39      "type": "shared_capacity_groups",
 40      "attributes": {
 41        "name": "Metered group",
 42        "shared_channels_count": 0,
 43        "created_at": "2018-06-19T11:41:21.644Z",
 44        "external_reference_id": null,
 45        "metered_channels_count": 30
 46      },
 47      "relationships": {
 48        "capacity_pool": {
 49          "links": {
 50            "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/capacity_pool",
 51            "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/capacity_pool"
 52          }
 53        },
 54        "dids": {
 55          "links": {
 56            "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/dids",
 57            "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/dids"
 58          },
 59          "data": []
 60        }
 61      }
 62    }
 63  ],
 64  "included": [
 65    {
 66      "id": "44957076-778a-4802-b60c-d22db0cda284",
 67      "type": "dids",
 68      "attributes": {
 69        "blocked": false,
 70        "capacity_limit": 1,
 71        "description": "string",
 72        "terminated": false,
 73        "awaiting_registration": false,
 74        "number": "437xxxxxxxxx",
 75        "expires_at": "2017-06-25T08:21:41.795Z",
 76        "channels_included_count": 2,
 77        "created_at": "2017-06-25T08:21:41.795Z",
 78        "dedicated_channels_count": 0,
 79        "billing_cycles_count": null,
 80        "emergency_enabled": false
 81      },
 82      "relationships": {
 83        "did_group": {
 84          "links": {
 85            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/did_group",
 86            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/did_group"
 87          }
 88        },
 89        "order": {
 90          "links": {
 91            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/order",
 92            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/order"
 93          }
 94        },
 95        "voice_in_trunk": {
 96          "links": {
 97            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk",
 98            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk"
 99          }
100        },
101        "voice_in_trunk_group": {
102          "links": {
103            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk_group",
104            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk_group"
105          }
106        },
107        "capacity_pool": {
108          "links": {
109            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/capacity_pool",
110            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/capacity_pool"
111          }
112        },
113        "shared_capacity_group": {
114          "links": {
115            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/shared_capacity_group",
116            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/shared_capacity_group"
117          }
118        },
119        "sms_trunk": {
120          "links": {
121            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/sms_trunk",
122            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/sms_trunk"
123          }
124        },
125        "sms_trunk_group": {
126          "links": {
127            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/sms_trunk_group",
128            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/sms_trunk_group"
129          }
130        },
131        "address_verification": {
132          "links": {
133            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/address_verification",
134            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/address_verification"
135          }
136        },
137        "emergency_calling_service": {
138          "links": {
139            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_calling_service",
140            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_calling_service"
141          }
142        },
143        "emergency_verification": {
144          "links": {
145            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/emergency_verification",
146            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/emergency_verification"
147          }
148        },
149        "identity": {
150          "links": {
151            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/identity",
152            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/identity"
153          }
154        }
155      }
156    }
157  ],
158  "meta": {
159    "total_records": 2,
160    "api_version": "2026-11-19"
161  },
162  "links": {
163    "first": "https://api.didww.com/v3/shared_capacity_groups?include=dids&page%5Bnumber%5D=1&page%5Bsize%5D=50",
164    "last": "https://api.didww.com/v3/shared_capacity_groups?include=dids&page%5Bnumber%5D=1&page%5Bsize%5D=50"
165  }
166}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/shared_capacity_groups?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?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    {
  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          "data": {
 23            "type": "capacity_pools",
 24            "id": "b8db1d7c-f415-4530-a340-c774bcc1c55f"
 25          }
 26        },
 27        "dids": {
 28          "links": {
 29            "self": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/relationships/dids",
 30            "related": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/dids"
 31          }
 32        }
 33      }
 34    },
 35    {
 36      "id": "dd2e8844-6a79-4673-ba1c-c8a4913884cc",
 37      "type": "shared_capacity_groups",
 38      "attributes": {
 39        "name": "Metered group",
 40        "shared_channels_count": 0,
 41        "created_at": "2018-06-19T11:41:21.644Z",
 42        "external_reference_id": null,
 43        "metered_channels_count": 30
 44      },
 45      "relationships": {
 46        "capacity_pool": {
 47          "links": {
 48            "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/capacity_pool",
 49            "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/capacity_pool"
 50          },
 51          "data": {
 52            "type": "capacity_pools",
 53            "id": "b8db1d7c-f415-4530-a340-c774bcc1c55f"
 54          }
 55        },
 56        "dids": {
 57          "links": {
 58            "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/dids",
 59            "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/dids"
 60          }
 61        }
 62      }
 63    }
 64  ],
 65  "included": [
 66    {
 67      "id": "b8db1d7c-f415-4530-a340-c774bcc1c55f",
 68      "type": "capacity_pools",
 69      "attributes": {
 70        "name": "Extended",
 71        "renew_date": "2018-07-21",
 72        "total_channels_count": 10,
 73        "assigned_channels_count": 6,
 74        "minimum_limit": 5,
 75        "minimum_qty_per_order": 1,
 76        "setup_price": "0.0",
 77        "monthly_price": "25.0",
 78        "metered_rate": "0.02"
 79      },
 80      "relationships": {
 81        "countries": {
 82          "links": {
 83            "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/countries",
 84            "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/countries"
 85          }
 86        },
 87        "shared_capacity_groups": {
 88          "links": {
 89            "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/shared_capacity_groups",
 90            "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/shared_capacity_groups"
 91          }
 92        },
 93        "qty_based_pricings": {
 94          "links": {
 95            "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/qty_based_pricings",
 96            "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/qty_based_pricings"
 97          }
 98        }
 99      }
100    }
101  ],
102  "meta": {
103    "total_records": 2,
104    "api_version": "2026-11-19"
105  },
106  "links": {
107    "first": "https://api.didww.com/v3/shared_capacity_groups?include=capacity_pool&page%5Bnumber%5D=1&page%5Bsize%5D=50",
108    "last": "https://api.didww.com/v3/shared_capacity_groups?include=capacity_pool&page%5Bnumber%5D=1&page%5Bsize%5D=50"
109  }
110}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 400 | No | [Bad Request](../../../specification/errors/index.html#api-bad-request) |
| 401 | No | [Unauthorized](../../authentication.html#authentication-v35) |
| 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. |
