Skip to main content
GET
/
challenges
Get paginated challenges
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/admin/challenges \
  --header 'x-api-token: <api-key>'
{
  "totalCount": 123,
  "edges": [
    {
      "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 challenges in. If not provided, the default language for the organisation will be used.

Query Parameters

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

Response

Successful response

totalCount
number
required
edges
Challenge · object[]
required
I