Skip to main content
GET
/
api
/
v1
/
customer
/
sessions
List Sessions
curl --request GET \
  --url https://api.example.com/api/v1/customer/sessions
{
  "data": [
    {
      "userSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "refreshTokenHash": "<string>",
      "deviceId": "<string>",
      "deviceName": "<string>",
      "userAgent": "<string>",
      "ipAddress": "<string>",
      "lastUsedAt": "2023-11-07T05:31:56Z",
      "refreshExpiresAt": "2023-11-07T05:31:56Z",
      "inactivityExpiresAt": "2023-11-07T05:31:56Z",
      "revokedAt": "2023-11-07T05:31:56Z",
      "revokedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revokedReason": "<string>",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "limit": 10,
    "page": 1,
    "totalItems": 142,
    "totalPages": 15
  }
}

Query Parameters

​
limit
number
default:10

Items per page.

Required range: 1 <= x <= 100
​
page
number
default:1

Page number.

Required range: x >= 1
​
audience
enum<string>

Session audience.

Available options:
CUSTOMER,
OPS,
DRIVER,
BACKOFFICE
​
status
enum<string>

Session status.

Available options:
ACTIVE,
REVOKED
​
sortBy
enum<string>
default:lastUsedAt

Field to sort by.

Available options:
lastUsedAt,
createdAt,
refreshExpiresAt
​
sortOrder
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation.

Response

OK

​
data
object[]
required
​
meta
object
required

Page-based pagination metadata.