Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

My Work

Search My Work items

Searches work items with complex filtering. Supports multi-value filters for assignees, types, and workflows, plus free-text search and sorting.

post/work/items/search

Query parameters

_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.

Request body

assigneeEmailsstring[]

Filter results to items assigned to one or more user emails. Unknown emails are silently ignored (the search returns whatever the known assignees have). Defaults to the authenticated user if empty.

typesstring[]
workflowIdsstring[]

Filter to specific workflows. Unknown/inaccessible workflow IDs are silently ignored.

dueDateFromstring date-time

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

dueDateTostring date-time

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

snoozeStatus'Active' | 'Snoozed'

Snooze filter for the search.

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

Include completed items. Defaults to false.

searchTermstring

Free-text search term applied to task and workflow names.

sortBy'DueDate' | 'Name'

Sort key.

  • DueDate — sort by assignment due date.
  • Name — sort by task name (falls back to workflow run name if the task has no name).
sortOrder'Asc' | 'Desc'

Sort direction.

  • Asc — ascending.
  • Desc — descending.

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"
    }
  ]
}