BObotbrains-io
Sessions

List Sessions

Changed on

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

  • Cursor pagination (recommended)
  • Offset pagination

See Pagination.

Allowed For

  • Admins, Agents, End users
get/api/v2/sessions

Request

Query parameters

page[before]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[after]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[size]integer

Specifies how many records should be returned in the response. You can specify up to 100 records per page.

Response

Success response

Changes

  • edbf399da815Revision changes
    • info

      added the new optional query request parameter page[after]

    • info

      added the new optional query request parameter page[before]

    • info

      added the new optional query request parameter page[size]