List workflow sessions

Returns workflow sessions for your organization. Filter the results by project, workflow, status, step type, creation date, or metadata. New integrations should use page-based pagination; cursor-based pagination remains available for existing integrations but is deprecated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Pagination method. Use page for page-number pagination. cursor is supported for existing integrations but is deprecated. Defaults to cursor.

Allowed:
number
≥ 1
Defaults to 1

1-based page number to return. Defaults to 1.

string
Defaults to desc

Sort order. Use asc for ascending or desc for descending. Defaults to desc.

string

Comma-separated fields used to sort the results. Available values: createdAt.

string

Return sessions from this project. If omitted, returns sessions from every project the user can access.

string

Return sessions with any of these comma-separated statuses: ASSIGNED, CANCELLED, COMPLETED, EXPIRED, FAILED, RUNNING, TERMINATED.

stepTypes
array of strings

Return sessions currently on any of these step types. Pass a comma-separated list.

stepTypes

Text to search for in session identifiers, names, statuses, current-step details, and error details.

boolean
Defaults to true

Whether to include details about the current step. Defaults to true.

boolean
Defaults to true

Whether to include recorded failure details. Defaults to true.

string

Return sessions from this workflow.

string

Filter by the session creation date. Use an ISO 8601 date and time.

string

Filter by session metadata. Pass a JSON object encoded as a string.

string

Return sessions created on or after this date. Use an ISO 8601 date and time, or a relative value such as -30d for 30 days ago.

string

Return sessions created on or before this ISO 8601 date and time. Defaults to the current time.

boolean
Defaults to false

Whether to return every step (with its assignees) for each session on the page. Defaults to false. Only honoured on the page-based list path; ignored for cursor pagination.

boolean
Defaults to false

Whether to return unmasked session names. The user must have permission to view session names for the selected project. Defaults to false.

number
1 to 100
Defaults to 25

Number of items returned per page. Defaults to 25; maximum 100.

Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json