Organization | Flow Retail Docs

List organizations

get

List all organizations.

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Query parameters

organizationExternalIdstringOptional

External reference to an organization.

organizationNamestringOptional

Reference to the name of an organization.

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/{tenantUid}/organizations HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "address": "text",
      "city": "text",
      "countryCode": "text",
      "createdAt": "2025-07-30T18:07:08.642Z",
      "email": "text",
      "externalId": "text",
      "isActive": true,
      "lastModifiedAt": "2025-07-30T18:07:08.642Z",
      "name": "text",
      "postalCode": "text",
      "phone": "text",
      "organizationUid": "text",
      "vatNumber": "text",
      "bankInfo": {
        "accountNumber": "text",
        "bankName": "text",
        "iban": "text",
        "swift": "text"
      },
      "websiteUrl": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new organization

post

Creates a new organization.

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

all ofOptional

and

Responses

200

Example response

application/json

post

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

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "name": "text",
  "phone": "text",
  "postalCode": "text",
  "vatNumber": "text",
  "websiteUrl": "text",
  "bankInfo": {
    "accountNumber": "text",
    "bankName": "text",
    "iban": "text",
    "swift": "text"
  },
  "organizationUid": "text"
}

200

Example response

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "createdAt": "2025-07-30T18:07:08.642Z",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2025-07-30T18:07:08.642Z",
  "name": "text",
  "postalCode": "text",
  "phone": "text",
  "organizationUid": "text",
  "vatNumber": "text",
  "bankInfo": {
    "accountNumber": "text",
    "bankName": "text",
    "iban": "text",
    "swift": "text"
  },
  "websiteUrl": "text"
}

Get organization details

get

Get details for an organization.

Authorizations

Path parameters

organizationUidstringRequired

Reference to an organization.

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}/organizations/{organizationUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "createdAt": "2025-07-30T18:07:08.642Z",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2025-07-30T18:07:08.642Z",
  "name": "text",
  "postalCode": "text",
  "phone": "text",
  "organizationUid": "text",
  "vatNumber": "text",
  "bankInfo": {
    "accountNumber": "text",
    "bankName": "text",
    "iban": "text",
    "swift": "text"
  },
  "websiteUrl": "text"
}

Update organization details

put

Update details for an organization. Partial updates are allowed.

Authorizations

Path parameters

organizationUidstringRequired

Reference to an organization.

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

tenantUidstringRequired

Reference to a tenant.

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

Body

addressstringOptional

citystringOptional

countryCodestringOptional

emailstringOptional

externalIdstringOptional

isActivebooleanOptional

namestringRequired

phonestringOptional

postalCodestringOptional

vatNumberstringOptional

VAT identification number for value added tax reporting purposes.

websiteUrlstringOptional

Responses

201

Example response

application/json

put

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

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "name": "text",
  "phone": "text",
  "postalCode": "text",
  "vatNumber": "text",
  "websiteUrl": "text",
  "bankInfo": {
    "accountNumber": "text",
    "bankName": "text",
    "iban": "text",
    "swift": "text"
  }
}

201

Example response

{
  "address": "text",
  "city": "text",
  "countryCode": "text",
  "createdAt": "2025-07-30T18:07:08.642Z",
  "email": "text",
  "externalId": "text",
  "isActive": true,
  "lastModifiedAt": "2025-07-30T18:07:08.642Z",
  "name": "text",
  "postalCode": "text",
  "phone": "text",
  "organizationUid": "text",
  "vatNumber": "text",
  "bankInfo": {
    "accountNumber": "text",
    "bankName": "text",
    "iban": "text",
    "swift": "text"
  },
  "websiteUrl": "text"
}

Delete an organization

delete

Deletes a organizations.

Authorizations

Path parameters

organizationUidstringRequired

Reference to an organization.

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

tenantUidstringRequired

Reference to a tenant.

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

Responses

204

No Content

delete

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

204

No Content

No content