GET /api/v2/sessions

If authenticated as an admin, returns all the account's sessions. If authenticated as an agent or end user, returns only the sessions of the user making the request.

Pagination

See Pagination.

Allowed For

Servers

Query parameters

Name Type Required Description
page Object No

Cursor-based pagination parameters (JSON:API style).

Supports nested parameters:

  • page[size] - Number of records per page (default varies by endpoint, typically 100)
  • page[after] - Cursor token to fetch records after this position
  • page[before] - Cursor token to fetch records before this position

Example: ?page[size]=50&page[after]=eyJvIjoiaWQiLCJ2IjoiYVFFPSJ9

sort String No

Field to sort results by. Prefix with - for descending order.

When used with cursor pagination, this determines the cursor ordering.

Example: ?sort=name or ?sort=-created_at

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.