Skip to main content
GET
JavaScript

Authorizations

X-API-KEY
string
header
required

Headers

Tenant-ID
string

The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. The value should be your internal ID for the tenant. Ignored for single-tenant organisations.

Query Parameters

userIds
string[]
required

A list of up to 100 user IDs.

Response

Successful operation

userId
string
required

The ID of the user.

streakLength
integer
required

The length of the user's streak.

extended
string | null
required

The timestamp the streak was extended, as a string. Null if the streak is not active.