Attachments

List attachments

Returns task-level attachments, ordered by creation date (newest first). Supports filtering by workflow, workflow run, task, or creator.

get/attachments

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/attachments
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Query parameters

workflowIdstring

Filter by workflow.

workflowRunIdstring

Filter by workflow run.

taskIdstring

Filter by task.

createdByIdstring

Filter by creator.

_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": [
    {
      "createdBy": {
        "id": "paiZa0_oyxEBoZxtatp33g",
        "email": "jane.doe@example.com",
        "username": "Jane Doe"
      },
      "taskId": "u5O-CcFjjqwBoZxtdS98fA",
      "workflowRunId": "u5O-CcFjjqwBoZxtdS98fA",
      "workflowId": "u5O-CcFjjqwBoZxtdS98fA",
      "links": [
        {
          "href": "https://api.process.st/api/v1.1/resource/XXX"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}

Changes

No recorded changes to this operation across all 16 revisions of this API.