Get User Challenges

GET 
/users/:id/challenges

Gets all challenges for the given user

Request

Path Parameters

id stringrequired

A User ID

Query Parameters

show_historical boolean

Whether to show challenges that are inactive but completed

Responses

200

Success

application/json

Schema

Schema

data

object[]

Array [

challenge_id stringrequired

user_id stringrequired

specifier string

is_complete booleanrequired

is_active booleanrequired

is_disbursed booleanrequired

current_step_count integer

max_steps integer

challenge_type stringrequired

amount stringrequired

disbursed_amount integerrequired

cooldown_days integer

metadata

object

required

]

Example (from schema)

{
  "data": [
    {
      "challenge_id": "string",
      "user_id": "string",
      "specifier": "string",
      "is_complete": true,
      "is_active": true,
      "is_disbursed": true,
      "current_step_count": 0,
      "max_steps": 0,
      "challenge_type": "string",
      "amount": "string",
      "disbursed_amount": 0,
      "cooldown_days": 0,
      "metadata": {}
    }
  ]
}

400

Bad request

500

Server error

Loading...