v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Workflows

List all Comments on a Workflow

Return a list of comments on a workflow.

OAuth Scope required: public.workflows.readComments

get/workflows/{id}/comments

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

Query parameters

pageinteger

The page number used when paginating through a list of results.

pageSizeinteger

A limit of the number of results to return.

Headers

x-as-user-emailstring

Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

x-as-user-idstring

Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Response

200

pageinteger

pageSizeinteger

countinteger

Example response

{
  "pageSize": 20,
  "count": 1,
  "list": [
    {
      "id": "8asdkyrhl",
      "commentMessage": "Do or do not. There is no try.",
      "timestamp": "2025-01-17T17:51:49.008Z",
      "author": {
        "type": "internalUser",
        "companyName": "Jabba the Hutt Industries",
        "displayName": "Boba Fett",
        "email": "boba@example.com",
        "userId": "63d415e0dd0d828c3a878548"
      },
      "repliedTo": {
        "item": "uwshlxaa2",
        "itemAuthor": {
          "type": "internalUser",
          "companyName": "Jabba the Hutt Industries",
          "displayName": "Boba Fett",
          "email": "boba@example.com",
          "userId": "63d415e0dd0d828c3a878548"
        }
      },
      "mentionedUserDetails": [
        {
          "id": "63d415e0dd0d828c3a878548",
          "displayName": "Yoda",
          "email": "yoda@example.com"
        }
      ],
      "addedParticipants": [
        "Obi-Wan Kenobi"
      ],
      "reactions": [
        {
          "emojiId": "joy",
          "reactors": [
            {
              "type": "internalUser",
              "companyName": "Jabba the Hutt Industries",
              "displayName": "Boba Fett",
              "email": "boba@example.com",
              "userId": "63d415e0dd0d828c3a878548"
            }
          ]
        }
      ]
    }
  ]
}