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

Retrieves an agreement

Request

Path
idintegerrequired
Query
language_isostring
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/agreements/{id}?language_iso=string'

Responses

successful

Bodyapplication/json
agreementobject
metaobject
Response
application/json
{ "agreement": { "id": 101, "title": "Terms and conditions", "active": true, "required_on_checkout": false, "company_country_ids": [], "description": "This is the description/body of the agreement", "show_path": "/agreements/101", "language_iso": "en", "required": true, "enrollment_pack_id": 1, "created_at": "2025-06-02T12:34:56Z", "updated_at": "2025-06-02T12:34:56Z", "company_logo": "https://example.com/logo.png", "attachments": [] }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Updates an agreement

Request

Path
idintegerrequired
Query
language_isostring
Headers
Authorizationstringrequired
Bodyapplication/json
agreementobjectrequired
agreement.​titlestringrequired
Example: "New Agreement"
agreement.​descriptionstringrequired
Example: "This is a new agreement."
agreement.​enrollment_pack_idinteger

ID of the enrollment pack to associate with this agreement

Example: 1
agreement.​attachments_attributesArray of objects
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/agreements/{id}?language_iso=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "agreement": {
      "title": "New Agreement",
      "description": "This is a new agreement.",
      "enrollment_pack_id": 1,
      "attachments_attributes": [
        {
          "url": "http://example.com/file.png",
          "filename": "file.png",
          "kind": "image",
          "content_type": "image/png",
          "content_size": 1024,
          "metadata": {}
        }
      ]
    }
  }'

Responses

successful

Bodyapplication/json
agreementobject
metaobject
Response
application/json
{ "agreement": { "id": 101, "title": "Terms and conditions", "active": true, "required_on_checkout": false, "company_country_ids": [], "description": "This is the description/body of the agreement", "show_path": "/agreements/101", "language_iso": "en", "required": true, "enrollment_pack_id": 1, "created_at": "2025-06-02T12:34:56Z", "updated_at": "2025-06-02T12:34:56Z", "company_logo": "https://example.com/logo.png", "attachments": [] }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Deletes an agreement

Request

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

Responses

successful

Bodyapplication/json
idinteger
Example: 101
metaobject
Response
application/json
{ "id": 101, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Lists agreements

Request

Query
pageinteger
per_pageinteger
language_isostring
sorted_bystring

Sort the records by one of the supported attributes:

  • title
  • active
  • required_on_checkout
  • created_at
  • updated_at The sort attribute should be followed by one of the order directives: '_asc', '_desc'
Example: sorted_by=title_asc
search_querystring

Filter agreements with their title

statusstring

Filter by status

Enum"active""inactive"
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/agreements?language_iso=string&page=0&per_page=0&search_query=string&sorted_by=string&status=active' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
agreementsArray of objects
metaobject or object
One of:
Response
application/json
{ "agreements": [ {} ], "meta": { "request_id": "string", "timestamp": "string", "pagination": {} } }

Creates an agreement

Request

Only allows creating agreements in english. Use update api to add contents in other languages

Query
language_isostring
Headers
Authorizationstringrequired
Bodyapplication/json
agreementobjectrequired
agreement.​titlestringrequired
Example: "New Agreement"
agreement.​descriptionstringrequired
Example: "This is a new agreement."
agreement.​enrollment_pack_idinteger

ID of the enrollment pack to associate with this agreement

Example: 1
agreement.​attachments_attributesArray of objects
curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/agreements?language_iso=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "agreement": {
      "title": "New Agreement",
      "description": "This is a new agreement.",
      "enrollment_pack_id": 1,
      "attachments_attributes": [
        {
          "url": "http://example.com/file.png",
          "filename": "file.png",
          "kind": "image",
          "content_type": "image/png",
          "content_size": 1024,
          "metadata": {}
        }
      ]
    }
  }'

Responses

creating agreements in a different language defaults to english automatically

Bodyapplication/json
agreementobject
metaobject
Response
application/json
{ "agreement": { "id": 101, "title": "Terms and conditions", "active": true, "required_on_checkout": false, "company_country_ids": [], "description": "This is the description/body of the agreement", "show_path": "/agreements/101", "language_iso": "en", "required": true, "enrollment_pack_id": 1, "created_at": "2025-06-02T12:34:56Z", "updated_at": "2025-06-02T12:34:56Z", "company_logo": "https://example.com/logo.png", "attachments": [] }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Clones an agreement

Request

Path
idintegerrequired
Headers
Authorizationstringrequired
curl -i -X POST \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/agreements/{id}/clone' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
agreementobject
metaobject
Response
application/json
{ "agreement": { "id": 101, "title": "Terms and conditions", "active": true, "required_on_checkout": false, "company_country_ids": [], "description": "This is the description/body of the agreement", "show_path": "/agreements/101", "language_iso": "en", "required": true, "enrollment_pack_id": 1, "created_at": "2025-06-02T12:34:56Z", "updated_at": "2025-06-02T12:34:56Z", "company_logo": "https://example.com/logo.png", "attachments": [] }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

Bulk deletes agreements

Request

Bodyapplication/jsonrequired
agreement_idsArray of integersrequired
Example: [1,2]
curl -i -X DELETE \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/agreements/bulk_delete \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "agreement_ids": [
      1,
      2
    ]
  }'

Responses

success

Bodyapplication/json
agreement_idsArray of integers
Example: [1,2]
metaobject
Response
application/json
{ "agreement_ids": [ 1, 2 ] }

Clones multiple agreement

Request

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
agreement_idsArray of integers
Example: [1,2]
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/agreements/bulk_clone \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "agreement_ids": [
      1,
      2
    ]
  }'

Responses

successful

Bodyapplication/json
agreementsArray of objects
metaobject
Response
application/json
{ "agreements": [ {} ], "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2024-12-10T08:04:10Z" } }

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