List Processes

Table Of Contents

List Processes#

Description#

Retrieve a paginated list of Processes the caller has access to, with each process’s associated ProcessRun embedded (if started).

GET /processes

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)
$next	query	string	false	Pagination cursor for next set of results.
$maxpagesize	query	integer(int32)	false	Maximum number of items per page. Minimum 1, maximum 1000.
$filter	query	string	false	Filter expression. Supported filter: name contains ‘’.
$orderBy	query	string	false	Sort expression. Supported fields: name, dueDate, run.created.dateTime. Field optionally followed by asc or desc. Default: run.created.dateTime desc.

Sorting Options#

Name	Orders Supported
dueDate	`asc`, `desc`
name	`asc`, `desc`
run.created.dateTime	`asc`, `desc`

Code Samples#

curl

curl -X GET https://api.app.wdesk.com/processes \
    -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 \
    X-Version:2026-04-01.processes.preview \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=GET "https://api.app.wdesk.com/processes" \
    --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', headers = headers)

print(r.json())

Returns#

200 - Processes retrieved successfully#

Returns a JSON object with data and @nextLink properties. data contains a list of process summary objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

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 paginated list of processes with embedded run summaries

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "autoClose": true,
      "certAutoApprove": true,
      "created": {
        "dateTime": "2024-09-15T10:00:00Z",
        "user": {
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
        }
      },
      "dueDate": "2024-12-31",
      "id": "e7b9920095e342889190b4d7eaeca6fa",
      "modified": {
        "dateTime": "2024-10-30T15:03:27Z",
        "user": {
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
        }
      },
      "name": "Q4 2024 Financial Close Process",
      "processTemplate": null,
      "relativeDates": false,
      "revision": 3,
      "run": {
        "completedDate": null,
        "created": {
          "dateTime": "2024-10-01T08:00:00Z",
          "user": {
            "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
          }
        },
        "dueDate": "2024-12-31",
        "id": "a1b2c3d4e5f6789012345678",
        "managerUser": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
        "modified": {
          "dateTime": "2024-10-30T14:22:00Z",
          "user": {
            "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
          }
        },
        "name": "Q4 2024 Financial Close Process",
        "process": "e7b9920095e342889190b4d7eaeca6fa",
        "status": "running",
        "statusCounts": null
      },
      "sourceProcessRun": null
    },
    {
      "autoClose": false,
      "certAutoApprove": false,
      "created": {
        "dateTime": "2024-11-01T09:00:00Z",
        "user": {
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
        }
      },
      "dueDate": "2024-11-30",
      "id": "f8c0a31106a443a2b280c5e8fbd17e01",
      "modified": {
        "dateTime": "2024-11-01T09:00:00Z",
        "user": {
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
        }
      },
      "name": "Monthly SOX Controls",
      "processTemplate": "tmpl-9e20a5ae",
      "relativeDates": false,
      "revision": 1,
      "run": null,
      "sourceProcessRun": null
    }
  ]
}

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 listProcesses 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