Get a ProcessRun by id#
Description#
Retrieve a ProcessRun (running instance of a Process) by its unique identifier.
GET /processRuns/{processRunId}
Required OAuth Scopes
file:read
Parameters#
Parameter |
In |
Type |
Required |
Description |
|---|---|---|---|---|
X-Version |
header |
string |
true |
Version of the API (2026-04-01.processes.preview) |
processRunId |
path |
string |
true |
Identifier of the ProcessRun |
excludeGeneratedJobs |
query |
boolean |
false |
If true, excludes auto-generated certification child jobs from the response |
Code Samples#
curl -X GET https://api.app.wdesk.com/processRuns/{processRunId} \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'X-Version: 2026-04-01.processes.preview'
http GET https://api.app.wdesk.com/processRuns/{processRunId} \
X-Version:2026-04-01.processes.preview \
Accept:application/json \
Authorization:"Bearer {access-token}"
wget --method=GET "https://api.app.wdesk.com/processRuns/{processRunId}" \
--output-document - \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {access-token}' \
--header 'X-Version: 2026-04-01.processes.preview'
import requests
headers = {
'X-Version': '2026-04-01.processes.preview',
'Accept': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.get('https://api.app.wdesk.com/processRuns/{processRunId}', headers = headers)
print(r.json())
Returns#
200 - ProcessRun retrieved successfully#
A Process that has been started. An instantiation of a Process.
400 - Invalid request#
Standard error response returned by the API when a request fails. Provides detailed information about what went wrong including error codes, human-readable messages, and additional context to help diagnose and fix the issue.
401 - Unauthenticated request.#
Standard error response returned by the API when a request fails. Provides detailed information about what went wrong including error codes, human-readable messages, and additional context to help diagnose and fix the issue.
404 - Not found#
Standard error response returned by the API when a request fails. Provides detailed information about what went wrong including error codes, human-readable messages, and additional context to help diagnose and fix the issue.
409 - Collision#
Standard error response returned by the API when a request fails. Provides detailed information about what went wrong including error codes, human-readable messages, and additional context to help diagnose and fix the issue.
429 - Too Many Requests#
Standard error response returned by the API when a request fails. Provides detailed information about what went wrong including error codes, human-readable messages, and additional context to help diagnose and fix the issue.
500 - Server error#
Standard error response returned by the API when a request fails. Provides detailed information about what went wrong including error codes, human-readable messages, and additional context to help diagnose and fix the issue.
Example Responses#
{
"autoClose": true,
"businessDaysOfWeek": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
],
"certAutoApprove": true,
"created": {
"dateTime": "2024-10-30T15:03:27Z",
"user": {
"id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
}
},
"dueDate": "2024-12-31",
"id": "processrun-xyz789",
"ipmBetaEnabled": false,
"iwmOptOut": false,
"modified": {
"dateTime": "2024-10-30T15:03:27Z",
"user": {
"id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
}
},
"name": "Q4 2024 Financial Close",
"process": "process-abc123",
"relativeDates": false,
"revision": 5,
"root": {
"children": [
{
"jobRun": {
"action": "sendTask",
"actionStatus": "Completed",
"arguments": {
"sendTaskArgs": {
"assignee": {
"id": "user-abc123",
"type": "user"
},
"document": "doc-xyz789",
"title": "Review Q4 financial report"
},
"type": "sendTask"
},
"id": "jobrun-001",
"job": "job-template-001",
"metadata": {
"sendTaskMetadata": {
"cancelCleanupComplete": false,
"permalink": "https://app.wdesk.com/a/abc123/tasks/task-001",
"status": "Completed",
"task": "task-001",
"taskCancelled": false,
"taskCancelledNotificationSent": false
},
"type": "sendTask"
},
"ordinal": 0,
"readOnly": false,
"status": "complete"
},
"type": "job"
},
{
"jobRun": {
"action": "contentRequest",
"actionStatus": "Waiting",
"arguments": {
"contentRequestArgs": {
"approver": {
"id": "manager-ghi789",
"type": "user"
},
"assignee": {
"id": "user-abc123",
"type": "user"
},
"document": "doc-balance123",
"title": "Update balance sheet"
},
"type": "contentRequest"
},
"id": "jobrun-002",
"job": "job-template-002",
"metadata": {
"contentRequestMetadata": {
"cancelCleanupComplete": false,
"permalink": "https://app.wdesk.com/a/abc123/tasks/task-002",
"status": "Created",
"task": "task-002",
"taskCancelled": false,
"taskCancelledNotificationSent": false
},
"type": "contentRequest"
},
"ordinal": 1,
"readOnly": false,
"status": "waiting"
},
"type": "job"
},
{
"jobRun": {
"action": "sendTask",
"actionStatus": "Running",
"arguments": {
"sendTaskArgs": {
"assignee": {
"id": "user-abc123",
"type": "user"
},
"document": "doc-final456",
"title": "Final sign-off"
},
"type": "sendTask"
},
"id": "jobrun-003",
"job": "job-template-003",
"ordinal": 2,
"readOnly": false,
"status": "running"
},
"type": "job"
}
],
"id": "grouprun-root123",
"name": "Main Workflow",
"parallel": false,
"readOnly": false,
"status": "running"
},
"status": "running",
"statusCounts": {
"Completed": 1,
"Running": 1,
"Waiting": 1
}
}
{
"code": "invalidUser",
"documentationUrl": "http://developerdocs.example.com",
"message": "The provided user is invalid.",
"meta": {
"argumentName": "assignee",
"jobId": "job1234"
},
"target": "assignee"
}
{
"code": "Unauthorized",
"message": "Bad credentials"
}
{
"code": "403",
"message": "Forbidden"
}
{
"code": "404",
"message": "Could not find process id 51bcc3ec3d0b4aadb69659e2a7ed767b"
}
resource on the server.
{
"code": "409",
"message": "Letter is not in a status that supports submissions"
}
No example available
{
"code": "429",
"message": "Rate limit of 1000 per 60 seconds exceeded for listJobs requests. Retry request in 10 seconds."
}
No example available
This is a generic error message, meaning the server cannot provide a more specific error code.
{
"code": "500",
"message": "unknown error"
}
No example available
maintenance. This status code implies that the server is functional and understands the request, but it cannot fulfill it at the moment.
{
"code": "503",
"message": "Service Unavailable."
}
No example available