Skip to main content
GET
/
me
Get my info
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/me \
  --header 'x-api-token: <api-key>'
{
  "id": "<string>",
  "organisationId": "<string>",
  "username": "<string>",
  "displayName": "<string>",
  "bio": "<string>",
  "profilePictureUrl": "<string>",
  "emailVerified": "<string>",
  "locale": "<string>",
  "points": 123,
  "keys": 123,
  "xp": {
    "total": 1,
    "knowledge": 1,
    "creativity": 1,
    "loyalty": 1,
    "influence": 1,
    "participation": 1,
    "contribution": 1
  },
  "communityData": [
    {
      "communityId": "<string>",
      "streak": {
        "currentStreak": 1,
        "lastExtendedAt": "<string>",
        "longestStreak": 1
      },
      "challengesCompleted": 1,
      "achievementsCompleted": 1,
      "points": 123,
      "xp": {
        "total": 1,
        "knowledge": 1,
        "creativity": 1,
        "loyalty": 1,
        "influence": 1,
        "participation": 1,
        "contribution": 1
      },
      "hasAcceptedRules": true
    }
  ],
  "createdAt": "<string>",
  "socialHandles": {
    "instagram": "<string>",
    "loyaltyCardNumber": "<string>",
    "tiktok": "<string>"
  },
  "roles": [
    "<string>"
  ],
  "email": "<string>",
  "fullName": "John Doe",
  "parentEmail": "<string>",
  "birthDay": 123,
  "birthMonth": 123,
  "birthYear": 123,
  "externalUserId": "<string>",
  "isAnonymous": true,
  "level": 1,
  "completedChallenges": 0,
  "earnedRewards": 0,
  "enteredGiveaways": 0
}

Authorizations

x-api-token
string
header
required

Response

Successful response

A user

id
string
required
username
string
required
points
number
required
keys
number
required
xp
object
required

User XP Breakdown

communityData
object[]
required
createdAt
string
required
roles
string[]
required
email
string
required
isAnonymous
boolean
required
level
number
default:1
required

User's current level, calculated based on total XP earned

Required range: x >= 0
completedChallenges
number
default:0
required

Total number of challenges completed by the user

Required range: x >= 0
earnedRewards
number
default:0
required

Total number of rewards earned by the user

Required range: x >= 0
enteredGiveaways
number
default:0
required

Total number of giveaways the user has entered

Required range: x >= 0
organisationId
string | null
displayName
string | null
bio
string | null
profilePictureUrl
string | null
emailVerified
string | null
locale
string | null
socialHandles
object

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
I