Skip to main content
GET
Get my streak progress

Authorizations

x-api-token
string
header
required

Query Parameters

communityId
string

Response

Successful response

id
string
required

The id of the streak config

Pattern: ^[0-9a-fA-F]{24}$
organisationId
string
required

The id of the organisation this streak config belongs to

Pattern: ^[0-9a-fA-F]{24}$
isEnabled
boolean
required

Whether the streak is enabled and users can start and extend streaks.

triggerEvents
object
required
userState
object
required
communityId
string | null

The id of the community this streak config belongs to. No community means this is an organisation level streak config.

Pattern: ^[0-9a-fA-F]{24}$