> For the complete documentation index, see [llms.txt](https://help.openloyalty.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.openloyalty.io/api-reference/reward/get-rewards-list.md).
# Get rewards list
Integration\
\
This method returns a list of all Rewards existing in the system.\
If sorting is not chosen, the rows will be returned in an unspecified order. To sort a result, use an `_orderBy` parameter in query.
````json
{"openapi":"3.0.0","info":{"title":"Open Loyalty","version":"0.0.1"},"tags":[{"name":"Reward","description":"These endpoints allow you to easily manage rewards."}],"servers":[{"url":"http://openloyalty.localhost"}],"security":[{"Bearer":[]},{"token":[]}],"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Open Loyalty has the JWT authorization.\nTo learn what a JSON Web Token is and how it works, check out Introduction to JSON Web Tokens \n\n### Obtain an access token\n\nSend a request with the parameters username and password\n\n#### Definition\n\n`POST /api/admin/login_check` [Go to definition](#operation/adminLoginCheck)\\\n`POST /api/{storeCode}/member/login_check` [Go to definition](#operation/memberLoginCheck)\n\n#### Example\n\n```bash\ncurl {HOST}/api/admin/login_check\n -H 'Content-Type: application/json;charset=UTF-8'\n -H 'Accept: application/json, text/plain, */*'\n --data-binary '{\"username\":\"admin\",\"password\":\"password\"}'\n```\n\n#### Example Response\n\n```json\n{\n \"token\":\"eyJhbGciOiJSUzI1NiIsInR5cCI6...\",\n \"refresh_token\":\"0558f8bb29948c4e54c443f...\"\n}\n```\n\n### Using JSON Web Token\n\nAdd authorization header to each request\\\n`Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...`\\\nYou can now access any API method you want under the /api prefix.\n\n#### Example\n```bash\ncurl {HOST}/api/{storeCode}/analytics/members\n -H 'Accept: application/json'\n -H 'Content-type: application/x-www-form-urlencoded'\n -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6...'\n```\n\n### Refresh JSON Web Token\nYou can refresh token using refresh_token that was given during login.\\\nThere are two endpoints\\\nTo refresh admin token `POST /api/token/refresh` [Go to definition](#operation/tokenRefresh)\\\nTo refresh member token `POST /api/{storeCode}/token/refresh` [Go to definition](#operation/tokenRefreshMember)\n","bearerFormat":"JWT","scheme":"bearer"},"token":{"type":"apiKey","name":"X-AUTH-TOKEN","in":"header"}},"parameters":{"storeCode":{"name":"storeCode","in":"path","description":"Store code","required":true,"schema":{"type":"string"}},"page":{"name":"_page","in":"query","description":"Number of page with results, starts from 1","required":false,"schema":{"type":"integer","default":1,"minimum":1}},"itemsOnPage":{"name":"_itemsOnPage","in":"query","description":"Items on one page","required":false,"schema":{"type":"integer","default":10,"maximum":50,"minimum":1}},"orderBy":{"name":"_orderBy","in":"query","description":"Sorting order. If sorting is not chosen, the rows will be returned in an unspecified order. Sort order: * `asc` - Ascending, from A to Z * `desc` - Descending, from Z to A","required":false,"style":"deepObject","explode":true,"schema":{"type":"object","additionalProperties":{"type":"string","enum":["asc","desc"]}}}},"schemas":{"RewardResponse":{"properties":{"reward":{"type":"string"},"name":{"type":"string"},"levels":{"type":"array","items":{"type":"string","format":"uuid"}},"segments":{"type":"array","items":{"type":"string","format":"uuid"}},"categories":{"type":"array","items":{"type":"string","format":"uuid"}},"brandIcon":{"type":"boolean"},"rewardId":{"type":"string","format":"uuid"},"target":{"type":"string","enum":["level","segment"]},"active":{"type":"boolean"},"costInPoints":{"type":"number"},"activity":{"properties":{"allTime":{"type":"boolean"}},"type":"object"},"visibility":{"properties":{"allTime":{"type":"boolean"}},"type":"object"},"tax":{"type":"number"},"taxPriceValue":{"type":"number"},"price":{"type":"number"},"labels":{"type":"array","items":{"properties":{"key":{"type":"string"},"value":{"type":"string"}},"type":"object"}},"featured":{"type":"boolean"},"public":{"type":"boolean"},"photos":{"type":"array","items":{"type":"object"}},"createdAt":{"type":"string","format":"date-time"},"usageLimit":{"properties":{"general":{"type":"number"},"perUser":{"type":"number"}},"type":"object"},"notIssuedCoupons":{"type":"number"},"limitUsages":{"properties":{"general":{"properties":{"interval":{"properties":{"type":{"type":"string","enum":["calendarHours","calendarDays","calendarWeeks","calendarMonths","calendarYears"]}},"type":"object"},"currentValue":{"type":"number","format":"float"},"limitValue":{"type":"number","format":"float"}},"type":"object"},"perMember":{"properties":{"interval":{"properties":{"type":{"type":"string","enum":["calendarHours","calendarDays","calendarWeeks","calendarMonths","calendarYears"]}},"type":"object"},"currentValue":{"type":"number","format":"float"},"limitValue":{"type":"number","format":"float"}},"type":"object"}},"type":"object"},"fulfillmentTracking":{"type":"boolean","deprecated":true},"translations":{"type":"array","items":{"properties":{"name":{"type":"string"},"id":{"type":"integer"},"locale":{"type":"string"}},"type":"object"}},"couponGenerator":{"properties":{"length":{"type":"number"},"characterSet":{"type":"string"}},"type":"object"},"couponValue":{"type":"number"},"segmentNames":{"type":"object","additionalProperties":{"type":"string"}},"levelNames":{"type":"object","additionalProperties":{"type":"string"}},"categoryNames":{"type":"object","additionalProperties":{"type":"string"}},"usageLeft":{"type":"number","deprecated":true},"usageLeftForCustomer":{"type":"number","deprecated":true},"unitsConversion":{"properties":{"ratio":{"type":"number","format":"float"},"rounding":{"type":"string","enum":["up","down","default"]}},"type":"object"},"customFields":{"type":"object","nullable":true,"description":"Custom-field values grouped by group key, exposed to admin consumers. Present only when the CUSTOM_FIELD_REWARD feature flag is enabled and the reward has stored values; omitted otherwise.","additionalProperties":{"type":"object","additionalProperties":true}}},"type":"object"},"SearchableTotalResponse":{"required":["all","filtered","estimated"],"properties":{"all":{"type":"integer","deprecated":true},"filtered":{"type":"integer","deprecated":true},"estimated":{"description":"Field estimated is used to show that the results are estimated. It might happen when there are more than 5000 results due to performance optimization.","type":"boolean","deprecated":true}},"type":"object","deprecated":true}},"responses":{"BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"required":["code","message","errors"],"properties":{"code":{"type":"integer"},"message":{"type":"string"},"errors":{"type":"array","items":{"required":["message","parameters","plural","code","path"],"properties":{"message":{"type":"string"},"parameters":{},"plural":{"type":"integer","nullable":true},"code":{"type":"string"},"path":{"type":"string"}},"type":"object"}}},"type":"object"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}},"AccessDenied":{"description":"Forbidden.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}},"NotFound":{"description":"Not found.","content":{"application/json":{"schema":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}}}}}},"paths":{"/api/{storeCode}/reward":{"get":{"tags":["Reward"],"summary":"Get rewards list","description":"
\nThis method returns a list of all Rewards existing in the system. \nIf sorting is not chosen, the rows will be returned in an unspecified order.\nTo sort a result, use an `_orderBy` parameter in query.\n","operationId":"rewardGetList","parameters":[{"$ref":"#/components/parameters/storeCode"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/itemsOnPage"},{"$ref":"#/components/parameters/orderBy"},{"name":"rewardId","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"string","format":"uuid"}},{"name":"reward","in":"query","required":false,"deprecated":true,"style":"deepObject","explode":true,"schema":{"type":"string","enum":["static_coupon","material","dynamic_coupon","conversion_coupon"]}},{"name":"active","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"boolean"}},{"name":"createdAt","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"string","format":"date-time"}},{"name":"public","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"boolean"}},{"name":"fulfillmentTracking","in":"query","required":false,"deprecated":true,"style":"deepObject","explode":true,"schema":{"type":"boolean"}},{"name":"featured","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"boolean"}},{"name":"name","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"string"}},{"name":"shortDescription","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"string"}},{"name":"brandName","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"string"}},{"name":"brandDescription","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"string"}},{"name":"levels","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"string"}},{"name":"segments","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"string"}},{"name":"categories","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"string"}},{"name":"labels","in":"query","description":"Labels using pattern e.g. (key1;value1),(key2;value2),...","required":false,"style":"deepObject","explode":true,"schema":{"type":"string"}},{"name":"costInPoints","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"integer"}},{"name":"limit","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"integer"}},{"name":"available","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"boolean"}},{"name":"visible","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"boolean"}},{"name":"visibleFrom","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"string","format":"date-time"}},{"name":"visibleTo","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"string","format":"date-time"}},{"name":"activeFrom","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"string","format":"date-time"}},{"name":"activeTo","in":"query","required":false,"style":"deepObject","explode":true,"schema":{"type":"string","format":"date-time"}},{"name":"format","in":"query","description":"If set to html, the descriptions will be in HTML format. Omit for raw output.","required":false,"style":"deepObject","schema":{"type":"string","format":"html|raw"}},{"name":"type","in":"query","description":"Examples: - `type[notIn]=material` - `type[in]=dynamic_coupon`\n","required":false,"style":"deepObject","explode":true,"schema":{"type":"string","enum":["static_coupon","material","dynamic_coupon","conversion_coupon","fortune_wheel"]}}],"responses":{"200":{"description":"Get all rewards.","content":{"application/json":{"schema":{"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RewardResponse"}},"total":{"$ref":"#/components/schemas/SearchableTotalResponse"}},"type":"object","additionalProperties":false}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/AccessDenied"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
````
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://help.openloyalty.io/api-reference/reward/get-rewards-list.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.