Navigation

Retrieve a challenge

Retrieve the details of an existing challenge. Supply the unique challenge ID from the Rupt SDK onChallenge callback.

Parameters

No parameters

Returns

Returns a challenge object.
GET /v2/challenges/:id
await Rupt.getChallenge(CHALLENGE_ID);
Response
{
  "_id": "649873be6e8b6f9b33722a0c",
  "user": {
    "_id": "649873be6e8b6f9b33722a0c",
    "external_id": "external_account_id",
    "email": "ab*****@rupt.dev",
    "phone": "******34",
  },
  "limit": {
    "is_exceeded": true,
    "overall": 1,
    "mobile": 0,
    "tablet": 0,
    "desktop": 1,
  },
  "status": "pending",
  "reasons": ["limit_exceeded", "concurrency"],
  "createdAt": "2021-09-01T00:00:00.000Z"
}