Fluid Company APIs (1.0)

The Fluid Company APIs provide a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. These APIs use Company API tokens for authentication and provide full access to manage your company's resources including users, orders, products, media, and more.

For APIs that authenticate with User tokens, see the Rep APIs documentation.

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

Activities

Operations

Admins

Operations

Add current user as admin to a company

Request

Add current user as admin to specified company. Accessible only by root admins.

Headers
Authorizationstringrequired

Bearer token for authentication

Bodyapplication/json
company_idintegerrequired

Company ID to add admin access to

curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/company_admins \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "company_id": 0
  }'

Responses

Successfully added as admin

Bodyapplication/json
user_companyobjectrequired
user_company.​idintegerrequired
user_company.​activebooleanrequired
user_company.​company_idintegerrequired
user_company.​company_namestringrequired
user_company.​rolesArray of stringsrequired
user_company.​user_typestringrequired
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{ "user_company": { "id": 0, "active": true, "company_id": 0, "company_name": "string", "roles": [], "user_type": "string" }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Remove current user's admin access from a company

Request

Remove current user's admin access from specified company. Accessible only by root admins.

Headers
Authorizationstringrequired

Bearer token for authentication

Bodyapplication/json
company_idintegerrequired

Company ID to remove admin access from

curl -i -X DELETE \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/company_admins \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "company_id": 0
  }'

Responses

Successfully removed admin access

Bodyapplication/json
company_idintegerrequired
user_company_idintegerrequired
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{ "company_id": 0, "user_company_id": 0, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

List all admins

Request

Query
paginationobject
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/admins?active=true&page=0&per_page=100&search_query=string&sorted_by=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

admins found

Bodyapplication/json
adminsArray of objects(UserCompany)required
admins[].​idintegerrequired
admins[].​activeboolean or null
Default true
admins[].​external_idstring or null
admins[].​usernamestring or null
admins[].​first_namestringrequired
admins[].​last_namestringrequired
admins[].​created_atstring(date-time)required
admins[].​image_urlstring or null
admins[].​share_guidstring>= 2 characters^[a-z0-9\-_]+$required
admins[].​countryobject or null
admins[].​languageobject or null
admins[].​rolesArray of arrays or null or null
admins[].​computed_full_namestring or null
admins[].​computed_emailstring or null
admins[].​phonestring or null
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
meta.​paginationobject
Response
application/json
{ "admins": [ {} ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z", "pagination": {} } }

Create an admin

Request

Bodyapplication/json
adminobjectrequired
admin.​first_namestring
admin.​last_namestring
admin.​emailstringrequired
admin.​phonestring
admin.​activeboolean
admin.​external_idstring
admin.​usernamestring
admin.​rolesArray of arrays
admin.​admin_rolesArray of integers
admin.​language_codestring
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/admins \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "admin": {
      "first_name": "string",
      "last_name": "string",
      "email": "string",
      "phone": "string",
      "active": true,
      "external_id": "string",
      "username": "string",
      "roles": [],
      "admin_roles": [
        0
      ],
      "language_code": "string"
    }
  }'

Responses

admin created

Bodyapplication/json
adminobject(UserCompany)required
admin.​idintegerrequired
admin.​activeboolean or null
Default true
admin.​external_idstring or null
admin.​usernamestring or null
admin.​first_namestringrequired
admin.​last_namestringrequired
admin.​created_atstring(date-time)required
admin.​image_urlstring or null
admin.​share_guidstring>= 2 characters^[a-z0-9\-_]+$required
admin.​countryobject or null
admin.​languageobject or null
admin.​rolesArray of arrays or null or null
admin.​computed_full_namestring or null
admin.​computed_emailstring or null
admin.​phonestring or null
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{ "admin": { "id": 0, "active": true, "external_id": "string", "username": "string", "first_name": "string", "last_name": "string", "created_at": "2019-08-24T14:15:22Z", "image_url": "string", "share_guid": "string", "country": {}, "language": {}, "roles": [], "computed_full_name": "string", "computed_email": "string", "phone": "string" }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Retrieve an admin

Request

Path
idintegerrequired
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/admins/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

admin found

Bodyapplication/json
adminobject(UserCompany)required
admin.​idintegerrequired
admin.​activeboolean or null
Default true
admin.​external_idstring or null
admin.​usernamestring or null
admin.​first_namestringrequired
admin.​last_namestringrequired
admin.​created_atstring(date-time)required
admin.​image_urlstring or null
admin.​share_guidstring>= 2 characters^[a-z0-9\-_]+$required
admin.​countryobject or null
admin.​languageobject or null
admin.​rolesArray of arrays or null or null
admin.​computed_full_namestring or null
admin.​computed_emailstring or null
admin.​phonestring or null
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{ "admin": { "id": 0, "active": true, "external_id": "string", "username": "string", "first_name": "string", "last_name": "string", "created_at": "2019-08-24T14:15:22Z", "image_url": "string", "share_guid": "string", "country": {}, "language": {}, "roles": [], "computed_full_name": "string", "computed_email": "string", "phone": "string" }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Update an admin

Request

Path
idintegerrequired
Bodyapplication/json
idintegerrequired
adminobjectrequired
admin.​first_namestring
admin.​last_namestring
admin.​emailstring
admin.​phonestring
admin.​activeboolean
admin.​external_idstring
admin.​usernamestring
admin.​rolesArray of arrays
admin.​admin_rolesArray of integers
admin.​language_codestring
admin.​country_codestring
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/admins/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "admin": {
      "first_name": "string",
      "last_name": "string",
      "email": "string",
      "phone": "string",
      "active": true,
      "external_id": "string",
      "username": "string",
      "roles": [],
      "admin_roles": [
        0
      ],
      "language_code": "string",
      "country_code": "string"
    }
  }'

Responses

admin updated

Bodyapplication/json
adminobject(UserCompany)required
admin.​idintegerrequired
admin.​activeboolean or null
Default true
admin.​external_idstring or null
admin.​usernamestring or null
admin.​first_namestringrequired
admin.​last_namestringrequired
admin.​created_atstring(date-time)required
admin.​image_urlstring or null
admin.​share_guidstring>= 2 characters^[a-z0-9\-_]+$required
admin.​countryobject or null
admin.​languageobject or null
admin.​rolesArray of arrays or null or null
admin.​computed_full_namestring or null
admin.​computed_emailstring or null
admin.​phonestring or null
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{ "admin": { "id": 0, "active": true, "external_id": "string", "username": "string", "first_name": "string", "last_name": "string", "created_at": "2019-08-24T14:15:22Z", "image_url": "string", "share_guid": "string", "country": {}, "language": {}, "roles": [], "computed_full_name": "string", "computed_email": "string", "phone": "string" }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Delete an admin

Request

Path
idintegerrequired
curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/admins/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

admin deleted

Bodyapplication/json
idintegerrequired
metaobjectrequired
meta.​request_idstring
Example: "123e4567-e89b-12d3-a456-426614174000"
meta.​timestampstring
Example: "2021-01-01T00:00:00Z"
Response
application/json
{ "id": 0, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Agreements

Operations

Announcements

Operations

ApplePay

Operations

Application Theme Resources

Operations

Application Theme Templates

Operations

Application Themes

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

Conversations

Operations

Countries

Operations

Currencies

Operations

Customer Notes

Operations

Customer Orders

Operations

Customers

Operations

DAM Query

Operations

Dam

Operations

Default MySites

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

Events

Operations

FairShare Order Journey

Operations

Feature Flags

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

Global Embeds

Operations

Inventory Levels

Operations

Labels

Operations

Languages

Operations

Libraries

Operations

MCC Codes

Operations

Media

Operations

Messages

Operations

Metafield Definitions

Operations

Metafields

Operations

Mobile Widgets

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Onboarding Info

Operations

Order Fulfillments

Operations

Orders

Operations

Owners

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Points

Operations

Points Ledgers

Operations

Points Values

Operations

Posts

Operations

Product Bundles

Operations

Product Images

Operations

Product Subscription Plans

Operations

Products

Operations

Prompts

Operations

Public Assets

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Recipients

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Root Themes

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

Tiles

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variant Images

Operations

Variant Inventory Levels

Operations

Variants

Operations

Warehouses

Operations

Webhook Events

Operations

Webhook Schemas

Operations

Webhooks

Operations

Webhooks Resources

Operations

affiliate

Operations

carts

Operations

checkout

Operations

enrollment-packs

Operations

events

Operations

fingerprint

Operations

lead

Operations

media

Operations

page

Operations

playlist

Operations

product

Operations

session

Operations

settings

Operations

url

Operations

widgets

Operations