Get sessions

get

https://api-us.streamline.intellistack.ai/v1/sessions

Returns a paginated list of workflow sessions for your organization. You can filter by project, workflow, status, step type, creation date, and metadata, and sort and page through the results. Note that cursor pagination is deprecated and page mode is the upcoming default.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pagination

string

enum

Pagination mode. Use page for page-based pagination with pageNumber and pageSize. cursor is deprecated; use page instead.

Allowed:

pageNumber

string

≥ 1

Defaults to 1

Page number to return (1-indexed). Defaults to 1.

pageSize

string

1 to 100

Defaults to 25

Number of sessions to return per page. Defaults to 25; maximum 100.

sortFields

string

Comma-separated fields to sort by. Allowed values: createdAt.

sortDirection

string

enum

Defaults to desc

Sort direction. asc for ascending, desc for descending. Defaults to desc.

Allowed:

projectId

string

Filter sessions to a single project by its id.

statuses

string

Comma-separated session statuses to filter by. Allowed values: ASSIGNED, RUNNING, COMPLETED, CANCELLED, EXPIRED, FAILED, TERMINATED.

stepTypes

string

Comma-separated step types to filter by (for example forms,sign,collaboration).

string

Free-text search across session id, session name, status, current step name, current step status, and failures.

withCurrentStep

string

Defaults to true

Include current step information in each session. Defaults to true.

withFailures

string

Defaults to true

Include the failures array in each session. Defaults to true.

workflowId

string

Filter sessions to a single workflow by its id.

createdAt

string

Filter by the session creation date. Accepts an ISO 8601 datetime, optionally prefixed with an operator: eq:, neq:, gt:, lt:, gte:, lte:.

metadata

string

Filter by session metadata. Provide a stringified JSON object, for example {"system": "salesforce", "externalId": "ext-123"}.

dateFrom

string

Start of the date range to filter by. Accepts an ISO datetime, a date-only string, or an interval such as -30d for the last 30 days.

dateTo

string

End of the date range to filter by. Accepts an ISO datetime or a date-only string. Defaults to the current time.

revealSessionIdentifiers

string

Defaults to false

Return unmasked session names for sessions in the project. Defaults to false. Requires permission to view session identifiers.

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Paginated list of sessions matching the filters.