Skip to main content

Get All Prizes

This endpoint retrieves all prizes

info

This operation requires authentication and admin or editor role to filter active prizes.

HTTP Request

GET /api/v2/loyalty/prize/

Parameters

NameInTypeRequiredDescription
limitqueryintegerfalseNumber of results to return per page.
offsetqueryintegerfalseThe initial index from which to return the results.
searchquerystringfalseA search term.
activequerystringfalseFilter by active only for editor or admin users
orderingquerystringfalseWhich field to use when ordering the results.

Example Request

const headers = {
'Accept':'application/json',
'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/loyalty/prize/',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});


Responses

StatusMeaningDescriptionSchema
200OKnoneInline

Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
» countintegerfalsenonenone
» nextstring(uri)¦nullfalsenonenone
» previousstring(uri)¦nullfalsenonenone
» results[LoyaltyPrize]falsenonenone

Example responses

{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"id": 0,
"active": true,
"title": "string",
"description": "string",
"points": 0,
"link": "https://example.com",
"image": "string",
"created_at": "2019-08-24T14:15:22Z",
"lastmod_datetime": "2019-08-24T14:15:22Z",
"created_by": "string"
}
]
}