List sessions

This method lists all active sessions

Try this request in your browser

/api/ /sessions/list

Headers

X-API-Token

Parameters

with_chats Boolean
sites Array
uuids_only Boolean

The request output will be shown here...

URL

https://api.natterly.com/api/v1/sessions/list

Access

Must be authenticated as a user. If not authorised, a MustBeAuthenticated error will be returned.

Parameters

Parameter Type Default

with_chats

Filter based on presence of chat with session

Boolean null

sites

Filter based on a list of sites

Array null

uuids_only

Only return UUIDs of sessions

Boolean null

Errors

There are no action-specific errors which can be raised.

Response Data

This action will return an array of session structures.

You'll receive all attributes for this structure (basic and extended attributes). You'll receive expansions for site_id, visitor, active_chat_id.