---
title: "GET /v1/projects/{projectsId}/locations/{locationsId}/capacityCommitments"
method: GET
path: "/v1/projects/{projectsId}/locations/{locationsId}/capacityCommitments"
tags: ["projects"]
---

# GET /v1/projects/{projectsId}/locations/{locationsId}/capacityCommitments

`GET /v1/projects/{projectsId}/locations/{locationsId}/capacityCommitments`

## Request

- Base URL: `https://bigqueryreservation.googleapis.com`
- URL: `https://bigqueryreservation.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/capacityCommitments`
- Auth: one of:
  - OAuth 2 and OAuth 2
    - Implicit: `https://accounts.google.com/o/oauth2/auth`
    - Scopes: `https://www.googleapis.com/auth/bigquery`
    - Authorization code: `https://accounts.google.com/o/oauth2/auth`
    - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/bigquery`
  - OAuth 2 and OAuth 2
    - Implicit: `https://accounts.google.com/o/oauth2/auth`
    - Scopes: `https://www.googleapis.com/auth/cloud-platform`
    - Authorization code: `https://accounts.google.com/o/oauth2/auth`
    - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform`

Lists all the capacity commitments for the admin project.

## Path parameters

- `projectsId` string, required
- `locationsId` string, required

## Query parameters

- `pageSize` integer
- `pageToken` string

## Response `200`

Successful response

- ListCapacityCommitmentsResponse: The response for ReservationService.ListCapacityCommitments.
  - `capacityCommitments` CapacityCommitment[]: List of capacity commitments visible to the user.
    - `commitmentEndTime` string, google-datetime: Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after renewal, commitment_end_time is the time the renewed commitment expires. So itwould be at a time after commitment_start_time + committed period, because we don't change commitment_start_time ,
    - `commitmentStartTime` string, google-datetime: Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after the commitment is renewed, commitment_start_time won't be changed. It refers to the start time of the original commitment.
    - `edition` 'EDITION_UNSPECIFIED' | 'STANDARD' | 'ENTERPRISE' | 'ENTERPRISE_PLUS': Optional. Edition of the capacity commitment.
    - `failureStatus` Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
      - `code` integer: The status code, which should be an enum value of google.rpc.Code.
      - `details` object[]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
      - `message` string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    - `isFlatRate` boolean: Output only. If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment.
    - `multiRegionAuxiliary` boolean: Applicable only for commitments located within one of the BigQuery multi-regions (US or EU). If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.
    - `name` string: Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123` The commitment_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
    - `plan` 'COMMITMENT_PLAN_UNSPECIFIED' | 'FLEX' | 'FLEX_FLAT_RATE' | 'TRIAL' | 'MONTHLY' | 'MONTHLY_FLAT_RATE' | 'ANNUAL' | 'ANNUAL_FLAT_RATE' | 'THREE_YEAR' | 'NONE': Optional. Capacity commitment commitment plan.
    - `renewalPlan` 'COMMITMENT_PLAN_UNSPECIFIED' | 'FLEX' | 'FLEX_FLAT_RATE' | 'TRIAL' | 'MONTHLY' | 'MONTHLY_FLAT_RATE' | 'ANNUAL' | 'ANNUAL_FLAT_RATE' | 'THREE_YEAR' | 'NONE': Optional. The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.
    - `slotCount` string, int64: Optional. Number of slots in this commitment.
    - `state` 'STATE_UNSPECIFIED' | 'PENDING' | 'ACTIVE' | 'FAILED': Output only. State of the commitment.
  - `nextPageToken` string: Token to retrieve the next page of results, or empty if there are no more results in the list.

## Changes

- **2026-11-03** `a802531c2771`: 4 info
  - the security scope `https://www.googleapis.com/auth/bigquery` was added to the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/bigquery` was added to the endpoint's security scheme `Oauth2c`
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/cloud-platform` was removed from the endpoint's security scheme `Oauth2c`

[Operation history](https://skmtc.dev/google/apis/bigqueryreservation/changes/v1/projects/:projectsId/locations/:locationsId/capacityCommitments/get.md)

---

[API](https://skmtc.dev/google/apis/bigqueryreservation.md) - [All operations](https://skmtc.dev/google/apis/bigqueryreservation/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/bigqueryreservation/revisions/a802531c2771?raw)