Method: projects.deployments.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the deployments of an Apps Script project.
HTTP request
GET https://script.googleapis.com/v1/projects/{scriptId}/deployments
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
scriptId |
string
The script project's Drive ID.
|
Query parameters
| Parameters |
pageToken |
string
The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from a previous response.
|
pageSize |
integer
The maximum number of deployments on each returned page. Defaults to 50.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response with the list of deployments for the specified Apps Script project.
| JSON representation |
{
"deployments": [
{
object (Deployment)
}
],
"nextPageToken": string
} |
| Fields |
deployments[] |
object (Deployment)
The list of deployments.
|
nextPageToken |
string
The token that can be used in the next call to get the next page of results.
|
Authorization Scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/script.deploymentshttps://www.googleapis.com/auth/script.deployments.readonly
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[null,null,["Last updated 2024-10-31 UTC."],[[["\u003cp\u003eThis endpoint lists the deployments of an Apps Script project using an HTTP GET request.\u003c/p\u003e\n"],["\u003cp\u003eYou need to provide the \u003ccode\u003escriptId\u003c/code\u003e as a path parameter to identify the project.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of deployments and a token for pagination if there are more results.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization is required using specific OAuth scopes related to script deployments.\u003c/p\u003e\n"]]],[],null,["# Method: projects.deployments.list\n\n- [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 - [JSON representation](#body.ListDeploymentsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the deployments of an Apps Script project.\n\n### HTTP request\n\n`GET https://script.googleapis.com/v1/projects/{scriptId}/deployments`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-----------------------------------------|\n| `scriptId` | `string` The script project's Drive ID. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageToken` | `string` The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response. |\n| `pageSize` | `integer` The maximum number of deployments on each returned page. Defaults to 50. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse with the list of deployments for the specified Apps Script project.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"deployments\": [ { object (/apps-script/api/reference/rest/v1/projects.deployments#Deployment) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------|\n| `deployments[]` | `object (`[Deployment](/apps-script/api/reference/rest/v1/projects.deployments#Deployment)`)` The list of deployments. |\n| `nextPageToken` | `string` The token that can be used in the next call to get the next page of results. |\n\n### Authorization Scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/script.deployments`\n- `https://www.googleapis.com/auth/script.deployments.readonly`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
