Loyi API Reference
  1. Collection
Loyi API Reference
  • Getting Started
  • Architecture
  • User
    • Users Overview
    • Create user
      POST
    • Get users
      GET
    • Get user
      GET
    • Update user
      PUT
    • Delete user
      DELETE
  • Reward
    • Rewards Overview
    • Create reward
      POST
    • Get rewards
      GET
    • Delete reward
      DELETE
    • Create entry pass code
      POST
    • Get entry pass code
      GET
    • Airdrop reward
      PUT
    • Award reward
      POST
    • Redeem rewards
      GET
  • Collection
    • Collection Overview
    • Create collection
      POST
    • Get collections
      GET
    • Get collection
      GET
    • Update collection
      PUT
    • Delete collection
      DELETE
    • Get rewards
      GET
  • Collectible
    • Claim collectible
      POST
    • Get collectibles
      GET
  • Quest
    • Quest Overview
    • Create quest
    • Get quests
    • Get quest
    • Update quest
    • Delete quest
    • Get participants
    • Accept quest
    • Submit answers
    • Get answers
  • Leaderboard
    • Leaderboard Overview
    • Get leaderboard
  • Leveling
    • Get leveling configuration
    • Configure leveling
    • Get milestone levels
    • Create milestone level
    • Get milestone level
    • Update milestone level
    • Delete milestone level
  1. Collection

Get rewards

Staging
https://testserver.loyi.io/public/api
Staging
https://testserver.loyi.io/public/api
GET
/collection/{id}/rewards
Collection
Returns all the rewards that have been airdropped to the collection with the specified ID.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Path Params
id
string <uuid>
required
Collection ID
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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://testserver.loyi.io/public/api/collection//rewards' \
--header 'Origin;' \
--header 'x-api-key;'

Responses

🟢200OK
application/json
Ok
Body
array[null (Reward) {3}] 
optional
object 
CouponLinkUnique
optional
Example:
{"id":"123e4567-e89b-12d3-a456-426655440000","code":null,"title":"Unique Coupon","description":"A special reward with unique coupons","instruction":"Use these coupons to get discounts","type":"CouponLinkUnique","link":"https://example.com","coupons":[{"code":"coupon1"},{"code":"coupon2"}],"createdAt":"2022-01-01T00:00:00.000Z","updatedAt":"2022-01-01T00:00:00.000Z"}
title
string 
required
Title of the reward.
description
string 
required
Description of the reward.
instruction
string 
required
Instruction text of the reward.
link
string <uri>
required
Link of the reward.
id
string <uuid>
required
type
enum<string> 
required
Allowed value:
CouponLinkUnique
coupons
array [object {1}] 
required
createdAt
string <date-time>
required
updatedAt
string <date-time>
required
object 
CouponLinkGeneric
optional
Example:
{"id":"123e4567-e89b-12d3-a456-426655440000","code":"GENERICCODE123","title":"Generic Coupon","description":"A general reward with a coupon code","instruction":"Use this coupon to get a discount","type":"CouponLinkGeneric","link":"https://example.com","createdAt":"2022-01-01T00:00:00.000Z","updatedAt":"2022-01-01T00:00:00.000Z"}
title
string 
required
Title of the reward.
description
string 
required
Description of the reward.
instruction
string 
required
Instruction text of the reward.
link
string <uri>
required
Link of the reward.
id
string <uuid>
required
type
enum<string> 
required
Allowed value:
CouponLinkGeneric
code
string 
required
Coupon code of the reward.
createdAt
string <date-time>
required
updatedAt
string <date-time>
required
object 
EntryPass
optional
Example:
{"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"}
title
string 
required
Title of the reward.
description
string 
required
Description of the reward.
instruction
string 
required
Instruction text of the reward.
id
string <uuid>
required
type
enum<string> 
required
Allowed value:
EntryPass
createdAt
string <date-time>
required
updatedAt
string <date-time>
required
Example
[
    {
        "id": "123e4567-e89b-12d3-a456-426655440000",
        "code": null,
        "title": "Unique Coupon",
        "description": "A special reward with unique coupons",
        "instruction": "Use these coupons to get discounts",
        "type": "CouponLinkUnique",
        "link": "https://example.com",
        "coupons": [
            {
                "code": "coupon1"
            },
            {
                "code": "coupon2"
            }
        ],
        "createdAt": "2022-01-01T00:00:00.000Z",
        "updatedAt": "2022-01-01T00:00:00.000Z"
    }
]
🟠401Unauthorized
🟠404Record Not Found
Modified at 2025-06-19 21:23:41
Previous
Delete collection
Next
Claim collectible
Built with