Skip to main content
GET
Get workflow executions list

Authorizations

x-api-key
string
header
required

Project API key. Create and manage keys in the dashboard under Project → API Keys. Send as header: x-api-key:

Headers

x-username
string
default:(project default user)

External user (end user) to act as. Optional — if omitted, Flowra uses the project’s default external user. Send a stable username (e.g. customer_alice) only when you need another end-user context.

Query Parameters

q
string

Search keyword for filtering results

Example:

"john doe"

page
number
default:1

Page number (1-based)

Required range: x >= 1
Example:

1

limit
number
default:20

Number of items per page

Required range: 1 <= x <= 100
Example:

20

offset
number

Number of items to skip (for offset-based pagination)

Required range: x >= 0
Example:

0

sortBy
string

Field name to sort by

Example:

"createdAt"

sortOrder
enum<string>
default:DESC

Sort order

Available options:
ASC,
DESC
Example:

"DESC"

fields
string

Comma-separated list of fields to include in response

Example:

"id,name,email"

workflowId
string

Workflow ID to filter by

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

status
enum<string>

Status filter

Available options:
running,
paused,
completed,
failed,
timeout
Example:

"completed"

Response

200 - application/json

Workflow executions retrieved successfully

success
boolean
required

Success status

Example:

true

message
string
required

Response message

Example:

"Data retrieved successfully"

data
object[]
required

Array of items

Example:
total
number
required

Total number of items across all pages

Example:

100

totalTools
number

Optional secondary total (e.g. nested tools across all matching toolkits)

Example:

5000

page
number

Current page number (1-based)

Example:

1

limit
number

Number of items per page

Example:

20

totalPages
number

Total number of pages

Example:

5

hasNextPage
boolean

Whether there is a next page

Example:

true

hasPreviousPage
boolean

Whether there is a previous page

Example:

false