Get Shared Capacity Groups

Description

Returns a collection of Shared Capacity Groups.

Request

HTTP Method: GET

URI Path: /v3/shared_capacity_groups

URI Query Parameters:

Name	Type	Is Required?	Description
filter[<filter_name>]	string	Optional	Filtering
include	string	Optional	Inclusion
sort	string	Optional	Sorting

Includes:

Value	Description
dids	A list of Shared Capacity Group objects
capacity_pool	Capacity Pool Object

Filters:

Filter Name	Type	Allow Blank	Allow Array	Filters by:
name	string	Yes	Yes	Shared Capacity Group name field.
capacity_pool.id	string	Yes	Yes	The capacity_pool.id field.

Fielding:

Value	Returns:
name	The name attribute.
shared_channels_count	The shared_channels_count attribute.
metered_channels_count	The metered_channels_count attribute.
created_at	The created_at attribute.

Examples

Simple RequestInclude DIDsInclude Capacity Pool

http

GET /v3/shared_capacity_groups HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -i -X GET https://api.didww.com/v3/shared_capacity_groups -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

GET /v3/shared_capacity_groups HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized