Available Quests

Get all quests available to a program membership with their status

get

Returns all quests the user has access to (based on segments) along with their current status. Also includes quests the user has already opted into, even if expired or no longer accessible.

Status values:

• available: Quest is live and user has not opted in

• upcoming: Quest is published but starts_at is in the future

• opted_in: User has opted in but no progress yet

• in_progress: User has made progress on the quest

• completed: All requirements met

• prize_claimed: Prize has been claimed

• expired: Quest has ended (ends_at < now) without completion

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

program_membership_idstringRequired

The ID of the program membership.

Query parameters

statusstring[]Optional

Filter by quest status. Can be a single status or array of statuses. Valid values: available, opted_in, in_progress, completed, prize_claimed, expired, upcoming. If not provided, returns all quests.

Responses

200

Successful response

application/json

get

/v2/program-memberships/{program_membership_id}/quests

HTTPcURLJavaScriptPython

GET /partner-api/v2/program-memberships/{program_membership_id}/quests HTTP/1.1
Host: 
X-API-Key: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "quests": [
    {
      "quest": {
        "id": "text",
        "name": "text",
        "priority": 1,
        "description": "text",
        "sponsor_name": "text",
        "image_url": "text",
        "point_threshold_requirement": 1,
        "opt_in_text": "text",
        "time_to_complete_minutes": 1,
        "starts_at": 1,
        "ends_at": 1,
        "max_num_of_completions": 1,
        "created_at": 1,
        "opt_in": {
          "id": "text",
          "created_at": 1,
          "expires_at": 1,
          "status": "text",
          "archived_at": 1,
          "progress": [
            {
              "activity_id": "text",
              "value": 1,
              "updated_at": 1,
              "fulfilled_at": 1,
              "prize_claimed_at": 1,
              "calendar_intervals_met": 1
            }
          ]
        },
        "activities": [
          {
            "id": "text",
            "description": "text",
            "value_threshold": 1,
            "order": 1,
            "check_in_interval_days": 1,
            "image_url": "text",
            "prize": {
              "point_reward_value": 1,
              "sponsor_name": "text",
              "lootbox": {
                "id": "text",
                "name": "text",
                "description": "text",
                "background_gradient_start_color": "text",
                "background_gradient_stop_color": "text",
                "container_images": {
                  "box_together": "text",
                  "box_top": "text",
                  "box_bottom": "text"
                },
                "lootbox_reward_choices": [
                  {
                    "id": "text",
                    "title": "text",
                    "subtitle": "text",
                    "category": "text",
                    "point_reward_value": 1,
                    "reward_uuid": "text",
                    "image": "text",
                    "probability": 1
                  }
                ],
                "metadata": {
                  "ANY_ADDITIONAL_PROPERTY": "anything"
                }
              },
              "reward": {
                "uuid": "text",
                "name": "text",
                "description": "text",
                "image_url": "text",
                "terms_and_conditions": "text"
              }
            },
            "cta_url": "text",
            "cta_text": "text",
            "activity_type_name": "text",
            "calendar_interval": "text",
            "intervals_required_to_complete": 1,
            "interval_number": 1,
            "interval_value": 1,
            "interval_completed": true
          }
        ],
        "prize": {
          "point_reward_value": 1,
          "sponsor_name": "text",
          "lootbox": {
            "id": "text",
            "name": "text",
            "description": "text",
            "background_gradient_start_color": "text",
            "background_gradient_stop_color": "text",
            "container_images": {
              "box_together": "text",
              "box_top": "text",
              "box_bottom": "text"
            },
            "lootbox_reward_choices": [
              {
                "id": "text",
                "title": "text",
                "subtitle": "text",
                "category": "text",
                "point_reward_value": 1,
                "reward_uuid": "text",
                "image": "text",
                "probability": 1
              }
            ],
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "reward": {
            "uuid": "text",
            "name": "text",
            "description": "text",
            "image_url": "text",
            "terms_and_conditions": "text"
          }
        },
        "terms_and_conditions": "text",
        "claim_prize_customization": {
          "header_text": "text",
          "message": "text",
          "cta": "text"
        },
        "auto_claim_prize": true,
        "calendar_interval": "text",
        "challenge_type": "text"
      },
      "status": "text"
    }
  ]
}