Get participants

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

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Responses

🟢200OK

application/json

Body

array of:

username

string

required

Username of the user.

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

Delete quest

Accept quest