Get quests - Loyi API Reference

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://testserver.loyi.io/public/api/quest' \
--header 'Origin;' \
--header 'x-api-key: <api-key>'

Responses

🟢200OK

application/json

A JSON array of quests.

Body

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