Introducing eIDAS-Compliant
eSignatures
Ctrlk
StatusBook a demoHelp CenterLaunch Portal
For the complete documentation index, see llms.txt. This page is also available as Markdown.

List workflow sessions

URL

GET https://api.complycube.com/v1/workflowSessions

This endpoint allows you to list all existing workflow sessions. The workflow sessions are returned sorted by creation date, with the most recent sessions appearing first.

Headers

Name
Type
Description

Authorization*

string

The live or sandbox API key.

Query parameters

Name
Type
Description

<pagination>

string

The number of items to return and the number of pages to offset.

<filtering>

string

Filter the results.

You can use pagination and workflow session filters for this endpoint.

Example request

curl -X GET https://api.complycube.com/v1/workflowSessions \
     -H 'Authorization: <YOUR_API_KEY>'
const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const workflowSessions = await complycube.workflowSession.list("CLIENT_ID");
from complycube import ComplyCubeClient

cc_api = ComplyCubeClient(api_key='<YOUR_API_KEY>')

wf_session_list = cc_api.workflowsessions.list() 
use ComplyCube\ComplyCubeClient;

$ccapi = new ComplyCubeClient('<YOUR_API_KEY>');

$wf_session_list = $ccapi->workflowSessions()->list();
using ComplyCube.Net;
using ComplyCube.Net.Resources.WorkflowSessions;

var wfSessionsApi = new WorkflowSessionApi(new ComplyCubeClient("<YOUR_API_KEY>"));

var workflowSessions = await wfSessionsApi.ListAsync();

Example response

{
    "page": 1,
    "pageSize": 100,
    "totalItems": 1,
    "pages": 1,
    "items": [
        {            
            "id": "6890d6a9513d1b0002559aa4",
            "clientId": "5eb1276d96be4a0008713af5",
            "entityName": "John Doe",
            "status": "complete",
            "workflowTemplateName": "Age estimation flow",
            "workflowTemplateId": "688f1e2837d2a9000202ad01",
            "workflowId": "6890d6941fb9b80002b0c1df",
            "workflowVersion": 2,
            "outcome": "clear",
            "createdAt": "2025-01-01T14:06:44.756Z",
            "updatedAt": "2025-01-01T14:06:45.743Z"
        }
    ]
}

PreviousCancel a workflow sessionNextFiltering workflow sessions