> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/docs/developers/api-documentation/device/list-device-users.md).

# List device users

List all users that can login to the current device. Each user carries where their PIN stands (pinLocked, pinLockedUntil), so the device can say a wait or a lock is holding before anyone has logged in: the device login (post-account) answers a wait and a lock exactly as a wrong password.

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Device","description":"Device"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"deviceToken":[]}],"components":{"securitySchemes":{"deviceToken":{"description":"The devicetoken is only used for to attach devices and tie it to a tenant","scheme":"bearer","type":"http"}},"responses":{"DeviceUserListResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","required":["items","paging"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DeviceUserResponseSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}}}}}},"GenericErrorResponse":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string","description":"Error code. The codes a POS app acts on are listed in DeviceErrorCodeENUM."},"message":{"type":"string","description":"Error message in the locale you specify in the Accept-Language header or specified on the user"},"logId":{"type":"string","description":"Log identification. Can be used when reporting errors to Flow Solutions"}},"type":"object"}}},"description":"Linking failed. Ther error message will have information about what failed."}},"schemas":{"DeviceUserResponseSchema":{"title":"DeviceUserResponseSchema","type":"object","required":["accountType","displayName","firstname","lastAccessed","lastname","pinLocked","pinLockedUntil","tenantUserUid","userCode","languageCode"],"properties":{"accountType":{"$ref":"#/components/schemas/TenantAccountTypeENUM"},"displayName":{"type":"string"},"firstname":{"type":"string"},"lastAccessed":{"format":"date-time","type":"string"},"lastname":{"type":"string"},"pinLocked":{"type":"boolean","description":"The user's PIN is locked after repeated failures, until someone holding TENANT_USER gives the user a new PIN through the tenant user update. While it is set no PIN of theirs is accepted — not by the tenant user verify-pin operation, the secret reveal, the cash reconciliation review, the device login or the device link — and no unlock token of theirs is refreshed. The ladder that leads here is described on the verify-pin operation."},"pinLockedUntil":{"type":"string","format":"date-time","nullable":true,"description":"When the running wait on the user's PIN ends, after repeated failures; until then every PIN attempt against the user is refused. null when no wait is running. A locked user reads null here and pinLocked true."},"tenantUserUid":{"$ref":"#/components/schemas/UID"},"userCode":{"type":"string"},"languageCode":{"$ref":"#/components/schemas/LanguageCode"}}},"TenantAccountTypeENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| FULL | Access to backoffice and onboarding of new devices|\n| REGULAR | Can only login to already onboarded devices|\n| SUPPORT | Support account|\n| INTEGRATION | Computer integration account|","enum":["FULL","REGULAR","SUPPORT","INTEGRATION"],"title":"TenantAccountTypeENUM","type":"string"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"LanguageCode":{"title":"LanguageCode","description":"Lowercase two-letter ISO 639-1 language code, like nb, en or sv.","type":"string"},"Paging":{"description":"totalCount The total number of items in the result set.\n\npageSize The number of items per page.\n\npageNumber The current page in the result set.","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"},"totalCount":{"type":"integer"}},"required":["totalCount","pageSize","pageNumber"],"title":"Paging","type":"object"},"SortDirectionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| ASC | Sort in ascending order|\n| DESC | Sort in descending order|\n","enum":["ASC","DESC"],"title":"SortDirectionENUM","type":"string"}},"parameters":{"TenantAccountTypeQuery":{"description":"Account types to return","schema":{"items":{"$ref":"#/components/schemas/TenantAccountTypeENUM"},"type":"array"},"in":"query","name":"accountType","explode":false},"sortByQuery":{"description":"Defines which field the resource list is sorted by.","in":"query","name":"sortBy","required":false,"schema":{"type":"string"}},"sortDirectionQuery":{"description":"Reference to a sort direction","explode":false,"in":"query","name":"sortDirection","schema":{"$ref":"#/components/schemas/SortDirectionENUM"},"style":"form"},"pageSizeQuery":{"description":"The number of items per page in a result set.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},"pageNumberQuery":{"description":"Reference to a specific page in a result set.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"}}}},"paths":{"/device/users":{"get":{"description":"List all users that can login to the current device. Each user carries where their PIN stands (pinLocked, pinLockedUntil), so the device can say a wait or a lock is holding before anyone has logged in: the device login (post-account) answers a wait and a lock exactly as a wrong password.","operationId":"get-device-users","responses":{"200":{"$ref":"#/components/responses/DeviceUserListResponse"},"400":{"$ref":"#/components/responses/GenericErrorResponse"}},"summary":"List device users","tags":["Device"],"parameters":[{"$ref":"#/components/parameters/TenantAccountTypeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/pageNumberQuery"}]}}}}
```


---

# 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://docs.flowretail.com/docs/developers/api-documentation/device/list-device-users.md?ask=<question>&goal=<user_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.