Filtering workflow sessions

Below is a list of attributes available for filtering workflow sessions.

Attribute
Type

status

string Valid values are started, processing, complete, abandoned, and cancelled.

outcome

string Valid values are clear, attention, and rejected.

workflowTemplateId

string

workflowId

string

workflowVersion

string

clientId

string

Example - Get all workflow sessions for an outcome

In the example below, we will request to get all workflow sessions with an outcome of clear.

curl -X GET https://api.complycube.com/v1/workflowSessions?outcome=clear \
     -H 'Authorization: <YOUR_API_KEY>'