Get Shared Capacity Groups
GET https://{{host}}/v3/shared_capacity_groups
Returns a collection of Shared Capacity Groups.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include | null | Comma-separated values of include parameter. | |
The response will include a top-level object relationships with associated data under the appropriate resource key. | |||
| Details in Inclusion of Related Resources Article. |
Allowed values:
dids - a list of DID Object
capacity_pool - Capacity Pool Object
*** |
| filter[name] | null | | string - Filters by Shared Capacity Group name field.
-
Allow blank - Yes.
-
Allow array - Yes. | |
filter[capacity_pool.id]| null | |string- Filters by the capacity_pool.id field. -
Allow blank - Yes.
-
Allow array - Yes. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
Content-Type | string | ||
Api-Key | string |
RESPONSES
status: OK
{"data":[{"id":"8a581244-de83-4c46-ac0a-32659279169e","type":"shared_capacity_groups","attributes":{"name":"Mixed group","shared_channels_count":3,"created_at":"2018-06-20T08:48:47.811Z","metered_channels_count":5},"relationships":{"capacity_pool":{"links":{"self":"https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/relationships/capacity_pool","related":"https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/capacity_pool"},"data":{"type":"capacity_pools","id":"b8db1d7c-f415-4530-a340-c774bcc1c55f"}},"dids":{"links":{"self":"https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/relationships/dids","related":"https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/dids"}}}},{"id":"dd2e8844-6a79-4673-ba1c-c8a4913884cc","type":"shared_capacity_groups","attributes":{"name":"Metered group","shared_channels_count":0,"created_at":"2018-06-19T11:41:21.644Z","metered_channels_count":30},"relationships":{"capacity_pool":{"links":{"self":"https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/capacity_pool","related":"https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/capacity_pool"}},"dids":{"links":{"self":"https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/dids","related":"https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/dids"}}}}],"included":[{"id":"b8db1d7c-f415-4530-a340-c774bcc1c55f","type":"capacity_pools","attributes":{"name":"Extended","renew_date":"2018-07-21","total_channels_count":10,"unassigned_channels_count":4,"assigned_channels_count":6,"minimum_limit":5,"minimum_qty_per_order":1,"nrc":"0.0","mrc":"25.0","metered_rate":"0.02"},"relationships":{"countries":{"links":{"self":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/countries","related":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/countries"}},"shared_capacity_groups":{"links":{"self":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/shared_capacity_groups","related":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/shared_capacity_groups"}},"qty_based_pricings":{"links":{"self":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/qty_based_pricings","related":"https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/qty_based_pricings"}}}}],"meta":{"total_records":2,"api_version":"2022-05-10"},"links":{"first":"https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1\u0026page%5Bsize%5D=50","last":"https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1\u0026page%5Bsize%5D=50"}}