Skip to main content
GET
/
challenges
/
{challengeId}
Get challenge by ID
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/admin/challenges/{challengeId} \
  --header 'x-api-token: <api-key>'
{
  "id": "<string>",
  "organisationId": "<string>",
  "communityId": "<string>",
  "additionalCommunityIds": [
    "<string>"
  ],
  "details": {
    "title": "<string>",
    "description": "<string>",
    "light": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    },
    "dark": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    }
  },
  "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": {
          "primaryImageUrl": "<string>",
          "secondaryImageUrl": "<string>"
        },
        "dark": {
          "primaryImageUrl": "<string>",
          "secondaryImageUrl": "<string>"
        }
      }
    }
  ],
  "status": "archived",
  "startDate": "<string>",
  "endDate": "<string>",
  "featured": true,
  "threadId": "<string>",
  "isSkippable": true,
  "isLinear": true,
  "unlockPrice": 1,
  "tags": [
    "<string>"
  ],
  "campaigns": [
    "<string>"
  ],
  "availableAsTemplateForOrganisations": [
    "<string>"
  ],
  "isGlobalTemplate": true,
  "startsAt": "<string>",
  "expiresAt": "<string>",
  "groupIds": [
    "<string>"
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "videoConfig": {
    "videoUrl": "<string>",
    "isVideoEnabled": true
  }
}

Authorizations

x-api-token
string
header
required

Headers

x-language
string

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

Path Parameters

challengeId
string
required

Response

Successful response

A challenge

id
string
required

The id of the challenge

organisationId
string
required

The id of the organisation the challenge belongs to

communityId
string
required

The id of the community the challenge belongs to

additionalCommunityIds
string[]
required

The ids of any additional communities the challenge belongs to

details
object
required

Used to describe an entity

progressPeriod
enum<string>
required

The progress period of the challenge

Available options:
daily,
weekly,
monthly,
yearly,
open
maxCompletionsPerPeriod
required

The maximum number of completions per period for the challenge

Required range: x >= 0
numberOfActions
number
required

The number of actions in the challenge

Required range: x >= 0
actionIds
string[]
required

The ids of the actions in the challenge

actionGroups
ActionGroup · object[]
required

The action groups of the challenge

status
enum<string>
required

The status of the challenge

Available options:
archived,
draft,
expired,
live,
scheduled
isLinear
boolean
required

Whether the challenge must be completed in sequential order

unlockPrice
number
required

The number of keys required to unlock this challenge

Required range: x >= 0
tags
string[]
required

The tags of the challenge

campaigns
string[]
required

The campaigns of the challenge

availableAsTemplateForOrganisations
string[]
required

The organisations that the challenge is available as a template for

isGlobalTemplate
boolean
required

Whether the challenge is a global template

groupIds
string[]
required

The challenge groups the challenge belongs to

createdAt
string
required

The creation date of the challenge

videoConfig
object | null
required

Video configuration for challenges with video content

challengeType
enum<string> | null

The type of the challenge

Available options:
survey
enabledForSingleView
boolean | null

Whether the challenge is enabled for single view

startDate
string | null

Deprecated use startsAt instead

endDate
string | null

Deprecated use expiresAt instead

threadId
string | null

The thread id of the challenge

isSkippable
boolean | null

Whether the challenge is skippable

startsAt
string | null

The start date of the challenge

expiresAt
string | null

The expiry date of the challenge

updatedAt
string | null

The update date of the challenge

I