List Runners

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

page

string

optional

Example:

page_size

string

optional

Example:

string

optional

Search on id, name and ref_id, company_id, store fields

flow_id

string

optional

Filter on flow_id

design_id

string

optional

Filter on design_id

ref_id

string

optional

Filter on ref_id

ordering

string

optional

Order on created_at, updated_at (Asc or Desc)

Example:

-created_at

fields

string

optional

Provide fields to get

Example:

id,ref_id,created_at,updated_at,store.business.name

Responses

🟢200Success

application/json

Body

count

integer

required

current_page

integer

required

page_size

integer

required

results

array [object {10}]

required

string <uuid>

Unique Identifier

read-onlyrequired

A globally unique identifier for the resource.

Example:

123e4567-e89b-12d3-a456-426614174000

ref_id

string

Reference Identifier

required

An alphanumeric reference identifier for the resource.

>= 5 characters<= 50 characters

Examples:

ref12345xyz789

Match pattern:

^[a-zA-Z0-9_-]+$

flow_id

string <uuid>

Flow Identifier

required

Globally unique identifier for the flow associated with the resource.

Example:

123e4567-e89b-12d3-a456-426614174000

design_id

string <uuid>

Design Identifier

required

Globally unique identifier for the design associated with the resource.

Example:

123e4567-e89b-12d3-a456-426614174000

visited_nodes

object

Associated Users

optional

List of users associated with the resource.

created_at

string <date-time>

Creation Timestamp

read-onlyrequired

The ISO 8601 timestamp when the resource was created.

Example:

2023-01-01T00:00:00Z

created_by

string

Created By

required

The identifier of the user who created the edge. Must be 5-20 characters, allowing alphanumeric, dots, underscores, and dashes.

Match pattern:

^[a-zA-Z0-9._-]{3,50}$

updated_by

string | null

Updated By

optional

The identifier of the user who updated the edge. Must be 5-20 characters, allowing alphanumeric, dots, underscores, and dashes.

Match pattern:

^[a-zA-Z0-9._-]{3,50}$

updated_at

string <date-time> | null

Last Updated Timestamp

read-onlyoptional

The ISO 8601 timestamp when the resource was last updated.

Example:

2023-01-01T01:00:00Z

fields

object

required

Example

{
    "count": 0,
    "current_page": 0,
    "page_size": 0,
    "results": [
        {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "ref_id": "ref12345",
            "flow_id": "123e4567-e89b-12d3-a456-426614174000",
            "design_id": "123e4567-e89b-12d3-a456-426614174000",
            "visited_nodes": {
                "property1": [
                    {
                        "name": "string",
                        "action": "string",
                        "user_id": "string",
                        "timestamp": "string",
                        "data": {}
                    }
                ],
                "property2": [
                    {
                        "name": "string",
                        "action": "string",
                        "user_id": "string",
                        "timestamp": "string",
                        "data": {}
                    }
                ]
            },
            "created_at": "2023-01-01T00:00:00Z",
            "created_by": "string",
            "updated_by": "string",
            "updated_at": "2023-01-01T01:00:00Z",
            "fields": {}
        }
    ]
}

Request

Request samples

Responses