Details

The Quest Events API provides a comprehensive set of endpoints to interact with quest events a community has created.

Quest Event

Retrieve quest event details using either its id or slug

get
Path parameters
eventIdstringRequired

The id or slug of the event

Responses
400
Generic Client Error
application/json
get
GET /v1/quest-event/{eventId} HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Quest Events

Retrieve a list of events

get

Retrieve a list of events. Flags can be combined to return events open to register or/and with user participating.

Query parameters
pagenumberOptional
limitnumberOptional
participatingbooleanOptional

Return only events the user is participating in

registrationOpenbooleanOptional

Return only events open to register

filterobjectOptional

Additional filters for the events

Example: {"containerId":"containerId","features":"true","status":["active","completed"]}
itemIdstringOptional

Filter events by itemId

resourceIdstringOptional

Filter events by resourceId

Responses
400
Generic Client Error
application/json
get
GET /v1/quest-event HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Quest Event Leaderboard

Retrieve the leaderboard for a quest event (paginated)

get
Path parameters
idstringRequired
Query parameters
pagenumberOptional
limitnumberOptional
Responses
400
Generic Client Error
application/json
get
GET /v1/quest-event/{id}/leaderboard HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Quest Event Quests

Retrieve a list of quests for a quest event

get
Path parameters
idstringRequired
Responses
400
Generic Client Error
application/json
get
GET /v1/quest-event/{id}/quests HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Quest Event Rewards

Upon successful completion of a quest event a user will be allocated tickets that can be used to claim rewards associated to the quest event. The allocation endpoints return information about these tickets and previously submitted requirement data that fulfils configured requirements.

Get Reward Allocations

List rewards allocated to a participant for an event

get
Path parameters
eventIdstringRequired
Responses
400
Generic Client Error
application/json
get
GET /v1/quest-event/{eventId}/reward/allocations HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Claim Reward Allocation

Claim a reward allocation for an event

post
Path parameters
rewardAllocationIdstringRequired
Body
emailstringOptional
walletAddressstringOptional
Responses
400
Generic Client Error
application/json
post
POST /v1/quest-event/{eventId}/reward/allocations/claim/{rewardAllocationId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 202

{
  "email": "text",
  "walletAddress": "text",
  "address": {
    "addressId": "text",
    "addressLine1": "text",
    "addressLine2": "text",
    "addressLine3": "text",
    "city": "text",
    "state": "text",
    "postalCode": "text",
    "country": "text"
  }
}
{
  "code": 10002,
  "message": "generic_client_error"
}

PreviousQuest EventsNextParticipation

Last updated