Skip to main content

List Record Action Runs

GET 
/api/automation/record-actions/runs

List recent workflow runs for a record, newest first.

Required scope: settings:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

With record_id, returns every run on that record - whoever or whatever started it (record actions, event triggers and so on). Without record_id, returns the current user's own recent record-action runs on any record of that resource.

Requires workflows.run plus view permission on the resource.

Query parameters

  • resource (required) - One of supplier, product, sales_order, purchase_order, customer.
  • record_id (optional, integer)
  • limit (optional, integer 1-50, default 10)

Response fields (data[]): status is the stored run status (pending, running, waiting, completed, failed, canceled). trigger_reference is <RecordType>:<id>. batch_id groups runs started together on several records. progress_message is the latest progress line reported while the run is waiting on an agent or callback. result.summary / result.url are the run's reported outcome (a summary of Completed, Canceled or the error is used when the workflow reports none). actor is the user who started the run, or null. Timestamps are UTC ISO-8601. url is the run's page path relative to the account's host.

Returns 403 without the required permissions, 422 for invalid parameters.

Request​

Responses​

OK

Response Headers
    Content-Type