> 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/tenant/list-tenants.md).

# List tenants

Listing all tenant the user has access to.

Required permissions: TENANT

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Tenant","description":"Tenant"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"parameters":{"pageNumberQuery":{"description":"Reference to a specific page in a result set.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"}},"pageSizeQuery":{"description":"The number of items per page in a result set.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},"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"}},"schemas":{"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"},"TenantResponseSchema":{"title":"TenantResponseSchema","type":"object","required":["countryCode","createdAt","lastModifiedAt","name","pricelistUid","tenantUid","vatNumber","settings","appSettings","extensions","assets","timezone","languageCode","currency"],"properties":{"countryCode":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"lastModifiedAt":{"format":"date-time","type":"string"},"name":{"type":"string"},"pricelistUid":{"$ref":"#/components/schemas/OptionalUID"},"tenantUid":{"$ref":"#/components/schemas/UID"},"vatNumber":{"$ref":"#/components/schemas/VatNumberTYPE"},"settings":{"$ref":"#/components/schemas/TenantSettingsResponseSchema"},"appSettings":{"$ref":"#/components/schemas/TenantAppSettingsResponseSchema"},"extensions":{"type":"array","items":{"$ref":"#/components/schemas/TenantExtensionSchema"}},"assets":{"$ref":"#/components/schemas/TenantAssetSchema"},"timezone":{"$ref":"#/components/schemas/TimezoneTYPE"},"languageCode":{"$ref":"#/components/schemas/LanguageCode"},"currency":{"$ref":"#/components/schemas/TenantCurrencySchema"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"VatNumberTYPE":{"description":"VAT identification number for value added tax reporting purposes.","title":"VatNumber","type":"string"},"TenantSettingsResponseSchema":{"title":"TenantSettings","type":"object","required":["allowExternalCashDrawer","autoLogout","autoPrintReceipt","numericSkuCounter","printCardPaymentDetails","sendInvoicesExternally","duplicateCheckCustomerPhoneNumber","duplicateCheckCustomerVatNumber","useOriginalSellerOnCreditLine","printReceiptNumber","requiredCustomerFields","requiredCompanyFields","requiredCompanyDepartmentFields","requiredContactFields","enforceStrongPin","customerContactsRequiresEmail","customerContactsEmailDuplicateCheck"],"properties":{"allowExternalCashDrawer":{"type":"boolean","default":false},"autoLogout":{"type":"integer","description":"time in seconds, 0 means not enabled"},"autoPrintReceipt":{"type":"boolean"},"numericSkuCounter":{"type":"integer"},"printCardPaymentDetails":{"type":"boolean","description":"toogle on/off payment terminal details on receipt","default":false},"sendInvoicesExternally":{"type":"boolean"},"duplicateCheckCustomerPhoneNumber":{"type":"boolean","description":"For PERSON customers: Check for unique phone number and email if true"},"duplicateCheckCustomerVatNumber":{"type":"boolean","description":"For COMPANY customers: Check for unique vat number if true"},"useOriginalSellerOnCreditLine":{"type":"boolean","description":"toogle on/off if the original seller should be used in a existing referenced order"},"defaultCustomerGroupUid":{"$ref":"#/components/schemas/OptionalUID"},"printReceiptNumber":{"type":"boolean"},"defaultParkedOrderLifespanDays":{"type":"integer","description":"Default lifespan in days for parked orders before expiration","deprecated":true},"autoSendWelcomeSms":{"type":"boolean","deprecated":true},"autoSendWelcomeMail":{"type":"boolean","deprecated":true},"requirePinCodeForSale":{"type":"boolean","description":"description: Turn on/off PIN requirement for sale","deprecated":true},"requirePinCodeForCredit":{"type":"boolean","description":"description: Turn on/off PIN requirement for credit","deprecated":true},"requiredCustomerFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomerRequiredFieldENUM"}},"requiredCompanyFields":{"$ref":"#/components/schemas/NullableCustomerRequiredFieldArray"},"requiredCompanyDepartmentFields":{"$ref":"#/components/schemas/NullableCustomerRequiredFieldArray"},"requiredContactFields":{"$ref":"#/components/schemas/NullableCustomerRequiredFieldArray"},"enforceStrongPin":{"type":"boolean","description":"For user's app PIN/password creation"},"customerContactsRequiresEmail":{"type":"boolean","description":"Indicate if the customer contacts requires email."},"customerContactsEmailDuplicateCheck":{"type":"boolean","description":"This will enable duplicate check on email\nfor contacts, so it is not possible to have two\ncontacts with the same email."}}},"CustomerRequiredFieldENUM":{"title":"CustomerRequiredFieldENUM","type":"string","enum":["email","mobile","vatNumber","postalCode","city","address"]},"NullableCustomerRequiredFieldArray":{"title":"NullableCustomerRequiredFieldArray","type":"array","nullable":true,"items":{"$ref":"#/components/schemas/CustomerRequiredFieldENUM"},"description":"Type-specific required-field override. Null means inherit requiredCustomerFields.\nAn empty array means no required fields for this type (explicit override).\n"},"TenantAppSettingsResponseSchema":{"title":"TenantAppSettingsResponseSchema","type":"object","required":["showOutOfStockWarning","defaultParkedOrderLifespanDays","requirePinCodeForSale","requirePinCodeForCredit","autoSendWelcomeSms","autoSendWelcomeMail","defaultCustomerGroupUid","helpUrl"],"properties":{"showOutOfStockWarning":{"type":"boolean"},"defaultParkedOrderLifespanDays":{"type":"integer"},"requirePinCodeForSale":{"type":"boolean"},"requirePinCodeForCredit":{"type":"boolean"},"autoSendWelcomeSms":{"type":"boolean"},"autoSendWelcomeMail":{"type":"boolean"},"defaultCustomerGroupUid":{"$ref":"#/components/schemas/OptionalUID"},"helpUrl":{"type":"string","format":"uri","description":"URL opened by the client's help shortcut. Empty means no tenant override is set."}}},"TenantExtensionSchema":{"title":"TenantExtensionSchema","type":"object","required":["extensionCode","name","active","tenantExtensionUid"],"properties":{"extensionCode":{"$ref":"#/components/schemas/ExtensionCodeENUM"},"name":{"type":"string"},"active":{"type":"boolean"},"tenantExtensionUid":{"$ref":"#/components/schemas/UID"}}},"ExtensionCodeENUM":{"description":"`PAYEX_POS` is discontinued: a tenant that has it keeps it, but it cannot be switched on.","enum":["FLOWGIFTCARD","PAYEX_GIFTCARD","ADYEN_POS","PAYEX_POS","VIPPS","EXTERNAL_CUSTOMER_SEARCH","STORE_CREDIT","SMS","STRIPE","NETS","VERIFONE","SERVICE_WORKSHOP","TWO_INVOICE","OMNIUM","DILLER","ARTS","CAMPAIGN","B2B","PEOPLE_COUNTER_KUNDETELLING","COMPENSATION","SWISH","DINTERO","KID","EHF","MYPOWER","BRITANNIA","SOFTPAY","CENTRAL_WAREHOUSE","PROFRAKT","LOYALTY_POINTS","SUBSCRIPTION","POWER_DIRECT","POSTER","PAYMENT_GATEWAY","KLAVIYO","COMPANY_REGISTRY","DIGITAL_PRODUCT","INTER_STORE_TRADE","FISCAL","EXTERNAL_ORDER_SEARCH","ORDER_DEVIATION"],"title":"ExtensionCodeENUM","type":"string"},"TenantAssetSchema":{"title":"TenantAssetSchema","type":"object","required":["logo","splash"],"properties":{"logo":{"$ref":"#/components/schemas/AssetUrlSchema"},"splash":{"$ref":"#/components/schemas/AssetUrlSchema"}}},"AssetUrlSchema":{"title":"AssetUrlSchema","type":"object","required":["url","assetUid"],"properties":{"url":{"type":"string"},"assetUid":{"$ref":"#/components/schemas/UID"}}},"TimezoneTYPE":{"title":"Timezone","type":"string","description":"The timezone in tz/zoneinfo format. Example: Europe/Oslo"},"LanguageCode":{"title":"LanguageCode","description":"Lowercase two-letter ISO 639-1 language code, like nb, en or sv.","type":"string"},"TenantCurrencySchema":{"title":"TenantCurrencySchema","type":"object","required":["code","name","symbol","symbolPosition","decimalSeparator","thousandSeparator","cashRounding"],"properties":{"code":{"type":"string","description":"ISO 4217"},"name":{"type":"string"},"symbol":{"type":"string","description":"symbol or short name, e.g. `$`, `kr` etc. "},"symbolPosition":{"type":"string","description":"prefix or suffix to the amount"},"decimalSeparator":{"type":"string"},"thousandSeparator":{"type":"string"},"cashRounding":{"type":"integer","description":"the smallest amount accepted as cash"}}},"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"}},"responses":{"TenantListResponse":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/TenantResponseSchema"},"type":"array"},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"],"type":"object"}}},"description":"Example response"}}},"paths":{"/tenants":{"get":{"description":"Listing all tenant the user has access to.\n\nRequired permissions: TENANT","operationId":"get-tenants","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}],"responses":{"200":{"$ref":"#/components/responses/TenantListResponse"}},"summary":"List tenants","tags":["Tenant"]}}}}
```


---

# 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/tenant/list-tenants.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.