Get milestone levels

Staging

https://testserver.loyi.io/public/api

GET

/leveling/milestone

Leveling

Returns a list of all your milestone levels.

Request

Authorization

Add parameter in header

x-api-key

Example:

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

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Responses

🟢200OK

application/json

A JSON array of milestone levels.

Body

array of:

string <uuid>

required

title

string

required

Title of the milestone level.

levelNumber

number

required

Level number of the milestone level.

rewards

object

required

rewards

array[null (Reward) {3}]

optional

collections

array[object (Collection) {11}]

optional

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

Example

[
    {
        "id": "123e4567-e89b-12d3-a456-426655440000",
        "title": "Gold Level",
        "levelNumber": 10,
        "rewards": {
            "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"
                }
            ]
        },
        "createdAt": "2021-01-01T00:00:00.000Z",
        "updatedAt": "2021-01-01T00:00:00.000Z"
    }
]

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-06-19 21:23:41

Configure leveling

Create milestone level