Tenant | Flow Retail Docs

List tenants

get

Listing all tenant the user has access to.

Required permission: TENANT.ACCESS

Authorizations

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Responses

200

Example response

application/json

get

GET /v2/tenants HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "countryCode": "text",
      "createdAt": "2025-07-30T16:45:37.204Z",
      "lastModifiedAt": "2025-07-30T16:45:37.204Z",
      "name": "text",
      "pricelistUid": "text",
      "tenantUid": "text",
      "vatNumber": "text",
      "settings": {
        "allowExternalCashDrawer": false,
        "autoLogout": 1,
        "autoPrintReceipt": true,
        "numericSkuCounter": 1,
        "printCardPaymentDetails": false,
        "sendInvoicesExternally": true
      },
      "appSettings": {
        "showOutOfStockWarning": true
      },
      "extensions": [
        {
          "extensionCode": "FLOWGIFTCARD",
          "name": "text",
          "active": true
        }
      ],
      "assets": {
        "logo": {
          "url": "text",
          "assetUid": "text"
        },
        "splash": {
          "url": "text",
          "assetUid": "text"
        }
      },
      "timezone": "text",
      "languageCode": "text",
      "currency": {
        "code": "text",
        "name": "text",
        "symbol": "text",
        "symbolPosition": "text",
        "decimalSeparator": "text",
        "thousandSeparator": "text",
        "cashRounding": 1
      }
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get tenant details

get

Internal endpoint for details for a tenant.

Required permission: TENANT.ACCESS

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Responses

200

Example response

application/json

404

Linking failed. Ther error message will have information about what failed.

application/json

get

GET /v2/tenants/{tenantUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "countryCode": "text",
  "createdAt": "2025-07-30T16:45:37.204Z",
  "lastModifiedAt": "2025-07-30T16:45:37.204Z",
  "name": "text",
  "pricelistUid": "text",
  "tenantUid": "text",
  "vatNumber": "text",
  "settings": {
    "allowExternalCashDrawer": false,
    "autoLogout": 1,
    "autoPrintReceipt": true,
    "numericSkuCounter": 1,
    "printCardPaymentDetails": false,
    "sendInvoicesExternally": true
  },
  "appSettings": {
    "showOutOfStockWarning": true
  },
  "extensions": [
    {
      "extensionCode": "FLOWGIFTCARD",
      "name": "text",
      "active": true
    }
  ],
  "assets": {
    "logo": {
      "url": "text",
      "assetUid": "text"
    },
    "splash": {
      "url": "text",
      "assetUid": "text"
    }
  },
  "timezone": "text",
  "languageCode": "text",
  "currency": {
    "code": "text",
    "name": "text",
    "symbol": "text",
    "symbolPosition": "text",
    "decimalSeparator": "text",
    "thousandSeparator": "text",
    "cashRounding": 1
  }
}

Update tenant details

put

Required permission: TENANT ADMIN

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Body

namestringOptional

pricelistUidstringOptionalPattern: ^[A-Za-z0-9-_]*

vatNumberstringOptional

VAT identification number for value added tax reporting purposes.

allowExternalCashDrawerbooleanOptionalDefault: false

autoLogoutintegerOptional

time in seconds, 0 means not enabled

Default: 0

autoPrintReceiptbooleanOptional

showOutOfStockWarningbooleanOptional

logoAssetUidstringOptionalPattern: ^[A-Za-z0-9-_]*

splashAssetUidstringOptionalPattern: ^[A-Za-z0-9-_]*

timezonestringOptional

The timezone in tz/zoneinfo format. Example: Europe/Oslo

numericSkuCounterintegerOptional

languageCodestringOptional

ISO 639-1 code for language

printCardPaymentDetailsbooleanOptional

toogle on/off payment terminal details on receipt

sendInvoicesExternallybooleanOptional

Responses

200

Example response

application/json

put

PUT /v2/tenants/{tenantUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 325

{
  "name": "text",
  "pricelistUid": "text",
  "vatNumber": "text",
  "allowExternalCashDrawer": false,
  "autoLogout": 0,
  "autoPrintReceipt": true,
  "showOutOfStockWarning": true,
  "logoAssetUid": "text",
  "splashAssetUid": "text",
  "timezone": "text",
  "numericSkuCounter": 1,
  "languageCode": "text",
  "printCardPaymentDetails": true,
  "sendInvoicesExternally": true
}

200

Example response

{
  "countryCode": "text",
  "createdAt": "2025-07-30T16:45:37.204Z",
  "lastModifiedAt": "2025-07-30T16:45:37.204Z",
  "name": "text",
  "pricelistUid": "text",
  "tenantUid": "text",
  "vatNumber": "text",
  "settings": {
    "allowExternalCashDrawer": false,
    "autoLogout": 1,
    "autoPrintReceipt": true,
    "numericSkuCounter": 1,
    "printCardPaymentDetails": false,
    "sendInvoicesExternally": true
  },
  "appSettings": {
    "showOutOfStockWarning": true
  },
  "extensions": [
    {
      "extensionCode": "FLOWGIFTCARD",
      "name": "text",
      "active": true
    }
  ],
  "assets": {
    "logo": {
      "url": "text",
      "assetUid": "text"
    },
    "splash": {
      "url": "text",
      "assetUid": "text"
    }
  },
  "timezone": "text",
  "languageCode": "text",
  "currency": {
    "code": "text",
    "name": "text",
    "symbol": "text",
    "symbolPosition": "text",
    "decimalSeparator": "text",
    "thousandSeparator": "text",
    "cashRounding": 1
  }
}

List users

get

List all users.

Required access: Tenant.Admin

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

querystringOptional

Query string for tenant users

tenantuserOrganizationUidstringOptional

Reference to an Organization

Pattern: ^[A-Za-z0-9-_]+

tenantuserStoreUidstringOptional

Reference to a Store

Pattern: ^[A-Za-z0-9-_]+

Responses

200

Example response

application/json

get

GET /v2/tenants/{tenantUid}/users HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "accountType": "FULL",
      "createdAt": "2025-07-30T16:45:37.204Z",
      "defaultStoreUid": "text",
      "displayName": "text",
      "email": "text",
      "externalId": "text",
      "firstname": "text",
      "lastAccessed": "2025-07-30T16:45:37.204Z",
      "lastModifiedAt": "2025-07-30T16:45:37.204Z",
      "lastname": "text",
      "mobile": "text",
      "status": "PENDING_INVITE",
      "storeAccess": [
        {
          "createdAt": "2025-07-30T16:45:37.204Z",
          "lastModifiedAt": "2025-07-30T16:45:37.204Z",
          "storeAccessUid": "text",
          "storeUid": "text",
          "storeRole": "ADMIN"
        }
      ],
      "tenantUid": "text",
      "tenantRole": "ACCESS",
      "tenantUserUid": "text",
      "userCode": "text",
      "languageCode": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new user on a tenant

post

Add user to tenant

Required access: Tenant.Admin

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Body

Email is required when accountType is FULL

accountTypestring · enumRequired

ENUM	Description
FULL	Access to backoffice and onboarding of new devices
REGULAR	Can only login to already onboarded devices
SUPPORT	Support account
INTEGRATION	Computer integration account

Possible values:

displayNamestringOptional

emailstringOptional

externalIdstringOptional

firstnamestringOptional

lastnamestringOptional

mobilestringOptional

passwordstringRequired

tenantRolestring · enumRequired

ENUM	Description
BLOCKED	Blocked from this tenant
ACCESS	Only access to the tenant.
ADMIN	Tenant admin, allow full access to tenant and can add users and new stores.
BACKOFFICE	Access to product, pricelists, etc.

Possible values:

userCodestringRequired

tenantUserUidstringOptionalPattern: ^[A-Za-z0-9-_]+

languageCodestringOptional

ISO 639-1 code for language

Responses

200

Tenant user respose

application/json

post

POST /v2/tenants/{tenantUid}/users HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 234

{
  "accountType": "FULL",
  "displayName": "text",
  "email": "text",
  "externalId": "text",
  "firstname": "text",
  "lastname": "text",
  "mobile": "text",
  "password": "text",
  "tenantRole": "ACCESS",
  "userCode": "text",
  "tenantUserUid": "text",
  "languageCode": "text"
}

200

Tenant user respose

{
  "accountType": "FULL",
  "createdAt": "2025-07-30T16:45:37.204Z",
  "defaultStoreUid": "text",
  "displayName": "text",
  "email": "text",
  "externalId": "text",
  "firstname": "text",
  "lastAccessed": "2025-07-30T16:45:37.204Z",
  "lastModifiedAt": "2025-07-30T16:45:37.204Z",
  "lastname": "text",
  "mobile": "text",
  "status": "PENDING_INVITE",
  "storeAccess": [
    {
      "createdAt": "2025-07-30T16:45:37.204Z",
      "lastModifiedAt": "2025-07-30T16:45:37.204Z",
      "storeAccessUid": "text",
      "storeUid": "text",
      "storeRole": "ADMIN"
    }
  ],
  "tenantUid": "text",
  "tenantRole": "ACCESS",
  "tenantUserUid": "text",
  "userCode": "text",
  "languageCode": "text"
}

Get user details

get

Get details for a user.

Required access: Tenant.Admin

Authorizations

Path parameters

tenantUserUidstringRequired

Reference to a TenantUser.

Pattern: ^[A-Za-z0-9-_]+

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Responses

200

Tenant user respose

application/json

get

GET /v2/tenants/{tenantUid}/users/{tenantUserUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Tenant user respose

{
  "accountType": "FULL",
  "createdAt": "2025-07-30T16:45:37.204Z",
  "defaultStoreUid": "text",
  "displayName": "text",
  "email": "text",
  "externalId": "text",
  "firstname": "text",
  "lastAccessed": "2025-07-30T16:45:37.204Z",
  "lastModifiedAt": "2025-07-30T16:45:37.204Z",
  "lastname": "text",
  "mobile": "text",
  "status": "PENDING_INVITE",
  "storeAccess": [
    {
      "createdAt": "2025-07-30T16:45:37.204Z",
      "lastModifiedAt": "2025-07-30T16:45:37.204Z",
      "storeAccessUid": "text",
      "storeUid": "text",
      "storeRole": "ADMIN"
    }
  ],
  "tenantUid": "text",
  "tenantRole": "ACCESS",
  "tenantUserUid": "text",
  "userCode": "text",
  "languageCode": "text"
}

Update tenant user

put

Update user access for a tenant

Required access: Tenant.Admin

Authorizations

Path parameters

tenantUserUidstringRequired

Reference to a TenantUser.

Pattern: ^[A-Za-z0-9-_]+

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

resendInvitebooleanOptional

Check external payment gateways and fetch status

Body

accountTypestring · enumOptional

ENUM	Description
FULL	Access to backoffice and onboarding of new devices
REGULAR	Can only login to already onboarded devices
SUPPORT	Support account
INTEGRATION	Computer integration account

Possible values:

defaultStoreUidstringOptionalPattern: ^[A-Za-z0-9-_]+

displayNamestringOptional

emailstringOptional

externalIdstringOptional

firstnamestringOptional

lastnamestringOptional

mobilestringOptional

passwordstringOptional

tenantRolestring · enumOptional

ENUM	Description
BLOCKED	Blocked from this tenant
ACCESS	Only access to the tenant.
ADMIN	Tenant admin, allow full access to tenant and can add users and new stores.
BACKOFFICE	Access to product, pricelists, etc.

Possible values:

userCodestringOptional

languageCodestringOptional

ISO 639-1 code for language

Responses

200

Tenant user respose

application/json

put

PUT /v2/tenants/{tenantUid}/users/{tenantUserUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 292

{
  "accountType": "FULL",
  "defaultStoreUid": "text",
  "displayName": "text",
  "email": "text",
  "externalId": "text",
  "firstname": "text",
  "lastname": "text",
  "mobile": "text",
  "password": "text",
  "storeAccess": [
    {
      "storeUid": "text",
      "storeRole": "ADMIN"
    }
  ],
  "tenantRole": "ACCESS",
  "userCode": "text",
  "languageCode": "text"
}

200

Tenant user respose

{
  "accountType": "FULL",
  "createdAt": "2025-07-30T16:45:37.204Z",
  "defaultStoreUid": "text",
  "displayName": "text",
  "email": "text",
  "externalId": "text",
  "firstname": "text",
  "lastAccessed": "2025-07-30T16:45:37.204Z",
  "lastModifiedAt": "2025-07-30T16:45:37.204Z",
  "lastname": "text",
  "mobile": "text",
  "status": "PENDING_INVITE",
  "storeAccess": [
    {
      "createdAt": "2025-07-30T16:45:37.204Z",
      "lastModifiedAt": "2025-07-30T16:45:37.204Z",
      "storeAccessUid": "text",
      "storeUid": "text",
      "storeRole": "ADMIN"
    }
  ],
  "tenantUid": "text",
  "tenantRole": "ACCESS",
  "tenantUserUid": "text",
  "userCode": "text",
  "languageCode": "text"
}

Delete a user from a tenant

delete

Deletes a user completely from a tenant.

Required access: Tenant.Admin

Authorizations

Path parameters

tenantUserUidstringRequired

Reference to a TenantUser.

Pattern: ^[A-Za-z0-9-_]+

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Responses

204

No Content

delete

DELETE /v2/tenants/{tenantUid}/users/{tenantUserUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

Get list of integration tokens for a tenant user.

get

Get list of integration tokens for a tenant user.

Required access: Tenant.Admin

Authorizations

Path parameters

tenantUserUidstringRequired

Reference to a TenantUser.

Pattern: ^[A-Za-z0-9-_]+

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Responses

200

Example response

application/json

get

GET /v2/tenants/{tenantUid}/users/{tenantUserUid}/tokens HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "tenantUserTokenUid": "text",
      "token": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create integration token for a tenant user

post

Create integration token for a tenant user

Required access: Tenant.Admin

Authorizations

Path parameters

tenantUserUidstringRequired

Reference to a TenantUser.

Pattern: ^[A-Za-z0-9-_]+

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Responses

200

Example response

application/json

post

POST /v2/tenants/{tenantUid}/users/{tenantUserUid}/tokens HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "tenantUserTokenUid": "text",
      "token": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Delete an integration token from a tenant user

delete

Deletes an integration token for a tenant user

Required access: Tenant.Admin

Authorizations

Path parameters

tenantUserTokenUidstringRequired

Reference to a TenantUserToken.

Pattern: ^[A-Za-z0-9-_]+

tenantUserUidstringRequired

Reference to a TenantUser.

Pattern: ^[A-Za-z0-9-_]+

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Responses

204

No Content

delete

DELETE /v2/tenants/{tenantUid}/users/{tenantUserUid}/tokens/{tenantUserTokenUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content