Skip to main content
GET
/
users
Get paginated users
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/admin/users \
  --header 'x-api-token: <api-key>'
{
  "totalCount": 123,
  "edges": [
    {
      "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>"
    }
  ]
}

Authorizations

x-api-token
string
header
required

Query Parameters

limit
integer
default:10
Required range: 1 <= x <= 100
skip
integer
default:0
Required range: x >= 0

Response

Successful response

totalCount
number
required
edges
User · object[]
required
I