Owners
/
List company owners

Fluid Commerce APIs (1.0)

The Fluid Commerce APIs provides a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. This bundle offers robust functionality for enhancing messaging solutions, streamlining data management, and improving customer interactions. With detailed documentation, secure authentication, and flexible integration options, the Fluid Public API Bundle is engineered to help you leverage our services efficiently and effectively, unlocking new potentials and achieving greater connectivity within your systems.

Download OpenAPI description
swagger.json
swagger.yaml
Overview
E-mail support@fluid.app
License MIT
Languages
Servers
Mock server
https://docs.fluid.app/_mock/docs/apis/swagger/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Admins

Operations

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Theme Templates

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Categories

Operations

Collections

Operations

Companies

Operations

Company Admins

Operations

Company Countries

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Email Settings

Operations

Company Mobile Widgets

Operations

Company Pages

Operations

Pages

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Social Media

Operations

Company Settings - Warehouses

Operations

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Display Settings

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Entities

Operations

FairShare Order Journey

Operations

Fantasy Points

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Menus

Operations

Metafield Definitions

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

List company owners

Request

Path
company_idintegerrequired
Example: 1
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/owners' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

owners retrieved

Bodyapplication/json
ownersArray of objectsrequired
owners[].​idinteger
Example: 1
owners[].​entity_idinteger
Example: 1
owners[].​full_namestring
Example: "John Doe"
owners[].​native_namestring or null
Example: "John Doe"
owners[].​work_emailstring
Example: "john.doe@company.com"
owners[].​date_of_birthstring or null
Example: "1980-01-15"
owners[].​place_of_birthstring or null
Example: "New York"
owners[].​nationalitystring or null
Example: "US"
owners[].​country_isostring or null
Example: "US"
owners[].​street_addressstring or null
Example: "123 Main St"
owners[].​citystring or null
Example: "New York"
owners[].​statestring or null
Example: "NY"
owners[].​postcodestring or null
Example: "10001"
owners[].​identification_numberstring or null
Example: "123-45-6789"
owners[].​is_managing_directorboolean or null
Example: false
owners[].​is_beneficial_ownerboolean or null
Example: true
owners[].​percent_ownershipstring or null
Example: "25.5"
owners[].​is_authorized_signatoryboolean or null
Example: false
owners[].​created_atstring
Example: "2025-01-15T10:30:00Z"
owners[].​updated_atstring
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{
  "owners": [
    { … }
  ],
  "meta": {}
}

Create company owner

Request

Path
company_idintegerrequired
Example: 1
Bodyapplication/json
ownerobjectrequired
owner.​entity_idintegerrequired

Associated entity ID

Example: 1
owner.​full_namestringrequired

Owner's full name

Example: "John Doe"
owner.​native_namestring or null

Owner's native name

Example: "John Doe"
owner.​work_emailstringrequired

Work email address

Example: "john.doe@company.com"
owner.​date_of_birthstring or null

Date of birth (YYYY-MM-DD)

Example: "1980-01-15"
owner.​place_of_birthstring or null

Place of birth

Example: "New York"
owner.​nationalitystring or null

Nationality

Example: "US"
owner.​country_isostring or null

Country ISO code

Example: "US"
owner.​street_addressstring or null

Street address

Example: "123 Main St"
owner.​citystring or null

City

Example: "New York"
owner.​statestring or null

State/Province

Example: "NY"
owner.​postcodestring or null

Postal code

Example: "10001"
owner.​identification_numberstring or null

Identification number

Example: "123-45-6789"
owner.​is_managing_directorboolean or null

Is managing director

Example: false
owner.​is_beneficial_ownerboolean or null

Is beneficial owner

Example: true
owner.​percent_ownershipstring or null

Percentage of ownership

Example: 25.5
owner.​is_authorized_signatoryboolean or null

Is authorized signatory

Example: false
curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/owners' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "owner": {
      "entity_id": 1,
      "full_name": "John Doe",
      "native_name": "John Doe",
      "work_email": "john.doe@company.com",
      "date_of_birth": "1980-01-15",
      "place_of_birth": "New York",
      "nationality": "US",
      "country_iso": "US",
      "street_address": "123 Main St",
      "city": "New York",
      "state": "NY",
      "postcode": "10001",
      "identification_number": "123-45-6789",
      "is_managing_director": false,
      "is_beneficial_owner": true,
      "percent_ownership": 25.5,
      "is_authorized_signatory": false
    }
  }'

Responses

owner created

Bodyapplication/json
ownerobjectrequired
owner.​idinteger
Example: 1
owner.​entity_idinteger
Example: 1
owner.​full_namestring
Example: "John Doe"
owner.​native_namestring or null
Example: "John Doe"
owner.​work_emailstring
Example: "john.doe@company.com"
owner.​date_of_birthstring or null
Example: "1980-01-15"
owner.​place_of_birthstring or null
Example: "New York"
owner.​nationalitystring or null
Example: "US"
owner.​country_isostring or null
Example: "US"
owner.​street_addressstring or null
Example: "123 Main St"
owner.​citystring or null
Example: "New York"
owner.​statestring or null
Example: "NY"
owner.​postcodestring or null
Example: "10001"
owner.​identification_numberstring or null
Example: "123-45-6789"
owner.​is_managing_directorboolean or null
Example: false
owner.​is_beneficial_ownerboolean or null
Example: true
owner.​percent_ownershipstring or null
Example: "25.5"
owner.​is_authorized_signatoryboolean or null
Example: false
owner.​created_atstring
Example: "2025-01-15T10:30:00Z"
owner.​updated_atstring
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{
  "owner": {
    "id": 1,
    "entity_id": 1,
    "full_name": "John Doe",
    "native_name": "John Doe",
    "work_email": "john.doe@company.com",
    "date_of_birth": "1980-01-15",
    "place_of_birth": "New York",
    "nationality": "US",
    "country_iso": "US",
    "street_address": "123 Main St",
    "city": "New York",
    "state": "NY",
    "postcode": "10001",
    "identification_number": "123-45-6789",
    "is_managing_director": false,
    "is_beneficial_owner": true,
    "percent_ownership": "25.5",
    "is_authorized_signatory": false,
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  },
  "meta": {}
}

Get company owner

Request

Path
company_idintegerrequired
Example: 1
idintegerrequired
Example: 1
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/owners/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

owner retrieved

Bodyapplication/json
ownerobjectrequired
owner.​idinteger
Example: 1
owner.​entity_idinteger
Example: 1
owner.​full_namestring
Example: "John Doe"
owner.​native_namestring or null
Example: "John Doe"
owner.​work_emailstring
Example: "john.doe@company.com"
owner.​date_of_birthstring or null
Example: "1980-01-15"
owner.​place_of_birthstring or null
Example: "New York"
owner.​nationalitystring or null
Example: "US"
owner.​country_isostring or null
Example: "US"
owner.​street_addressstring or null
Example: "123 Main St"
owner.​citystring or null
Example: "New York"
owner.​statestring or null
Example: "NY"
owner.​postcodestring or null
Example: "10001"
owner.​identification_numberstring or null
Example: "123-45-6789"
owner.​is_managing_directorboolean or null
Example: false
owner.​is_beneficial_ownerboolean or null
Example: true
owner.​percent_ownershipstring or null
Example: "25.5"
owner.​is_authorized_signatoryboolean or null
Example: false
owner.​created_atstring
Example: "2025-01-15T10:30:00Z"
owner.​updated_atstring
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{
  "owner": {
    "id": 1,
    "entity_id": 1,
    "full_name": "John Doe",
    "native_name": "John Doe",
    "work_email": "john.doe@company.com",
    "date_of_birth": "1980-01-15",
    "place_of_birth": "New York",
    "nationality": "US",
    "country_iso": "US",
    "street_address": "123 Main St",
    "city": "New York",
    "state": "NY",
    "postcode": "10001",
    "identification_number": "123-45-6789",
    "is_managing_director": false,
    "is_beneficial_owner": true,
    "percent_ownership": "25.5",
    "is_authorized_signatory": false,
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  },
  "meta": {}
}

Update company owner

Request

Path
company_idintegerrequired
Example: 1
idintegerrequired
Example: 1
Bodyapplication/json
ownerobjectrequired
owner.​entity_idinteger or null

Associated entity ID

Example: 1
owner.​full_namestring or null

Owner's full name

Example: "John Doe"
owner.​native_namestring or null

Owner's native name

Example: "John Doe"
owner.​work_emailstring or null

Work email address

Example: "john.doe@company.com"
owner.​date_of_birthstring or null

Date of birth (YYYY-MM-DD)

Example: "1980-01-15"
owner.​place_of_birthstring or null

Place of birth

Example: "New York"
owner.​nationalitystring or null

Nationality

Example: "US"
owner.​country_isostring or null

Country ISO code

Example: "US"
owner.​street_addressstring or null

Street address

Example: "123 Main St"
owner.​citystring or null

City

Example: "New York"
owner.​statestring or null

State/Province

Example: "NY"
owner.​postcodestring or null

Postal code

Example: "10001"
owner.​identification_numberstring or null

Identification number

Example: "123-45-6789"
owner.​is_managing_directorboolean or null

Is managing director

Example: false
owner.​is_beneficial_ownerboolean or null

Is beneficial owner

Example: true
owner.​percent_ownershipstring or null

Percentage of ownership

Example: "25.5"
owner.​is_authorized_signatoryboolean or null

Is authorized signatory

Example: false
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/owners/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "owner": {
      "entity_id": 1,
      "full_name": "John Doe",
      "native_name": "John Doe",
      "work_email": "john.doe@company.com",
      "date_of_birth": "1980-01-15",
      "place_of_birth": "New York",
      "nationality": "US",
      "country_iso": "US",
      "street_address": "123 Main St",
      "city": "New York",
      "state": "NY",
      "postcode": "10001",
      "identification_number": "123-45-6789",
      "is_managing_director": false,
      "is_beneficial_owner": true,
      "percent_ownership": "25.5",
      "is_authorized_signatory": false
    }
  }'

Responses

owner updated

Bodyapplication/json
ownerobjectrequired
owner.​idinteger
Example: 1
owner.​entity_idinteger
Example: 1
owner.​full_namestring
Example: "John Doe"
owner.​native_namestring or null
Example: "John Doe"
owner.​work_emailstring
Example: "john.doe@company.com"
owner.​date_of_birthstring or null
Example: "1980-01-15"
owner.​place_of_birthstring or null
Example: "New York"
owner.​nationalitystring or null
Example: "US"
owner.​country_isostring or null
Example: "US"
owner.​street_addressstring or null
Example: "123 Main St"
owner.​citystring or null
Example: "New York"
owner.​statestring or null
Example: "NY"
owner.​postcodestring or null
Example: "10001"
owner.​identification_numberstring or null
Example: "123-45-6789"
owner.​is_managing_directorboolean or null
Example: false
owner.​is_beneficial_ownerboolean or null
Example: true
owner.​percent_ownershipstring or null
Example: "25.5"
owner.​is_authorized_signatoryboolean or null
Example: false
owner.​created_atstring
Example: "2025-01-15T10:30:00Z"
owner.​updated_atstring
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{
  "owner": {
    "id": 1,
    "entity_id": 1,
    "full_name": "John Doe",
    "native_name": "John Doe",
    "work_email": "john.doe@company.com",
    "date_of_birth": "1980-01-15",
    "place_of_birth": "New York",
    "nationality": "US",
    "country_iso": "US",
    "street_address": "123 Main St",
    "city": "New York",
    "state": "NY",
    "postcode": "10001",
    "identification_number": "123-45-6789",
    "is_managing_director": false,
    "is_beneficial_owner": true,
    "percent_ownership": "25.5",
    "is_authorized_signatory": false,
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  },
  "meta": {}
}

Delete company owner

Request

Path
company_idintegerrequired
Example: 1
idintegerrequired
Example: 1
curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/companies/{company_id}/owners/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

owner deleted

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Search

Operations

Settings

Operations

Settings - Companies

Operations

Shares

Operations

Shop

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhook Schemas

Operations

Webhooks

Operations