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

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

Node.js

Python

PHP

.NET

Example response

Success (200)

{
    "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:91.913Z"
        }
    ]
}