Skip to main content
View as Markdown

Sessions

List sessions

GET/api/v1/sessions

Sessions in the selected organization, visible to every member of it, newest first, with cursor pagination. The organization is chosen by the X-Organization-Id header, or the organization the API key is bound to, otherwise the caller's default organization.

Query parameters
limitinteger
Maximum sessions to return (default 100, max 500)
beforestring · date-time
Cursor: return sessions created strictly before this RFC3339 timestamp
Header parameters
X-Organization-Idstring
Selects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Returns
objectstringrequired
dataarrayrequired
Show child attributes
idstring · uuidrequired
The session's own id
organizationstringrequired
Reference to the organization this session belongs to
userstring · uuidrequired
Reference to the user who created this session
deviceobjectrequired
Show child attributes
idstringrequired
The device's own id
platformstringrequired
typestringrequired
namestringrequired
osVersionstringrequired
createdAtstring · date-timerequired
releasedAtstring · date-timenullable
nextCursorstringnullable
Cursor for the next page; absent when there are no more results

Get a session

GET/api/v1/sessions/{sessionId}

Returns a session in the selected organization, visible to every member of it. The organization is chosen by the X-Organization-Id header, or the organization the API key is bound to, otherwise the caller's default organization.

Path parameters
sessionIdstring · uuidrequired
Session UUID
Header parameters
X-Organization-Idstring
Selects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Returns
idstring · uuidrequired
The session's own id
organizationstringrequired
Reference to the organization this session belongs to
userstring · uuidrequired
Reference to the user who created this session
deviceobjectrequired
Show child attributes
idstringrequired
The device's own id
platformstringrequired
typestringrequired
namestringrequired
osVersionstringrequired
createdAtstring · date-timerequired
releasedAtstring · date-timenullable