Returns a list of the capacity plans that are in the parent parameter and match your specified filters. (The maximum list length is limited by the pageSize parameter.)
HTTP request
GET https://capacityplanner.googleapis.com/v1beta/{parent=organizations/*}/capacityPlans:query
Required. The parent resource container. Format: projects/{project} or folders/{folder} or organizations/{organization}
Query parameters
Parameters
pageSize
integer
Optional. The maximum number of plans to return per page. The service may return fewer than this value. If unspecified, the server will use a sensible default. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken
string
Optional. A page token, received from a previous capacityPlans.query call. Provide this to retrieve the subsequent page.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[],[],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n\nReturns a list of the capacity plans that are in the parent parameter and match your specified filters. (The maximum list length is limited by the pageSize parameter.)\n\nHTTP request\n\n`GET https://capacityplanner.googleapis.com/v1beta/{parent=organizations/*}/capacityPlans:query`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent resource container. Format: projects/{project} or folders/{folder} or organizations/{organization} |\n\nQuery parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of plans to return per page. The service may return fewer than this value. If unspecified, the server will use a sensible default. The maximum value is 1000; values above 1000 will be coerced to 1000. |\n| `pageToken` | `string` Optional. A page token, received from a previous `capacityPlans.query` call. Provide this to retrieve the subsequent page. |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body\n\nIf successful, the response body contains an instance of [QueryCapacityPlansResponse](/capacity-planner/docs/reference/rest/v1beta/QueryCapacityPlansResponse).\n\nAuthorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `https://www.googleapis.com/auth/devstorage.full_control`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\nIAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `capacityplanner.capacityPlans.list`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
