GetParticipantActionUrlsResp

Action URLs for every participant in a workflow. Returned only from the dedicated, privileged GET /workflows/{id}/action-urls endpoint — these URLs are stripped from all other workflow read responses.

actionUrls
Type: array object[] · ParticipantActionUrlInfo[]
required

One entry per participant action step, in step order.
One participant's action URL plus their action type and current status. The url embeds a token that is the sole credential needed to complete the action (e.g. sign) — treat it as a secret and deliver it only to the intended participant.
- actionType
  enum
  const:
  sign
  required
  
  What the participant does at this step. Currently always sign; more action types may be added.
  
  values
  sign
- participantKey
  Type: string
  required
  
  The participant this URL is for (matches a key in the workflow's participants).
- status
  Type: stringenum
  required
  
  Current participant action status. With notifications disabled, ready means the step is active and SignStack did not email the participant — send the link now. pending means an earlier step must complete first (the URL is still valid once their turn arrives). With notifications enabled, an active step is notified.
  
  values
  pending
  notified
  ready
  viewed
  signed
  declined
- stepKey
  Type: string
  required
  
  The participant step this URL is for.
- url
  Type: string
  required
  
  The participant's action link. Bearer-style — anyone with it can complete the action on this participant's behalf.
- email
  Type: string
  
  The participant's email, if known — the address you would send the link to.
- name
  Type: string
  
  The participant's display name, if known.