Skip to main content
GET
List Sessions

Query Parameters

user
string

Filter by user's subject id

connection
string

Filter by connection's name

type
string

Filter by connection's type

review.approver
string

Filter by the approver's email of a review

review.status
string

Filter by the review status

correlation_id
string

Filter by external workflow/task correlation id

jira_issue_key
string

Filter by Jira issue key

start_date
string<RFC3339>

Filter starting on this date

end_date
string<RFC3339>

Filter ending on this date

limit
integer

Limit the amount of records to return (max: 100)

offset
integer

Offset to paginate through resources (max: 10000)

count
enum<string>

How to compute the total: capped at 10000 (default), exact, or none

Available options:
exact,
capped,
none

Response

OK

data
object[]
has_next_page
boolean
total
integer | null

The number of sessions matching the filter.

Capped by default: the value is the exact total up to 10000, and beyond that it stops at 10000 with total_is_capped set. Ask for ?count=exact to pay for the precise figure. null when the request asked for ?count=none, which is distinct from a count of zero: it means the total was never computed.

Example:

100

total_is_capped
boolean

Reports that total is a lower bound rather than the exact number of matching sessions. Render it as 10000+. Always false under ?count=exact, and for any result set smaller than the cap.