Skip to main content
GET
Get user by ID

Authorizations

x-api-token
string
header
required

Path Parameters

id
string
required

The ID of the user to get. This can be the internal ID or the external ID.

Response

Successful response

A user

id
string
required
username
string
required
points
number
required
keys
number
required
xp
User XP Breakdown · object
required

User XP Breakdown

communityData
object[]
required
createdAt
string
required
roles
string[]
required
email
string
required
isAnonymous
boolean
required
updatedAt
string
required
organisationId
string | null
displayName
string | null
bio
string | null
profilePictureUrl
string | null
emailVerified
string | null
locale
string | null
socialHandles
SocialHandles · object | null

Social media handles and loyalty information for a user

fullName
string | null
Example:

"John Doe"

parentEmail
string | null
birthDay
number | null
birthMonth
number | null
birthYear
number | null
externalUserId
string | null