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.

Path Parameters

id
string
required

The user's ID in your database.

Query Parameters

year
integer

The year to get wrapped data for. Defaults to the current year. Must be an integer between 1 and the current year.

Required range: x >= 1

Response

Successful operation

A user's year-in-review wrapped data including activity summaries, metrics, points, achievements, streaks, and leaderboard rankings.

user
User · object
required

The user's profile information.

activity
WrappedActivity · object
required

The user's activity data for the wrapped year.