Skip to main content
GET
/
challenge-groups
/
{challengeGroupId}
Get challenge group by ID
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/challenge-groups/{challengeGroupId} \
  --header 'x-api-token: <api-key>'
{
  "id": "<string>",
  "organisationId": "<string>",
  "communityId": "<string>",
  "details": {
    "title": "<string>",
    "description": "<string>",
    "light": {},
    "dark": {}
  },
  "type": "random",
  "period": "daily",
  "challengeIds": [
    "<string>"
  ],
  "activeAmount": 2,
  "status": "archived",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "challenges": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "communityId": "<string>",
      "additionalCommunityIds": [
        "<string>"
      ],
      "details": {
        "title": "<string>",
        "description": "<string>",
        "light": {},
        "dark": {}
      },
      "progressPeriod": "daily",
      "maxCompletionsPerPeriod": 1,
      "numberOfActions": 1,
      "actionIds": [
        "<string>"
      ],
      "challengeType": "survey",
      "enabledForSingleView": true,
      "actionGroups": [
        {
          "id": "<string>",
          "parentGroupId": "<string>",
          "type": "single",
          "displayType": "list",
          "details": {
            "title": "<string>",
            "description": "<string>",
            "light": {},
            "dark": {}
          }
        }
      ],
      "status": "archived",
      "startDate": "<string>",
      "endDate": "<string>",
      "featured": true,
      "threadId": "<string>",
      "isSkippable": true,
      "isLinear": true,
      "unlockPrice": 1,
      "tags": [
        {
          "id": "<string>",
          "organisationId": "<string>",
          "value": "<string>",
          "config": {
            "filtering": [
              "achievement"
            ],
            "display": [
              "achievement"
            ],
            "iconifyIcon": "<string>"
          },
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "campaigns": [
        {
          "id": "<string>",
          "organisationId": "<string>",
          "name": "<string>",
          "startDate": "<string>",
          "endDate": "<string>",
          "status": "archived",
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "availableAsTemplateForOrganisations": [
        "<string>"
      ],
      "isGlobalTemplate": true,
      "startsAt": "<string>",
      "expiresAt": "<string>",
      "groupIds": [
        "<string>"
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "videoConfig": {
        "videoUrl": "<string>",
        "isVideoEnabled": true
      },
      "actions": [
        {
          "id": "<string>",
          "organisationId": "<string>",
          "communityId": "<string>",
          "allocationId": "<string>",
          "allocatedTo": "achievement",
          "actionGroupId": "<string>",
          "actionGroupIndex": 123,
          "position": 123,
          "category": "nudj",
          "key": "facebook-comment",
          "details": {
            "title": "<string>",
            "description": "<string>",
            "light": {
              "primaryImageUrl": "<any>",
              "secondaryImageUrl": "<any>"
            },
            "dark": {
              "primaryImageUrl": "<any>",
              "secondaryImageUrl": "<any>"
            }
          },
          "progressPeriod": "daily",
          "maxCompletionsPerPeriod": 1,
          "attributes": "<any>",
          "config": {
            "isOptional": true,
            "socialValidation": "validation-on",
            "prerequisites": {
              "requiredActionCount": 123,
              "actionIds": [
                "<string>"
              ]
            },
            "requiresCorrectAnswer": true
          },
          "videoMetadata": {
            "startsAtMs": 1,
            "shouldPause": true,
            "validatesAtMs": 1,
            "endsAtMs": 1
          },
          "createdAt": "<string>",
          "availableAsTemplateForOrganisations": [
            "<string>"
          ],
          "isGlobalTemplate": true,
          "previousAction": "<string>",
          "nextAction": "<string>",
          "stats": {
            "totalXp": 123
          },
          "reward": {
            "points": 1,
            "completionXp": 1,
            "items": [
              {
                "id": "<string>",
                "details": {
                  "title": "<string>",
                  "description": "<string>",
                  "light": {},
                  "dark": {}
                },
                "type": "assets",
                "amountToDistribute": 1,
                "totalSupply": 1,
                "remainingSupply": 1
              }
            ],
            "rewardSelectionMethod": "all",
            "numberOfRewardsToReceive": 1,
            "distributionEventId": "<string>"
          },
          "userState": {
            "criteriaMet": true,
            "status": "completed",
            "statusMessage": "<string>",
            "eligibleXp": 123,
            "earnedXp": 123,
            "attempts": 123,
            "output": "<any>",
            "unmetCriteriaMessage": "<string>"
          },
          "participations": [
            {
              "id": "<string>",
              "criteriaMet": true,
              "output": "<any>",
              "status": "pending",
              "participatedAt": "<string>",
              "processingStartedAt": "<string>",
              "processedAt": "<string>",
              "unmetCriteriaMessage": "<string>",
              "processingFailedMessage": "<string>"
            }
          ]
        }
      ],
      "community": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "slug": "<string>",
        "logo": "<string>"
      },
      "participantStats": {
        "startedCount": 1,
        "completedCount": 1
      },
      "stats": {
        "totalXp": 1,
        "totalActionsCount": 1
      },
      "reward": {
        "points": 1,
        "completionXp": 1,
        "items": [
          {
            "id": "<string>",
            "details": {
              "title": "<string>",
              "description": "<string>",
              "light": {},
              "dark": {}
            },
            "type": "assets",
            "amountToDistribute": 1,
            "totalSupply": 1,
            "remainingSupply": 1
          }
        ],
        "rewardSelectionMethod": "all",
        "numberOfRewardsToReceive": 1,
        "distributionEventId": "<string>"
      },
      "userState": {
        "status": "completed",
        "completionsInPeriod": 0,
        "totalCompletions": 0,
        "keysContributed": 0,
        "latestAttempt": {
          "eligibleXp": 0,
          "actionsCompletedCount": 0,
          "startedAt": "<string>",
          "earnedXp": 0,
          "earnedPoints": 0,
          "earnedRewardAssets": [
            {
              "rewardAssetId": "<string>",
              "rewardId": "<string>"
            }
          ],
          "earnedRewardEntries": [
            {
              "rewardEntryId": "<string>",
              "rewardId": "<string>",
              "amount": 1
            }
          ],
          "completionTime": 0,
          "successRate": 0
        },
        "historicAttempts": []
      }
    }
  ]
}

Authorizations

​
x-api-token
string
header
required

Headers

​
x-language
string

The language to return the challenge group in. If not provided, the default language for the organisation will be used.

Path Parameters

​
challengeGroupId
string
required

Response

Successful response

Challenge group with filtered challenges for integration API

​
id
string
required

The id of the challenge group

​
organisationId
string
required

The id of the organisation the challenge group belongs to

​
communityId
string
required

The id of the community the challenge group belongs to

​
details
object
required

Used to describe an entity

​
type
enum<string>
required

The challenge selection type

Available options:
random,
sequential
​
period
enum<string>
required

The rotation period

Available options:
daily,
weekly,
monthly,
yearly,
open
​
challengeIds
string[]
required

The challenge IDs in this group

​
activeAmount
number
required

Number of active challenges to show

Required range: x >= 1
​
status
enum<string>
required

The challenge group status

Available options:
archived,
draft,
expired,
live,
scheduled
​
createdAt
string
required

The creation date of the challenge group

​
challenges
Challenge · object[]
required

FILTERED challenges based on group type/settings and user progress

​
updatedAt
string | null

The update date of the challenge group

⌘I