Prizes
The Prizes API provides a comprehensive set of endpoints to create prizes and achievements to be earned by users
Query parameters
ownedOnlystringRequired
Only return items owned by the user
pagenumberOptional
limitnumberOptional
Responses
200Success
400
Generic Client Error
application/json
401
Authentication related errors:
- `GENERIC_UNAUTHORIZED`: Generic unauthorized access error.
- `SESSION_TOKEN_EXPIRED`: User session has expired.
- `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
get
GET /v1/inventory/prizes?ownedOnly=text HTTP/1.1
Host:
Accept: */*
No content
Responses
200Success
400
Generic Client Error
application/json
401
Authentication related errors:
- `GENERIC_UNAUTHORIZED`: Generic unauthorized access error.
- `SESSION_TOKEN_EXPIRED`: User session has expired.
- `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
get
GET /v1/inventory/prizes/requirements HTTP/1.1
Host:
Accept: */*
No content
Path parameters
prizeIdstringRequired
Responses
200Success
400
Generic Client Error
application/json
401
Authentication related errors:
- `GENERIC_UNAUTHORIZED`: Generic unauthorized access error.
- `SESSION_TOKEN_EXPIRED`: User session has expired.
- `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
get
GET /v1/inventory/prizes/{prizeId} HTTP/1.1
Host:
Accept: */*
No content
Path parameters
prizeIdstringRequired
Responses
200Success
400
Generic Client Error
application/json
401
Authentication related errors:
- `GENERIC_UNAUTHORIZED`: Generic unauthorized access error.
- `SESSION_TOKEN_EXPIRED`: User session has expired.
- `REFRESH_TOKEN_EXPIRED`: Refresh token has expired.
application/json
404
Generic not found
application/json
500
Internal server error
application/json
get
GET /v1/inventory/prizes/{prizeId}/supply HTTP/1.1
Host:
Accept: */*
No content
Last updated