latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

My Work

List My Work items

Returns a paginated list of work items assigned to the authenticated user. Use assigneeEmail to filter by a specific user, or omit to default to the authenticated user.

get/work/items

Query parameters

assigneeEmailstring

Filter by assignee email. Defaults to the authenticated user.

type'Checklist' | 'StandardTask' | 'ApprovalTask' | 'OneOffTask' | 'Acknowledgment'

Filter by item type.

  • Checklist — a workflow run assigned to the user.
  • StandardTask — a regular task within a workflow run.
  • ApprovalTask — an approval task awaiting the user's review.
  • OneOffTask — a standalone one-off task.
  • Acknowledgment — a revision-acknowledgment request after a workflow update.
workflowIdstring

Filter to a specific workflow. If the workflow does not exist or is inaccessible, the response is an empty page rather than an error.

dueDateFromstring

Due date range start (ISO-8601, e.g. 2024-01-15).

dueDateTostring

Due date range end (ISO-8601, e.g. 2024-01-31).

snoozeStatus'Active' | 'Snoozed'

Filter by snooze status.

  • Active — non-snoozed items only.
  • Snoozed — items currently snoozed.

Omit this filter to include both.

includeCompletedboolean

Include completed items. Defaults to false.

_string

Opaque pagination cursor. Take this value from the previous response's links[] entry whose name is "next" (typically just follow that link's href instead of reading this value). Omit on the first page. If the previous response had no next link, there are no more pages.

Response

Example response

{
  "data": [
    {
      "id": "iSsybs4rrlbcd29vCbhIGA",
      "workflowId": "iSsybs4rrlbcd29vCbhIGA",
      "assignees": [
        {
          "id": "naAJxoDIuwdgNsQHGRRGqA",
          "email": "jane.doe@example.com",
          "username": "Jane Doe"
        }
      ],
      "links": [
        {
          "href": "https://api.process.st/api/v1.1/resource/XXX"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}