Skip to main content
GET
List sessions

Authorizations

Authorization
string
header
required

API key authentication. Use format "Bearer sk_live_..." or "Bearer sk_test_..."

Query Parameters

limit
integer
default:25

Maximum number of sessions to return (max 100)

Required range: 0 <= x <= 100
cursor
string

Cursor for pagination

flowId
string

Filter by flow/form ID

clientReferenceId
string

Filter by client reference ID

status

Filter by session status(es)

Available options:
created,
inProgress,
complete,
incomplete
fromDate
integer

Filter sessions created after this timestamp (Unix timestamp)

toDate
integer

Filter sessions created before this timestamp (Unix timestamp)

sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
status,
finishedAt
sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc

Search in metadata and other fields

includeTotal
boolean
default:false

Include total count (expensive operation)

Response

Sessions retrieved successfully

sessions
object[]
required
hasMore
boolean
required
nextCursor
string
totalCount
integer

Only included if includeTotal=true