curl --request GET \
--url https://api.example.com/api/projects/{projectId}/releases/{releaseId} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deletedAt": "<string>",
"name": "<string>",
"description": "<string>",
"version": 123,
"semanticVersion": "<string>",
"status": "draft",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"meta": {
"bucket": "<string>",
"key": "<string>"
},
"files": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path": "<string>",
"releaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"contentType": "<string>",
"contentHash": "<string>",
"versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"diffStatus": "added",
"previousReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"previousId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"firstName": "<string>",
"lastName": "<string>",
"type": "<string>",
"status": "<string>"
},
"changeRequests": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
]
}Retrieve a single release by ID, optionally including diff information compared to a previous release.
curl --request GET \
--url https://api.example.com/api/projects/{projectId}/releases/{releaseId} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deletedAt": "<string>",
"name": "<string>",
"description": "<string>",
"version": 123,
"semanticVersion": "<string>",
"status": "draft",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"commitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"meta": {
"bucket": "<string>",
"key": "<string>"
},
"files": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"path": "<string>",
"releaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"contentType": "<string>",
"contentHash": "<string>",
"versionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"diffStatus": "added",
"previousReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"previousId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"firstName": "<string>",
"lastName": "<string>",
"type": "<string>",
"status": "<string>"
},
"changeRequests": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
]
}Personal access token is obtained through your profile
Project unique identifier
Release unique identifier
Previous release ID for computing file diffs
Release details with files
Release details with files
Release unique identifier
Release creation timestamp
Project ID the release belongs to
Release deletion timestamp
Release name
Release description
Legacy numeric version
Semantic version (e.g., 1.0.0)
Release status
draft, published, completed ID of the user who created the release
Associated commit ID
Release storage metadata
Show child attributes
List of files in the release
Show child attributes
User who created the release
Show child attributes
Pending change requests
Show child attributes
Was this page helpful?