Get all Releases
GET https://{{base_url}}/v3/releases
The Get all Releases request retrieves a list of all Releases of a stack along with details of each Release.
To configure the permissions for your application via OAuth, please include the cm.releases.management:read scope.
To use the API Request, you will need to authenticate yourself either with a Management Token (highly recommended) or an Authtoken.
Read more about it in Authentication.
For more information, refer to the Get all Releases API Reference document
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include_count | boolean | The ‘include_count’ parameter includes the count of total number of releases in your stack, along with the details of each release. Example: If you want to know the total number of releases, you need to mention ‘true’ as the value of this parameter. | |
count | boolean | The ‘count’ parameter works similar to the ‘include_count’ parameter but returns ONLY the total count of releases in your stack and not the details of the releases in the response. Example: If you want to know the total number of releases in your stack, you need to mention ‘true’ as value for this parameter. | |
include_items_count | boolean | The ‘include_items_count’ parameter returns the total number of items in a specific release. Example: If you want to know the total number of items in a release, you need to mention ‘true’ as the value of this parameter. | |
limit | number | The ‘limit’ parameter will return a specific number of releases in the output. Example, if there are 10 releases and you want to fetch the five latest updated releases, you need to specify '5' as value in this parameter. | |
skip | number | The ‘skip’ parameter will skip a specific number of releases in the response. Example: If there are 12 releases and you want to skip the first two updated releases to get only the next 10 in the response body, you need to specify ‘2’ here. | |
include_branch | boolean | Set this to 'true' to include the '_branch' top-level key in the response. This key states the unique ID of the branch where the concerned Contentstack module resides. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
api_key | string | ||
authtoken | string | ||
authorization | string | For this call we recommend you to use management token. | |
Content-Type | string | ||
branch | string | Enter your branch unique ID. |