# Get Capacity Pools

Returns a list of Capacity Pools.

## Request

HTTP Method: `GET`

URI Path: `/v3/capacity_pools`

Note

For all returned data attributes, see [Capacity Pool Object](capacity-pool-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[capacity\_pools] | `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 |
| --- | --- |
| countries | [Country Object](../../coverage-resources/countries/country-object.html#country-object-v35) |
| shared\_capacity\_groups | [Shared Capacity Group Object](../shared-capacity-group/shared-capacity-group-object.html#shared-capacity-group-object-v35) |
| qty\_based\_pricings | [Quantity Based Price Object](../../common-definitions/index.html#quantity-based-price-object-v35) |

### Filters

| Filter Name | Type | Allow Blank | Allow Array | Filters by: |
| --- | --- | --- | --- | --- |
| id | `string` | No | Yes | Capacity Pool `id` field. |
| name | `string` | No | No | Capacity Pool `name` field. |
| country.id | `string` | No | Yes | The `id` field of the Capacity Pool's `countries` relationship. |
| has\_unassigned\_channels | `boolean` | No | No | Indicates whether the Capacity Pool has unassigned channels available. |

### Sorting

| Value | Sorts by |
| --- | --- |
| name | The `name` field. |
| renew\_date | The `renew_date` field. |
| total\_channels\_count | The `total_channels_count` field. |
| assigned\_channels\_count | The `assigned_channels_count` field. |
| minimum\_limit | The `minimum_limit` field. |
| minimum\_qty\_per\_order | The `minimum_qty_per_order` field. |
| setup\_price | The `setup_price` field. |
| monthly\_price | The `monthly_price` field. |
| metered\_rate | The `metered_rate` field. |

## Examples

Simple RequestInclude CountriesInclude Shared Capacity Groups

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/capacity_pools 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/capacity_pools -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": "ca1315c5-1915-4fc7-9441-de78e1f38ef9",
 8      "type": "capacity_pools",
 9      "attributes": {
10        "name": "Extended",
11        "renew_date": "2018-07-21",
12        "total_channels_count": 136,
13        "assigned_channels_count": 136,
14        "minimum_limit": 0,
15        "minimum_qty_per_order": 1,
16        "setup_price": "25.0",
17        "monthly_price": "25.0",
18        "metered_rate": "0.02"
19      },
20      "relationships": {
21        "countries": {
22          "links": {
23            "self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/countries",
24            "related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/countries"
25          }
26        },
27        "shared_capacity_groups": {
28          "links": {
29            "self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/shared_capacity_groups",
30            "related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/shared_capacity_groups"
31          }
32        },
33        "qty_based_pricings": {
34          "links": {
35            "self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/qty_based_pricings",
36            "related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/qty_based_pricings"
37          }
38        }
39      }
40    },
41    {
42      "id": "daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d",
43      "type": "capacity_pools",
44      "attributes": {
45        "name": "Standard",
46        "renew_date": "2018-07-21",
47        "total_channels_count": 2,
48        "assigned_channels_count": 2,
49        "minimum_limit": 0,
50        "minimum_qty_per_order": 1,
51        "setup_price": "15.0",
52        "monthly_price": "15.0",
53        "metered_rate": "0.01"
54      },
55      "relationships": {
56        "countries": {
57          "links": {
58            "self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/countries",
59            "related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/countries"
60          }
61        },
62        "shared_capacity_groups": {
63          "links": {
64            "self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/shared_capacity_groups",
65            "related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/shared_capacity_groups"
66          }
67        },
68        "qty_based_pricings": {
69          "links": {
70            "self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/qty_based_pricings",
71            "related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/qty_based_pricings"
72          }
73        }
74      }
75    }
76  ],
77  "meta": {
78    "total_records": 2,
79    "api_version": "2026-11-19"
80  },
81  "links": {
82    "first": "https://api.didww.com/v3/capacity_pools?page%5Bnumber%5D=1&page%5Bsize%5D=50",
83    "last": "https://api.didww.com/v3/capacity_pools?page%5Bnumber%5D=1&page%5Bsize%5D=50"
84  }
85}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/capacity_pools?include=countries 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/capacity_pools?include=countries' -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": "ca1315c5-1915-4fc7-9441-de78e1f38ef9",
  8      "type": "capacity_pools",
  9      "attributes": {
 10        "name": "Extended",
 11        "renew_date": "2018-07-21",
 12        "total_channels_count": 136,
 13        "assigned_channels_count": 136,
 14        "minimum_limit": 0,
 15        "minimum_qty_per_order": 1,
 16        "setup_price": "25.0",
 17        "monthly_price": "25.0",
 18        "metered_rate": "0.02"
 19      },
 20      "relationships": {
 21        "countries": {
 22          "links": {
 23            "self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/countries",
 24            "related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/countries"
 25          },
 26          "data": [
 27            {
 28              "type": "countries",
 29              "id": "7eda11bb-0e66-4146-98e7-57a5281f56c8"
 30            }
 31          ]
 32        },
 33        "shared_capacity_groups": {
 34          "links": {
 35            "self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/shared_capacity_groups",
 36            "related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/shared_capacity_groups"
 37          }
 38        },
 39        "qty_based_pricings": {
 40          "links": {
 41            "self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/qty_based_pricings",
 42            "related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/qty_based_pricings"
 43          }
 44        }
 45      }
 46    },
 47    {
 48      "id": "daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d",
 49      "type": "capacity_pools",
 50      "attributes": {
 51        "name": "Standard",
 52        "renew_date": "2018-07-21",
 53        "total_channels_count": 2,
 54        "assigned_channels_count": 2,
 55        "minimum_limit": 0,
 56        "minimum_qty_per_order": 1,
 57        "setup_price": "15.0",
 58        "monthly_price": "15.0",
 59        "metered_rate": "0.01"
 60      },
 61      "relationships": {
 62        "countries": {
 63          "links": {
 64            "self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/countries",
 65            "related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/countries"
 66          },
 67          "data": [
 68            {
 69              "type": "countries",
 70              "id": "1f6fc2bd-f081-4202-9b1a-d9cb88d942b9"
 71            }
 72          ]
 73        },
 74        "shared_capacity_groups": {
 75          "links": {
 76            "self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/shared_capacity_groups",
 77            "related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/shared_capacity_groups"
 78          }
 79        },
 80        "qty_based_pricings": {
 81          "links": {
 82            "self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/qty_based_pricings",
 83            "related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/qty_based_pricings"
 84          }
 85        }
 86      }
 87    }
 88  ],
 89  "included": [
 90    {
 91      "id": "7eda11bb-0e66-4146-98e7-57a5281f56c8",
 92      "type": "countries",
 93      "attributes": {
 94        "name": "United Kingdom",
 95        "prefix": "44",
 96        "iso": "GB"
 97      },
 98      "relationships": {
 99        "regions": {
100          "links": {
101            "self": "https://api.didww.com/v3/countries/7eda11bb-0e66-4146-98e7-57a5281f56c8/relationships/regions",
102            "related": "https://api.didww.com/v3/countries/7eda11bb-0e66-4146-98e7-57a5281f56c8/regions"
103          }
104        }
105      }
106    },
107    {
108      "id": "1f6fc2bd-f081-4202-9b1a-d9cb88d942b9",
109      "type": "countries",
110      "attributes": {
111        "name": "United States",
112        "prefix": "1",
113        "iso": "US"
114      },
115      "relationships": {
116        "regions": {
117          "links": {
118            "self": "https://api.didww.com/v3/countries/1f6fc2bd-f081-4202-9b1a-d9cb88d942b9/relationships/regions",
119            "related": "https://api.didww.com/v3/countries/1f6fc2bd-f081-4202-9b1a-d9cb88d942b9/regions"
120          }
121        }
122      }
123    }
124  ],
125  "meta": {
126    "total_records": 2,
127    "api_version": "2026-11-19"
128  },
129  "links": {
130    "first": "https://api.didww.com/v3/capacity_pools?include=countries&page%5Bnumber%5D=1&page%5Bsize%5D=50",
131    "last": "https://api.didww.com/v3/capacity_pools?include=countries&page%5Bnumber%5D=1&page%5Bsize%5D=50"
132  }
133}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/capacity_pools?include=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/capacity_pools?include=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": "ca1315c5-1915-4fc7-9441-de78e1f38ef9",
  8      "type": "capacity_pools",
  9      "attributes": {
 10        "name": "Extended",
 11        "renew_date": "2018-07-21",
 12        "total_channels_count": 136,
 13        "assigned_channels_count": 136,
 14        "minimum_limit": 0,
 15        "minimum_qty_per_order": 1,
 16        "setup_price": "25.0",
 17        "monthly_price": "25.0",
 18        "metered_rate": "0.02"
 19      },
 20      "relationships": {
 21        "countries": {
 22          "links": {
 23            "self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/countries",
 24            "related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/countries"
 25          }
 26        },
 27        "shared_capacity_groups": {
 28          "links": {
 29            "self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/shared_capacity_groups",
 30            "related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/shared_capacity_groups"
 31          },
 32          "data": [
 33            {
 34              "type": "shared_capacity_groups",
 35              "id": "dd2e8844-6a79-4673-ba1c-c8a4913884cc"
 36            }
 37          ]
 38        },
 39        "qty_based_pricings": {
 40          "links": {
 41            "self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/qty_based_pricings",
 42            "related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/qty_based_pricings"
 43          }
 44        }
 45      }
 46    },
 47    {
 48      "id": "daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d",
 49      "type": "capacity_pools",
 50      "attributes": {
 51        "name": "Standard",
 52        "renew_date": "2018-07-21",
 53        "total_channels_count": 2,
 54        "assigned_channels_count": 2,
 55        "minimum_limit": 0,
 56        "minimum_qty_per_order": 1,
 57        "setup_price": "15.0",
 58        "monthly_price": "15.0",
 59        "metered_rate": "0.01"
 60      },
 61      "relationships": {
 62        "countries": {
 63          "links": {
 64            "self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/countries",
 65            "related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/countries"
 66          }
 67        },
 68        "shared_capacity_groups": {
 69          "links": {
 70            "self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/shared_capacity_groups",
 71            "related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/shared_capacity_groups"
 72          },
 73          "data": []
 74        },
 75        "qty_based_pricings": {
 76          "links": {
 77            "self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/qty_based_pricings",
 78            "related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/qty_based_pricings"
 79          }
 80        }
 81      }
 82    }
 83  ],
 84  "included": [
 85    {
 86      "id": "dd2e8844-6a79-4673-ba1c-c8a4913884cc",
 87      "type": "shared_capacity_groups",
 88      "attributes": {
 89        "name": "Sample group",
 90        "shared_channels_count": 0,
 91        "created_at": "2018-06-19T11:41:21.644Z",
 92        "external_reference_id": null,
 93        "metered_channels_count": 30
 94      },
 95      "relationships": {
 96        "capacity_pool": {
 97          "links": {
 98            "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/capacity_pool",
 99            "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/capacity_pool"
100          }
101        },
102        "dids": {
103          "links": {
104            "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/dids",
105            "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/dids"
106          }
107        }
108      }
109    }
110  ],
111  "meta": {
112    "total_records": 2,
113    "api_version": "2026-11-19"
114  },
115  "links": {
116    "first": "https://api.didww.com/v3/capacity_pools?include=shared_capacity_groups&page%5Bnumber%5D=1&page%5Bsize%5D=50",
117    "last": "https://api.didww.com/v3/capacity_pools?include=shared_capacity_groups&page%5Bnumber%5D=1&page%5Bsize%5D=50"
118  }
119}
```

[[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. |
