List all comments

Returns a paginated list of comments sorted by creation date (newest first). Provide either workflowId, or workflowRunId with optional taskId.

get/comments

Request

Base URL
https://public-api.process.st/api/v1.1
URL
https://public-api.process.st/api/v1.1/comments
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.

_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": "gde-CKSrS14BoZxtgDh0Iw",
      "createdBy": {
        "id": "paiZa0_oyxEBoZxtatp33g",
        "email": "jane.doe@example.com",
        "username": "Jane Doe"
      },
      "updatedBy": {
        "id": "paiZa0_oyxEBoZxtatp33g",
        "email": "jane.doe@example.com",
        "username": "Jane Doe"
      },
      "workflowRunId": "gde-CKSrS14BoZxtgDh0Iw",
      "taskId": "gde-CKSrS14BoZxtgDh0Iw",
      "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.