---
title: "List all Comments on a Workflow"
method: GET
path: "/workflows/{id}/comments"
tags: ["Workflows"]
---

# List all Comments on a Workflow

`GET /workflows/{id}/comments`

Return a list of comments on a workflow. 

**OAuth Scope required:** `public.workflows.readComments`

## Path parameters

- `id` string, required

## Query parameters

- `page` integer
- `pageSize` integer

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Response `200`

200

- object
  - `page` integer
  - `pageSize` integer
  - `count` integer
  - `list` ActivityFeedComment[]
    - `id` string, required — Unique ID of the comment-type activity feed item
    - `commentMessage` string, required — The comment message
    - `timestamp` string, date-time, required — When the comment was posted (ISO 8601 format)
    - `isExternal` boolean — Whether the comment was made by an external user
    - `author` union, required — The author of an activity feed item
      - object — An internal author of an activity feed item
        - `type` 'internalUser', required — The type of author
        - `companyName` string, required — The company name of the author
        - `displayName` string — The display name of the author
        - `email` string — The email of the author
        - `userId` string — The user ID of the author
      - object — An external author of an activity feed item (typically a counterparty)
        - `type` 'externalUser', required — The type of author
        - `companyName` string, required — The company name of the author
        - `displayName` string — The display name of the author
        - `email` string — The email of the author
      - object — An integration author of an activity feed item
        - `type` 'integration', required — The type of author
        - `displayName` string, required — The display name of the integration
      - object — A system author of an activity feed item
        - `type` 'system', required — The type of author
        - `displayName` 'Ironclad', required — The display name of the system
    - `repliedTo` object — The comment that this comment is a reply to
      - `item` string, required — The ID of the comment that this comment is a reply to
      - `itemAuthor` union, required — The author of an activity feed item
        - object — An internal author of an activity feed item
          - `type` 'internalUser', required — The type of author
          - `companyName` string, required — The company name of the author
          - `displayName` string — The display name of the author
          - `email` string — The email of the author
          - `userId` string — The user ID of the author
        - object — An external author of an activity feed item (typically a counterparty)
          - `type` 'externalUser', required — The type of author
          - `companyName` string, required — The company name of the author
          - `displayName` string — The display name of the author
          - `email` string — The email of the author
        - object — An integration author of an activity feed item
          - `type` 'integration', required — The type of author
          - `displayName` string, required — The display name of the integration
        - object — A system author of an activity feed item
          - `type` 'system', required — The type of author
          - `displayName` 'Ironclad', required — The display name of the system
    - `mentionedUserDetails` object[], required — The users mentioned in the comment
      - `id` string, required — The user ID of the mentioned user
      - `displayName` string, required — The display name of the mentioned user
      - `email` string, required — The email of the mentioned user
    - `addedParticipants` string[], required — The users added to the workflow by the comment
    - `reactions` object[], required — The emoji reactions to the comment
      - `emojiId` string, required — The ID of the emoji reaction
      - `reactors` ActivityFeedAuthor[], required — The users who reacted with the particular emoji
        - union — The author of an activity feed item
          - object — An internal author of an activity feed item
            - `type` 'internalUser', required — The type of author
            - `companyName` string, required — The company name of the author
            - `displayName` string — The display name of the author
            - `email` string — The email of the author
            - `userId` string — The user ID of the author
          - object — An external author of an activity feed item (typically a counterparty)
            - `type` 'externalUser', required — The type of author
            - `companyName` string, required — The company name of the author
            - `displayName` string — The display name of the author
            - `email` string — The email of the author
          - object — An integration author of an activity feed item
            - `type` 'integration', required — The type of author
            - `displayName` string, required — The display name of the integration
          - object — A system author of an activity feed item
            - `type` 'system', required — The type of author
            - `displayName` 'Ironclad', required — The display name of the system

## Other responses

- `403` — 403
- `404` — 404

---

[API](https://skmtc.net/ironcladapp/apis/ironclad-public-api.md) · [All operations](https://skmtc.net/ironcladapp/apis/ironclad-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ironcladapp/ironclad-public-api/versions/9459b4cfc1e0/schema)