Transaction APIWorkflow Action Executions

Search workflow action executions

Supports filtering by invoice, payment, workflow, workflow action, workflow trigger and status. Requires the WORKFLOW_ACTION_EXECUTION.VIEW permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version

Headers

x-platform-idstringOptional
Platform ID.

Query parameters

expand[]list of stringsOptional
The id fields of the resources that are going to be expanded.
limitintegerOptional
The amount of records shown in the list
pageintegerOptional
The page which is going to be shown
order_bystringOptional

The parameter by which the response is ordered. default = name

order_directionstringOptional

The parameter for the response ordering direction (asc, desc) default asc

Request

This endpoint expects an object.
search_fieldslist of objectsOptional
filter_fieldslist of objectsOptional
selection_rule_fieldslist of objectsOptional

Response

OK
datalist of objects
Workflow action execution records returned for the current page.
limitinteger or nullOptional
Maximum number of records included in the page.
pageinteger or nullOptional
Current page number, starting at 1.
total_number_of_pagesinteger or nullOptionalDeprecated
Legacy page count value kept for compatibility.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error