> 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/tier/get-tiers-list.md).
# Get tiers list
This method returns a list of all created Tiers 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":"Tier","description":"These endpoints will allow you to easily manage tiers."}],"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":{"TierResponse":{"required":["levelId","name","hasPhoto","storeCode","active","rewards","translations","createdAt","updatedAt","sortOrder","isDefault","conditions"],"properties":{"levelId":{"description":"This field show tier id","type":"string","format":"uuid"},"name":{"description":"This field show tier name","type":"string"},"description":{"description":"This field show tier description","type":"string"},"hasPhoto":{"description":"This field show if tier have photo","type":"boolean"},"storeCode":{"description":"The field shows what store tier it is in","type":"string"},"tierSet":{"description":"This field shows related tier set","required":["tierSetId","name"],"properties":{"tierSetId":{"description":"This field shows tier set id","type":"string","format":"uuid"},"name":{"description":"This field shows tier set name","type":"string"}},"type":"object","additionalProperties":false},"conditions":{"description":"This field shows conditions that member must meet to be at this tier","type":"array","items":{"required":["conditionId","attribute","value"],"properties":{"conditionId":{"type":"string","format":"uuid"},"attribute":{"description":"Specifies the type of attribute. The possible values are:\n- `activeUnits`: The number of units currently active. - `totalEarnedUnits`: The total number of units earned. - `monthsSinceJoiningProgram`: The number of months since the program was joined. - `totalSpending`: The total amount of spending. - `cumulatedEarnedUnits`: The total number of units earned that will be reset when recalculation occur\n","enum":["activeUnits","totalEarnedUnits","monthsSinceJoiningProgram","totalSpending","cumulatedEarnedUnits"]},"value":{"description":"This field shows the value that was specified for the attribute","type":"string"}},"type":"object","additionalProperties":false}},"active":{"description":"The field shows whether the tier is active","type":"boolean"},"rewards":{"description":"Lifetime benefits associated with tier.","type":"array","items":{"required":["rewardId","name","code","active","createdAt","updatedAt"],"properties":{"rewardId":{"description":"Reward ID.","required":["rewardId"],"properties":{"rewardId":{"type":"string","format":"uuid"}},"type":"object"},"name":{"description":"Benefit name.","type":"string"},"value":{"description":"Benefit value.","type":"number","format":"float"},"code":{"description":"Benefit code.","type":"string"},"labels":{"$ref":"#/components/schemas/Labels"},"active":{"description":"Benefit availability","type":"boolean"},"startAt":{"description":"Benefit availability start date","type":"string","format":"date-time"},"endAt":{"description":"Benefit availability end date","type":"string","format":"date-time"},"createdAt":{"description":"Benefit created at date","type":"string","format":"date-time"},"updatedAt":{"description":"Benefit updated at date","type":"string","format":"date-time"},"createdBy":{"description":"Benefit created by","type":"string","format":"uuid"},"updatedBy":{"description":"Benefit updated by","type":"string","format":"uuid"}},"type":"object","additionalProperties":false}},"sortOrder":{"description":"This field shows order of tiers, the higher the number, the higher the tier.","type":"number"},"isDefault":{"description":"This field shows whether the tier is the default tier that was created automatically along with the tier set. Tier serves as the starting tier in tie set","type":"boolean"},"translations":{"type":"array","items":{"required":["id","locale"],"properties":{"id":{"type":"integer"},"name":{"type":"string"},"description":{"type":"string"},"locale":{"type":"string"}},"type":"object"}},"createdAt":{"description":"tier created at date","type":"string","format":"date-time"},"updatedAt":{"description":"tier updated at date","type":"string","format":"date-time"},"createdBy":{"description":"tier created by","type":"string","format":"uuid"},"updatedBy":{"description":"tier updated by","type":"string","format":"uuid"},"conditionValue":{"type":"number","format":"float","deprecated":true}},"type":"object","additionalProperties":false},"Labels":{"description":"A list of custom attributes used for tagging and describing resources. Each item in the list contains a key-value pair, where `key` is the name of the attribute, and `value` is the value assigned to that attribute.\n","type":"array","items":{"required":["key","value"],"properties":{"key":{"description":"The name of the custom attribute.","type":"string"},"value":{"description":"The value assigned to the custom attribute.","type":"string"}},"type":"object","additionalProperties":false}},"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},"ExpiredToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"InvalidToken":{"required":["code","message"],"properties":{"code":{"type":"string"},"message":{"type":"string"}},"type":"object"},"Unauthorized":{"required":["code","message"],"properties":{"code":{"type":"integer"},"message":{"type":"string"}},"type":"object"}},"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"}}}},"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}/tier":{"get":{"tags":["Tier"],"summary":"Get tiers list","description":"This method returns a list of all created Tiers 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":"_tierGetList","parameters":[{"$ref":"#/components/parameters/storeCode"},{"name":"levelId","in":"query","required":false,"schema":{"type":"string"}},{"name":"conditionValue","in":"query","required":false,"schema":{"type":"number"}},{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"description","in":"query","required":false,"schema":{"type":"string"}},{"name":"active","in":"query","description":"Filter by active filed","required":false,"schema":{"type":"boolean"}},{"name":"reward:name","in":"query","required":false,"schema":{"type":"string"}},{"name":"reward:code","in":"query","required":false,"schema":{"type":"string"}},{"name":"reward:value","in":"query","required":false,"schema":{"type":"number"}},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/itemsOnPage"},{"$ref":"#/components/parameters/orderBy"}],"responses":{"200":{"description":"List of tiers","content":{"application/json":{"schema":{"required":["items","total"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TierResponse"}},"total":{"$ref":"#/components/schemas/SearchableTotalResponse"}},"type":"object"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ExpiredToken"},{"$ref":"#/components/schemas/InvalidToken"},{"$ref":"#/components/schemas/Unauthorized"}]}}}},"403":{"$ref":"#/components/responses/AccessDenied"},"404":{"$ref":"#/components/responses/NotFound"}},"deprecated":true}}}}
````
---
# 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/tier/get-tiers-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.