Authorizations
Body
application/json
Response
Successful response
A user
User XP Breakdown
Social media handles and loyalty information for a user
Example:
"John Doe"
curl --request POST \
--url https://{subdomain}.nudj.cx/api/v2/admin/users \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '{
"email": "<string>",
"username": "<string>",
"displayName": "<string>",
"profilePictureUrl": "<string>",
"externalUserId": "<string>"
}'
{
"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,
"updatedAt": "<string>"
}
Create a new user.
curl --request POST \
--url https://{subdomain}.nudj.cx/api/v2/admin/users \
--header 'Content-Type: application/json' \
--header 'x-api-token: <api-key>' \
--data '{
"email": "<string>",
"username": "<string>",
"displayName": "<string>",
"profilePictureUrl": "<string>",
"externalUserId": "<string>"
}'
{
"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,
"updatedAt": "<string>"
}
Successful response
A user
User XP Breakdown
Show child attributes
Show child attributes
Social media handles and loyalty information for a user
Show child attributes
"John Doe"
Was this page helpful?