Skip to main content
GET
/
challenge-groups
Get paginated challenge groups
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/admin/challenge-groups \
  --header 'x-api-token: <api-key>'
{
  "totalCount": 123,
  "edges": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "communityId": "<string>",
      "details": {
        "title": "<string>",
        "description": "<string>",
        "light": {
          "primaryImageUrl": "<string>",
          "secondaryImageUrl": "<string>"
        },
        "dark": {
          "primaryImageUrl": "<string>",
          "secondaryImageUrl": "<string>"
        }
      },
      "type": "random",
      "period": "daily",
      "challengeIds": [
        "<string>"
      ],
      "activeAmount": 2,
      "status": "archived",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.nudj.cx/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-token
string
header
required

Headers

​
x-language
string

The language to return the challenge groups 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
​
search
string

Response

Successful response

​
totalCount
number
required
​
edges
Challenge Group · object[]
required