Get a challenge by id (manager)

GET /manager/challenges/{id}

Path parameters

  • id integer(int32) Required

    The id of the challenge

Responses

  • 200 application/json

    Returns the challenge

    Hide response attributes Show response attributes object
    • id integer
    • start_date string(date-time)
    • end_date string(date-time)
    • active boolean
    • challengeable_type string
    • challengeable object

      One of:
    • points integer
    • proportional_points boolean
    • titles array[object]
      Hide titles attributes Show titles attributes object
      • id_i18n_content integer
      • lang string

        Values are en_GB, fr_FR, es_ES, or de_DE.

      • content string
    • images array[object]
      Hide images attributes Show images attributes object
      • id_i18n_content integer
      • lang string

        Values are en_GB, fr_FR, es_ES, or de_DE.

      • content string
    • descriptions array[object]
      Hide descriptions attributes Show descriptions attributes object
      • id_i18n_content integer
      • lang string

        Values are en_GB, fr_FR, es_ES, or de_DE.

      • content string
  • 401 application/json

    Unauthorized.

    Hide response attribute Show response attribute object
    • message string
  • 403

    Forbidden - You don't have permission to access this route

  • 404

    Not found

GET /manager/challenges/{id}
curl \
 --request GET 'https://domain.tld/api/v2/manager/challenges/{id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "id": 42,
  "start_date": "2025-05-04T09:42:00Z",
  "end_date": "2025-05-04T09:42:00Z",
  "active": true,
  "challengeable_type": "string",
  "challengeable": {
    "order_attribution": "string",
    "product_sku": "string"
  },
  "points": 42,
  "proportional_points": true,
  "titles": [
    {
      "id_i18n_content": 42,
      "lang": "en_GB",
      "content": "Hello"
    }
  ],
  "images": [
    {
      "id_i18n_content": 42,
      "lang": "en_GB",
      "content": "Hello"
    }
  ],
  "descriptions": [
    {
      "id_i18n_content": 42,
      "lang": "en_GB",
      "content": "Hello"
    }
  ]
}
Response examples (401)
{
  "message": "Unauthorized."
}