IRironcladapp
Workflows

List all Comments on a Workflow

Changed on

Return a list of comments on a workflow.

OAuth Scope required: public.workflows.readComments

get/workflows/{id}/comments

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/workflows/{id}/comments
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.workflows.readComments

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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. 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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. 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"
            }
          ]
        }
      ],
      "source": {
        "name": "Ramp"
      }
    }
  ]
}

Changes