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

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

Lists roles for a company

Request

Query
pageinteger

Page number for pagination

per_pageinteger

Number of items per page (max 25)

sorted_bystring

Sort field and direction (e.g., 'name_asc', 'created_at_desc', 'users_asc', 'permissions_desc')

search_querystring

Search term to filter roles by name

max_user_countinteger

Maximum number of users assigned to roles (inclusive)

min_user_countinteger

Minimum number of users assigned to roles (inclusive)

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/roles?max_user_count=0&min_user_count=0&page=0&per_page=0&search_query=string&sorted_by=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

returns roles successfully

Bodyapplication/json
rolesArray of objectsrequired

List of roles

roles[].​idintegerrequired
roles[].​namestringrequired
roles[].​createdAtstring(date-time)
roles[].​user_countinteger
roles[].​permissionsobject
roles[].​property name*anyadditional property
metaobjectrequired
meta.​request_idstringrequired
meta.​timestampstringrequired
meta.​paginationobject
meta.​countinteger
meta.​property name*anyadditional property
Response
application/json
{ "roles": [ {} ], "meta": { "request_id": "string", "timestamp": "string", "pagination": {}, "count": 0 } }

Creates a new role for a company

Request

Bodyapplication/json
roleobjectrequired
role.​namestringrequired
role.​permissionsobject
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/company/roles \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "role": {
      "name": "string",
      "permissions": {}
    }
  }'

Responses

role created successfully

Updates a role

Request

Path
idstringrequired
Bodyapplication/json
roleobject
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/roles/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "role": {
      "permissions": {}
    }
  }'

Responses

successfully updates role permissions

Deletes a role

Request

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

Responses

role successfully deleted

Get roles structure for the company

Request

Get the structure of roles including available actions and categories for permission management

curl -i -X GET \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/company/roles/structure \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

structure retrieved successfully for admin user

Bodyapplication/json
headersArray of stringsrequired
categoriesArray of objectsrequired
categories[].​keystringrequired
categories[].​labelstringrequired
categories[].​resourcesArray of objectsrequired
categories[].​resources[].​keystringrequired
categories[].​resources[].​labelstringrequired
categories[].​resources[].​actionsArray of stringsrequired
metaobject
Response
application/json
{ "headers": [ "string" ], "categories": [ {} ], "meta": { "request_id": "string", "timestamp": "string" } }

Duplicates a role

Request

Path
idstringrequired
curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/roles/{id}/duplicate' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

role duplicated successfully

Get current user's permissions

Request

Get the current user's permissions and roles for the current company

curl -i -X GET \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/company/roles/my_permissions \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

boolean type casting works correctly for permission values

Bodyapplication/json
permissionsobjectrequired

Hash of resource permissions with their actions

Example: {"roles":{"create":true,"view":true,"update":true,"delete":true}}
permissions.​property name*anyadditional property
rolesArray of stringsrequired

List of role names assigned to the user

Example: ["admin","developer"]
is_super_adminbooleanrequired

Whether the user is a super admin

metaobjectrequired

Metadata about the request

meta.​request_idstring
meta.​timestampstring
Response
application/json
{ "permissions": { "roles": {} }, "roles": [ "admin", "developer" ], "is_super_admin": true, "meta": { "request_id": "string", "timestamp": "string" } }

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