Owners
/
Create company owner

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 Themes

Operations

ApplicationThemeResources

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Bank Accounts

Operations

Brand Guidelines

Operations

Business Types

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Callback Schemas

Operations

Carts

Operations

Catch Ups

Operations

Categories

Operations

Checkout

Operations

Collections

Operations

Companies

Operations

Company Countries

Operations

Contacts

Operations

Countries

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default Libraries

Operations

DefaultMySites

Operations

Devices

Operations

Discounts

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 Orchestration

Operations

Fluid Orchestration - Configurations

Operations

Fluid Orchestration - Rule Based

Operations

Fluid Orchestration - Default Fallback

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Impersonation

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

MCC Codes

Operations

Media

Operations

Menus

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

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 objects(Company::Owner)required
owners[].​idintegerrequired
owners[].​entity_idintegerrequired
Example: 1
owners[].​full_namestringrequired
Example: "John Doe"
owners[].​native_namestring or null
Example: "John Doe"
owners[].​positionstring or null
Example: "Chief Financial Officer"
owners[].​work_emailstringrequired
Example: "john.doe@company.com"
owners[].​phonestring or null
Example: "+1-555-123-4567"
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[].​onboarding_contactbooleanrequired
Example: false
owners[].​government_issued_idsArray of arrays or null or null
Example: [{"file_url":"https://example.com/passport.pdf","file_name":"passport.pdf","file_type":"passport"}]
owners[].​proof_of_residence_file_urlstring or null
Example: "https://example.com/utility-bill.pdf"
owners[].​proof_of_residence_file_namestring or null
Example: "utility-bill.pdf"
owners[].​created_atstringrequired
Example: "2025-01-15T10:30:00Z"
owners[].​updated_atstringrequired
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
owner.​full_namestringrequired
owner.​work_emailstringrequired
owner.​phonestring
owner.​native_namestring
owner.​positionstring
owner.​date_of_birthstring
owner.​place_of_birthstring
owner.​nationalitystring
owner.​country_isostring
owner.​street_addressstring
owner.​citystring
owner.​statestring
owner.​postcodestring
owner.​identification_numberstring
owner.​is_managing_directorboolean
owner.​is_beneficial_ownerboolean
owner.​percent_ownershipnumber
owner.​is_authorized_signatoryboolean
owner.​onboarding_contactboolean
owner.​government_issued_idsArray of objects
owner.​proof_of_residence_file_urlstring
owner.​proof_of_residence_file_namestring
company_idintegerrequired
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": 0,
      "full_name": "string",
      "work_email": "string",
      "phone": "string",
      "native_name": "string",
      "position": "string",
      "date_of_birth": "string",
      "place_of_birth": "string",
      "nationality": "string",
      "country_iso": "string",
      "street_address": "string",
      "city": "string",
      "state": "string",
      "postcode": "string",
      "identification_number": "string",
      "is_managing_director": true,
      "is_beneficial_owner": true,
      "percent_ownership": 0,
      "is_authorized_signatory": true,
      "onboarding_contact": true,
      "government_issued_ids": [
        {
          "file_url": "string",
          "file_name": "string",
          "file_type": "string"
        }
      ],
      "proof_of_residence_file_url": "string",
      "proof_of_residence_file_name": "string"
    },
    "company_id": 0
  }'

Responses

owner created

Bodyapplication/json
ownerobject(Company::Owner)required
owner.​idintegerrequired
owner.​entity_idintegerrequired
Example: 1
owner.​full_namestringrequired
Example: "John Doe"
owner.​native_namestring or null
Example: "John Doe"
owner.​positionstring or null
Example: "Chief Financial Officer"
owner.​work_emailstringrequired
Example: "john.doe@company.com"
owner.​phonestring or null
Example: "+1-555-123-4567"
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.​onboarding_contactbooleanrequired
Example: false
owner.​government_issued_idsArray of arrays or null or null
Example: [{"file_url":"https://example.com/passport.pdf","file_name":"passport.pdf","file_type":"passport"}]
owner.​proof_of_residence_file_urlstring or null
Example: "https://example.com/utility-bill.pdf"
owner.​proof_of_residence_file_namestring or null
Example: "utility-bill.pdf"
owner.​created_atstringrequired
Example: "2025-01-15T10:30:00Z"
owner.​updated_atstringrequired
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{
  "owner": {
    "id": 0,
    "entity_id": 1,
    "full_name": "John Doe",
    "native_name": "John Doe",
    "position": "Chief Financial Officer",
    "work_email": "john.doe@company.com",
    "phone": "+1-555-123-4567",
    "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,
    "onboarding_contact": false,
    "government_issued_ids": [ … ],
    "proof_of_residence_file_url": "https://example.com/utility-bill.pdf",
    "proof_of_residence_file_name": "utility-bill.pdf",
    "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
ownerobject(Company::Owner)required
owner.​idintegerrequired
owner.​entity_idintegerrequired
Example: 1
owner.​full_namestringrequired
Example: "John Doe"
owner.​native_namestring or null
Example: "John Doe"
owner.​positionstring or null
Example: "Chief Financial Officer"
owner.​work_emailstringrequired
Example: "john.doe@company.com"
owner.​phonestring or null
Example: "+1-555-123-4567"
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.​onboarding_contactbooleanrequired
Example: false
owner.​government_issued_idsArray of arrays or null or null
Example: [{"file_url":"https://example.com/passport.pdf","file_name":"passport.pdf","file_type":"passport"}]
owner.​proof_of_residence_file_urlstring or null
Example: "https://example.com/utility-bill.pdf"
owner.​proof_of_residence_file_namestring or null
Example: "utility-bill.pdf"
owner.​created_atstringrequired
Example: "2025-01-15T10:30:00Z"
owner.​updated_atstringrequired
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{
  "owner": {
    "id": 0,
    "entity_id": 1,
    "full_name": "John Doe",
    "native_name": "John Doe",
    "position": "Chief Financial Officer",
    "work_email": "john.doe@company.com",
    "phone": "+1-555-123-4567",
    "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,
    "onboarding_contact": false,
    "government_issued_ids": [ … ],
    "proof_of_residence_file_url": "https://example.com/utility-bill.pdf",
    "proof_of_residence_file_name": "utility-bill.pdf",
    "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
owner.​full_namestring
owner.​native_namestring
owner.​positionstring
owner.​work_emailstring
owner.​phonestring
owner.​date_of_birthstring
owner.​place_of_birthstring
owner.​nationalitystring
owner.​country_isostring
owner.​street_addressstring
owner.​citystring
owner.​statestring
owner.​postcodestring
owner.​identification_numberstring
owner.​is_managing_directorboolean
owner.​is_beneficial_ownerboolean
owner.​percent_ownershipnumber
owner.​is_authorized_signatoryboolean
owner.​onboarding_contactboolean
owner.​government_issued_idsArray of objects
owner.​proof_of_residence_file_urlstring
owner.​proof_of_residence_file_namestring
company_idintegerrequired
idintegerrequired
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": 0,
      "full_name": "string",
      "native_name": "string",
      "position": "string",
      "work_email": "string",
      "phone": "string",
      "date_of_birth": "string",
      "place_of_birth": "string",
      "nationality": "string",
      "country_iso": "string",
      "street_address": "string",
      "city": "string",
      "state": "string",
      "postcode": "string",
      "identification_number": "string",
      "is_managing_director": true,
      "is_beneficial_owner": true,
      "percent_ownership": 0,
      "is_authorized_signatory": true,
      "onboarding_contact": true,
      "government_issued_ids": [
        {
          "file_url": "string",
          "file_name": "string",
          "file_type": "string"
        }
      ],
      "proof_of_residence_file_url": "string",
      "proof_of_residence_file_name": "string"
    },
    "company_id": 0,
    "id": 0
  }'

Responses

owner updated

Bodyapplication/json
ownerobject(Company::Owner)required
owner.​idintegerrequired
owner.​entity_idintegerrequired
Example: 1
owner.​full_namestringrequired
Example: "John Doe"
owner.​native_namestring or null
Example: "John Doe"
owner.​positionstring or null
Example: "Chief Financial Officer"
owner.​work_emailstringrequired
Example: "john.doe@company.com"
owner.​phonestring or null
Example: "+1-555-123-4567"
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.​onboarding_contactbooleanrequired
Example: false
owner.​government_issued_idsArray of arrays or null or null
Example: [{"file_url":"https://example.com/passport.pdf","file_name":"passport.pdf","file_type":"passport"}]
owner.​proof_of_residence_file_urlstring or null
Example: "https://example.com/utility-bill.pdf"
owner.​proof_of_residence_file_namestring or null
Example: "utility-bill.pdf"
owner.​created_atstringrequired
Example: "2025-01-15T10:30:00Z"
owner.​updated_atstringrequired
Example: "2025-01-15T10:30:00Z"
metaobjectrequired
Response
application/json
{
  "owner": {
    "id": 0,
    "entity_id": 1,
    "full_name": "John Doe",
    "native_name": "John Doe",
    "position": "Chief Financial Officer",
    "work_email": "john.doe@company.com",
    "phone": "+1-555-123-4567",
    "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,
    "onboarding_contact": false,
    "government_issued_ids": [ … ],
    "proof_of_residence_file_url": "https://example.com/utility-bill.pdf",
    "proof_of_residence_file_name": "utility-bill.pdf",
    "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

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Paypal

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

ProductBundles

Operations

ProductImages

Operations

ProductSubscriptionPlans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

Operations

Search

Operations

Shares

Operations

Shop

Operations

Sitemap

Operations

Social Media

Operations

Subscription Plans

Operations

Subscriptions

Operations

System Monitoring

Operations

Tags

Operations

Tax Categories

Operations

Theme Region Rules

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

VariantCountries

Operations

VariantImages

Operations

VariantInventoryLevels

Operations

Variants

Operations

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

Operations

Get a specific media

Request

Path
idintegerrequired

Media ID

Example: 1
Query
language_isostring

Language code for translations (e.g., 'en', 'es', 'de')

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/media/{id}?language_iso=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Media retrieved successfully

Bodyapplication/json
idintegerrequired
user_idinteger or null
titlestringrequired
descriptionobject or null
strippedstring or null
media_typestringrequired
Enum"share""update""training""upload"
media_formatstring or null
image_urlstring or null
video_urlstring or null
pdf_urlstring or null
kindstring or null
activebooleanrequired
visibilityinteger or null
share_linkstring or null
preview_linkstring or null
viewsintegerrequired
leadsintegerrequired
watchobject or null
video_statusstring or null
durationinteger or null
cta_urlstring or null
cta_button_textstring or null
cta_enabledbooleanrequired
cta_action_typestring or null
video_shopping_enabledbooleanrequired
prompts_enabledbooleanrequired
ranksArray of strings
settingsobject or null
application_theme_template_idinteger or null
created_atstring(date-time)required
subtitlesobject or null

Hash of language ISO codes to subtitle text

countriesArray of objects
tagsArray of objects
slugstring or null

URL-friendly slug for the media item

custom_slugboolean

Whether the slug was customized by the user

promptsArray of objects

Only included if media_type is 'share' or 'upload'

attached_shareablesArray of objects
commentsArray of objects

Only included if video_shopping_enabled is true and display_comments is true

labelobject or null

Label object from LabelConcern

display_tagstring or null

Display tag from LabelConcern

Response
application/json
{
  "id": 0,
  "user_id": 0,
  "title": "string",
  "description": {},
  "stripped": "string",
  "media_type": "share",
  "media_format": "string",
  "image_url": "string",
  "video_url": "string",
  "pdf_url": "string",
  "kind": "string",
  "active": true,
  "visibility": 0,
  "share_link": "string",
  "preview_link": "string",
  "views": 0,
  "leads": 0,
  "watch": {},
  "video_status": "string",
  "duration": 0,
  "cta_url": "string",
  "cta_button_text": "string",
  "cta_enabled": true,
  "cta_action_type": "string",
  "video_shopping_enabled": true,
  "prompts_enabled": true,
  "ranks": [
    "string"
  ],
  "settings": {},
  "application_theme_template_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "subtitles": {
    "property1": "string",
    "property2": "string"
  },
  "countries": [
    { … }
  ],
  "tags": [
    { … }
  ],
  "slug": "string",
  "custom_slug": true,
  "prompts": [
    {}
  ],
  "attached_shareables": [
    {}
  ],
  "comments": [
    {}
  ],
  "label": {},
  "display_tag": "string"
}