v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

List Quests

get/quests

Query parameters

client_idstring required

attributesstring

key value pair to filter out quest based on attributes, should be used like ?attributes=key1:value1&attributes=key2:value2

has_profile_groupsboolean

filters quests based on whether they have profile groups linked with them or not.

profile_idstring

returns quests that have profile groups associated to a quest which this profile is part of.

profile_group_idstring

returns quests that are linked to this profile group id. ?profile_group_id=group1&profile_group_id=group2, will returns all of the quests that have both the groups attached.

include_publicboolean

Adds quests that does not have any profile group associated, can only be used with profile_group_id or profile_id.

has_ab_testboolean

Returns Quests that have ab-test enabled, if not provided it returns both types of quests.

ab_test_idstring

Returns Quests with specific ab_test_id

Response

200

countinteger

{"stackTrail":"paths:/quests:get:responses:200:content:application/json:schema:properties:next","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/quests:get:responses:200:content:application/json:schema:properties:previous","oasType":"schema","type":"unknown"}

Example response

{
  "count": 1,
  "results": [
    {
      "id": "0d45b284-2dbf-48c1-b41d-0a6004faba78",
      "url": "https://cf-blast.livelikecdn.com/api/v1/quests/0d45b284-2dbf-48c1-b41d-0a6004faba78/",
      "client_id": "cPMSTBaKAeBeVUjabYcqKsEIXljy7NpcPfMU366A",
      "name": "29AugTest",
      "description": "abc",
      "quest_tasks": [
        {
          "id": "2d7a000a-0e55-41de-9dcd-b663554bf421",
          "url": "https://cf-blast.livelikecdn.com/api/v1/quest-tasks/2d7a000a-0e55-41de-9dcd-b663554bf421/",
          "name": "1",
          "description": "a123",
          "quest_id": "0d45b284-2dbf-48c1-b41d-0a6004faba78",
          "target_value": 10,
          "default_progress_increment": 2,
          "created_at": "2022-08-29T08:47:12.438072Z"
        }
      ],
      "attributes": [
        {
          "key": "key1",
          "value": "value1"
        }
      ],
      "quest_rewards_url": "https://cf-blast.livelikecdn.com/api/v1/quest-rewards/",
      "created_at": "2022-08-29T08:47:12.422503Z",
      "profile_groups": [
        {
          "id": "85babc2d-d1a1-408d-bfe2-c695d1d65106",
          "name": "test 1",
          "is_active": true,
          "description": "abc",
          "created_at": "2025-04-07T07:46:22.065148Z"
        }
      ],
      "profile_group_ids": [
        "85babc2d-d1a1-408d-bfe2-c695d1d65106"
      ]
    }
  ]
}