curl --request GET \
--url https://api.example.com/api/projects/{projectId}/runs \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "in_progress",
"releaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"runVersion": "v2",
"release": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"version": "<string>"
},
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"firstName": "<string>",
"lastName": "<string>"
},
"completedAt": "<string>",
"cancelledById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cancelledBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"firstName": "<string>",
"lastName": "<string>"
},
"cancelledComment": "<string>",
"jobs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "not_started",
"order": 123,
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deploymentWorkflowRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"key": "<string>"
},
"reviewedAt": "<string>",
"reviewedBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"firstName": "<string>",
"lastName": "<string>"
},
"reviewedComment": "<string>",
"reviewedConclusion": "approved",
"previousRelease": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"version": "<string>"
},
"previousReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"event": "<string>",
"data": "<unknown>"
}
]
}
],
"paginate": {
"current": 123,
"from": 123,
"to": 123,
"total": 123,
"pageSize": 123
}
}Retrieve a paginated list of deployment workflow runs for a project.
curl --request GET \
--url https://api.example.com/api/projects/{projectId}/runs \
--header 'Authorization: Bearer <token>'{
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "in_progress",
"releaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"runVersion": "v2",
"release": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"version": "<string>"
},
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"firstName": "<string>",
"lastName": "<string>"
},
"completedAt": "<string>",
"cancelledById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cancelledBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"firstName": "<string>",
"lastName": "<string>"
},
"cancelledComment": "<string>",
"jobs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "not_started",
"order": 123,
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deploymentWorkflowRunId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "<string>",
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"key": "<string>"
},
"reviewedAt": "<string>",
"reviewedBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "[email protected]",
"firstName": "<string>",
"lastName": "<string>"
},
"reviewedComment": "<string>",
"reviewedConclusion": "approved",
"previousRelease": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"version": "<string>"
},
"previousReleaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"event": "<string>",
"data": "<unknown>"
}
]
}
],
"paginate": {
"current": 123,
"from": 123,
"to": 123,
"total": 123,
"pageSize": 123
}
}Personal access token is obtained through your profile
Project unique identifier
Search term to filter runs
Current page
Number of items per page
Was this page helpful?