Get quest

Returns the quest with the specified ID.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

string <uuid>

required

Quest ID

Query Params

includeTemplate

boolean

optional

Whether to include the template of the quest.

Example:

false

Header Params

Origin

string

required

The value must be one of the whitelisted domains. You can whitelist domain URLs on your Loyi dashboard.

Default:

<WHITELISTED_URL>

Example:

https://example.com

Responses

🟢200OK

application/json

Body

string <uuid>

required

publicId

string

required

title

string

required

Title of the quest

instruction

string

required

Instruction text of the quest.

completionMessage

string

required

Message for the user when the quest is completed.

isActive

boolean

required

Is the quest active.

Default:

true

type

enum<string>

required

Type of the quest.

Allowed values:

CollectionQuizQuestionnaire

steps

number

required

Number of steps in the quest.

rewards

object

required

points

number

optional

Points that the user gets for completing the quest.

rewards

array[null (Reward) {3}]

optional

collections

array[object (Collection) {11}]

optional

templateId

string <uuid>

required

template

required

One of

CollectionQuestTemplate

QuizQuestTemplate

QuestionnaireQuestTemplate

Example:

{"id":"12345678-1234-1234-1234-123456789012","collectionIds":["12345678-1234-1234-1234-123456789012"],"createdAt":"2020-01-01T00:00:00.000Z","updatedAt":"2020-01-01T00:00:00.000Z"}

collectionIds

array[string <uuid>]

required

IDs of the collections that are the steps of the quest.

string <uuid>

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

Example

{
    "id": "12345678-1234-1234-1234-123456789012",
    "title": "My Quest",
    "instruction": "My Instruction",
    "completionMessage": "My Completion Message",
    "isActive": true,
    "publicId": "12345678",
    "type": "Collection",
    "steps": 1,
    "rewards": {
        "points": 25,
        "rewards": [
            {
                "id": "123e4567-e89b-12d3-a456-426655440000",
                "title": "Event Entry Pass",
                "description": "An entry pass for the event",
                "instruction": "Show this pass at the event entrance",
                "type": "EntryPass",
                "createdAt": "2022-01-01T00:00:00.000Z",
                "updatedAt": "2022-01-01T00:00:00.000Z"
            }
        ],
        "collections": [
            {
                "id": "123e4567-e89b-12d3-a456-426655440000",
                "publicId": "kdPd_ntE",
                "name": "My Collection",
                "description": "A collection of rewards",
                "image": "https://example.com/image.jpg",
                "amount": 10,
                "collectible": {
                    "imagesURL": "ipfs://example",
                    "metadataURL": "ipfs://example"
                },
                "type": "oneToOne",
                "contractAddress": "0x7B5DF6F27C32cEa2CeF2c4E812c0Ff4d0515B26B",
                "createdAt": "2021-01-01T00:00:00.000Z",
                "updatedAt": "2021-01-01T00:00:00.000Z"
            }
        ]
    },
    "templateId": "12345678-1234-1234-1234-123456789012",
    "template": {
        "collectionIds": [
            "12345678-1234-1234-1234-123456789012"
        ]
    },
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z"
}

🟠401Unauthorized

🟠404Record Not Found

Request

Request samples

Responses