Loyi API Reference
  1. Quest
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
    • Get collections
    • Get collection
    • Update collection
    • Delete collection
    • Get rewards
  • Collectible
    • Claim collectible
    • Get collectibles
  • Quest
    • Quest Overview
    • Create quest
      POST
    • Get quests
      GET
    • Get quest
      GET
    • Update quest
      PUT
    • Delete quest
      DELETE
    • Get participants
      GET
    • Accept quest
      POST
    • Submit answers
      POST
    • Get answers
      GET
  • 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. Quest

Get participants

Staging
https://testserver.loyi.io/public/api
Staging
https://testserver.loyi.io/public/api
GET
/quest/{id}/participants
Quest
Returns a list of all the participants and the title of the quest with the specified ID.

Request

Authorization
Add parameter in header
x-api-key
Example:
x-api-key: ********************
Path Params
id
string <uuid>
required
Quest 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/quest//participants' \
--header 'Origin;' \
--header 'x-api-key;'

Responses

🟢200OK
application/json
Ok
Body
array of:
username
string 
required
Username of the user.
email
string <email>
required
Email of the user.
progress
number 
required
Number of steps completed by the user in the quest.
steps
number 
required
Number of steps in the quest.
status
enum<string> 
required
Status of the user participating in the quest.
Allowed values:
startedpassedfailed
startedAt
string <date-time>
required
Date when the user accepted the quest.
Example
[
    {
        "username": "testuser",
        "email": "4JqgK@example.com",
        "progress": 0,
        "steps": 10,
        "status": "Started",
        "startedAt": "2022-01-01T00:00:00.000Z"
    }
]
🟠401Unauthorized
🟠404Record Not Found
Modified at 2025-06-19 21:23:41
Previous
Delete quest
Next
Accept quest
Built with