Get a Process by id

Description

Retrieve a Process by its id.

GET /processes/{processId}

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)
processId	path	string	true	Identifier of the process
excludeGeneratedJobs	query	boolean	false

Code Samples

curl

curl -X GET https://api.app.wdesk.com/processes/{processId} \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2026-04-01.processes.preview'

httpie

http GET https://api.app.wdesk.com/processes/{processId} \
    X-Version:2026-04-01.processes.preview \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=GET "https://api.app.wdesk.com/processes/{processId}" \
    --output-document -  \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2026-04-01.processes.preview'

python

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/processes/{processId}', headers = headers)

print(r.json())

Returns

200 - Process retrieved successfully

Build-time representation of a Process whose work is described by a collection of Jobs contained in its root Group.

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.

403 - Unauthorized

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.

503 - Service Unavailable

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

A Process definition

{
  "autoClose": true,
  "businessDaysOfWeek": [
    "monday",
    "tuesday",
    "wednesday",
    "thursday",
    "friday"
  ],
  "businessStartDate": "2024-01-01",
  "certAutoApprove": true,
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "dueDate": "2024-12-31",
  "id": "process-abc123",
  "modified": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "name": "Q4 2024 Financial Close Process",
  "relativeDates": true,
  "revision": 3,
  "root": {
    "children": [
      {
        "job": {
          "arguments": {
            "type": "sendTask"
          },
          "id": "job-new123"
        },
        "type": "job"
      }
    ],
    "id": "root-group-123",
    "name": "Main Workflow",
    "parallel": false,
    "readOnly": false,
    "triggerType": "whenEligible"
  }
}

An invalid request.

{
  "code": "invalidUser",
  "documentationUrl": "http://developerdocs.example.com",
  "message": "The provided user is invalid.",
  "meta": {
    "argumentName": "assignee",
    "jobId": "job1234"
  },
  "target": "assignee"
}

An unauthenticated request.

{
  "code": "Unauthorized",
  "message": "Bad credentials"
}

Requestor does not have appropriate permissions for requested action.

{
  "code": "403",
  "message": "Forbidden"
}

A requested resource could not be found.

{
  "code": "404",
  "message": "Could not find process id 51bcc3ec3d0b4aadb69659e2a7ed767b"
}

A request cannot be completed because it conflicts with the current state of the target

resource on the server.

{
  "code": "409",
  "message": "Letter is not in a status that supports submissions"
}

No example available

The client (like a web browser) has sent too many requests to a server in a given amount of time.

{
  "code": "429",
  "message": "Rate limit of 1000 per 60 seconds exceeded for listJobs requests. Retry request in 10 seconds."
}

No example available

The server encountered an unexpected condition that prevented it from fulfilling the request.

This is a generic error message, meaning the server cannot provide a more specific error code.

{
  "code": "500",
  "message": "unknown error"
}

No example available

The server is currently unable to handle the request due to a temporary overload or scheduled

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