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
limitintegerMaximum sessions to return (default 100, max 500)
beforestring · date-timeCursor: return sessions created strictly before this RFC3339 timestamp
Header parameters
X-Organization-IdstringSelects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Returns
objectstringrequireddataarrayrequiredShow child attributes
idstring · uuidrequiredThe session's own id
organizationstringrequiredReference to the organization this session belongs to
userstring · uuidrequiredReference to the user who created this session
deviceobjectrequiredShow child attributes
idstringrequiredThe device's own id
platformstringrequiredtypestringrequirednamestringrequiredosVersionstringrequiredcreatedAtstring · date-timerequiredreleasedAtstring · date-timenullablenextCursorstringnullableCursor 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 · uuidrequiredSession UUID
Header parameters
X-Organization-IdstringSelects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Returns
idstring · uuidrequiredThe session's own id
organizationstringrequiredReference to the organization this session belongs to
userstring · uuidrequiredReference to the user who created this session
deviceobjectrequiredShow child attributes
idstringrequiredThe device's own id
platformstringrequiredtypestringrequirednamestringrequiredosVersionstringrequiredcreatedAtstring · date-timerequiredreleasedAtstring · date-timenullable