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

### Includes

| Value | Description |
| --- | --- |
| dids | [A list of Shared Capacity Group objects](../did/did-object.html#did-object-v34) |
| capacity\_pool | [Capacity Pool Object](../capacity-pool/capacity-pool-object.html#capacity-pool-object-v34) |

### Filters

| Filter Name | Type | Allow Blank | Allow Array | Filters by: |
| --- | --- | --- | --- | --- |
| 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. |

## Examples

Simple RequestInclude DIDsInclude Capacity Pool

[[DIDWW-API-EXAMPLE-START]]

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

```
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "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",
        "external_reference_id": null,
        "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"
          }
        },
        "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",
        "external_reference_id": null,
        "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"
          }
        }
      }
    }
  ],
  "meta": {
    "total_records": 2
  },
  "links": {
    "first": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
GET /v3/shared_capacity_groups?include=dids 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?include=dids' -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
```

response

```
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "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",
        "external_reference_id": null,
        "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"
          }
        },
        "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"
          },
          "data": [
            {
              "type": "dids",
              "id": "44957076-778a-4802-b60c-d22db0cda284"
            }
          ]
        }
      }
    },
    {
      "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",
        "external_reference_id": null,
        "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": "44957076-778a-4802-b60c-d22db0cda284",
      "type": "dids",
      "attributes": {
        "blocked": false,
        "capacity_limit": 1,
        "description": "string",
        "terminated": false,
        "awaiting_registration": false,
        "number": "437xxxxxxxxx",
        "expires_at": "2017-06-25T08:21:41.795Z",
        "channels_included_count": 2,
        "created_at": "2017-06-25T08:21:41.795Z",
        "dedicated_channels_count": 0
      },
      "relationships": {
        "did_group": {
          "links": {
            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/did_group",
            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/did_group"
          }
        },
        "order": {
          "links": {
            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/order",
            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/order"
          }
        },
        "voice_in_trunk": {
          "links": {
            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk",
            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk"
          }
        },
        "voice_in_trunk_group": {
          "links": {
            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/voice_in_trunk_group",
            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/voice_in_trunk_group"
          }
        },
        "capacity_pool": {
          "links": {
            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/capacity_pool",
            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/capacity_pool"
          }
        },
        "shared_capacity_group": {
          "links": {
            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/shared_capacity_group",
            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/shared_capacity_group"
          }
        }
      }
    }
  ],
  "meta": {
    "total_records": 2
  },
  "links": {
    "first": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
GET /v3/shared_capacity_groups?include=capacity_pool 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?include=capacity_pool' -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
```

response

```
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "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",
        "external_reference_id": null,
        "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",
        "external_reference_id": null,
        "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
  },
  "links": {
    "first": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 401 | No | [Unauthorized](../../../configuration.html#api-key) |

On this page