> 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/group-of-values/get-collections-list.md).
# Get collections list
Management\
````json
{"openapi":"3.0.0","info":{"title":"Open Loyalty","version":"0.0.1"},"tags":[{"name":"Group Of Values","description":"These endpoints will allow you to easily manage group of values."}],"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"}},"scroll":{"name":"_scroll","in":"query","description":"Scroll (cursor) pagination: the recommended way to fetch all records or any large volume of them. Unlike with `_page`, the cost of a request does not grow with how far into the result it is, see [Scroll mechanism for pages](https://help.openloyalty.io/technical-guide/api-fundamentals/scroll-mechanism-for-pages).\n\n1. Send the first request with an empty `_scroll` parameter: `?_scroll`.\n2. Send the next request with the `scroll.next` value from the previous response: `?_scroll=`. Keep the other query parameters unchanged.\n3. Stop when the response has no `scroll.next` value: the last response has an empty `items` list. You can stop earlier when a response has fewer items than `_itemsOnPage`.\n\nNotes:\n- Items are always returned in descending order of `createdAt`, then of their id. `_orderBy` has no effect (its values are still validated).\n- `_page` has no effect (it must still be a valid page number). `_itemsOnPage` sets the number of items in one response.\n- Filters work the same way as in `_page` pagination.\n- A scroll response has no `total`.\n","required":false,"schema":{"type":"string"}},"itemsOnPage":{"name":"_itemsOnPage","in":"query","description":"Items on one page, in both `_page` and `_scroll` pagination.\n","required":false,"schema":{"type":"integer","default":10,"maximum":50,"minimum":1}},"page":{"name":"_page","in":"query","description":"Number of the page with results, starts from 1.\n\n**Not for iterating over large data sets.** The cost of a request grows with the page number: the database still reads and discards every row of the previous pages, so deep pages are slow and load the whole API. Use `_page` to browse the first pages of a result. The maximum value of `_page` is limited on some endpoints, see [Limits](https://help.openloyalty.io/technical-guide/api-fundamentals/limits).\n\nTo fetch all records, or any large volume of them, use the `_scroll` parameter where the endpoint offers it, see [Scroll mechanism for pages](https://help.openloyalty.io/technical-guide/api-fundamentals/scroll-mechanism-for-pages).\n","required":false,"schema":{"type":"integer","default":1,"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":{"GroupOfValuesResponse":{"required":["items","total"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GroupOfValues"}},"total":{"$ref":"#/components/schemas/SearchableTotalResponse"},"scroll":{"type":"string","nullable":true}},"type":"object","additionalProperties":false},"GroupOfValues":{"required":["groupOfValuesId","name","translations","active","recordsInGroup","createdAt","updatedAt"],"properties":{"groupOfValuesId":{"type":"string","format":"uuid"},"name":{"description":"Collection name","type":"string"},"description":{"description":"Collection description","type":"string"},"translations":{"$ref":"#/components/schemas/Translations"},"active":{"description":"Collection status","type":"boolean"},"recordsInGroup":{"description":"Number of values in collection","type":"integer"},"createdAt":{"description":"Creation date","type":"string","format":"date-time"},"updatedAt":{"description":"Last update date","type":"string","format":"date-time"}},"type":"object","additionalProperties":false},"Translations":{"description":"This field is used to save the name and description in the language of your choice.\nYou need to add at least one name in the default language.\n","required":["en"],"properties":{"en":{"required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"}},"type":"object","additionalProperties":false},"pl":{"required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"}},"type":"object"}},"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},"GroupOfValuesResponseWithScroll":{"required":["items","scroll"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GroupOfValues"}},"scroll":{"$ref":"#/components/schemas/ScrollResponse"}},"type":"object","additionalProperties":false},"ScrollResponse":{"properties":{"next":{"description":"Scroll identifier for pagination","type":"string","nullable":true}},"type":"object","additionalProperties":false}}},"paths":{"/api/{storeCode}/groupOfValues":{"get":{"tags":["Group Of Values"],"summary":"Get collections list","description":"
\n","operationId":"groupOfValuesGetList","parameters":[{"$ref":"#/components/parameters/storeCode"},{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"active","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"createdAt","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/scroll"},{"$ref":"#/components/parameters/itemsOnPage"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/orderBy"}],"responses":{"200":{"description":"List of groupOfValues","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupOfValuesResponse"}},"application/vnd.pagination+json":{"schema":{"$ref":"#/components/schemas/GroupOfValuesResponse"}},"application/vnd.scroll+json":{"schema":{"$ref":"#/components/schemas/GroupOfValuesResponseWithScroll"}}}},"403":{"description":"Access Denied"}}}}}}
````
---
# 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 by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://help.openloyalty.io/api-reference/group-of-values/get-collections-list.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
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.