List workflow comments

gethttps://api.expiryedge.com/v1/getWorkflowComments
bearer token (Firebase ID token or session JWT); any role60/min
Anfrage
curl 'https://api.expiryedge.com/v1/getWorkflowComments?workflow_id=run_7Vb3&step_id=rstp_2Wd8' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Antwort
{
  "comments": [
    {
      "id": "wcm_4Rt6",
      "workflow_id": "run_7Vb3",
      "step_id": "rstp_2Wd8",
      "section_id": null,
      "user_id": "u_71bXq",
      "content": "@Priya certificates for Dr. Lee are uploaded.",
      "mentioned_users": [
        {
          "id": "u_93kLp",
          "name": "Priya Shah"
        }
      ],
      "is_edited": false,
      "created_at": "2026-09-27T14:05:00.000Z",
      "updated_at": "2026-09-27T14:05:00.000Z",
      "user_name": "Marcus Hale",
      "user_email": "marcus@northwinddental.com"
    }
  ]
}

Comments on a workflow or run, newest first, with the author user_name and user_email. Filter by step_id or else section_id. Returns all matches; unbounded.

Query-Parameter

  • workflow_idstringerforderlich
    Workflow id or workflow run id.
  • step_idstring
    Only comments on this step.
  • section_idstring
    Only comments on this section (ignored when step_id is set).

Rückgabe

200
Comments.
  • commentsarray of objectserforderlich

Fehler

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
403
Authenticated, but your role or organization does not allow this action.
404
The record does not exist or is not in your organization.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.