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

List posts

Request

List all posts for a company with pagination and filtering

Query
pageinteger

Page number for pagination

per_pageinteger

Number of items per page

activeboolean

Filter by active status

search_querystring

Search query for posts

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

Responses

successful

Bodyapplication/json
postsArray of objects
metaobject
Response
application/json
{ "posts": [ {} ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z", "total_count": 10, "total_pages": 2, "current_page": 1 } }

Create a post

Request

Create a new post post

Bodyapplication/json
postobjectrequired
post.​titlestringrequired

Title of the post

Example: "My New Post"
post.​descriptionstring

Content/description of the post

Example: "Post content here"
post.​image_urlstring

URL to post cover image

Example: "https://example.com/image.jpg"
post.​activeboolean

Whether the post is active

Example: true
post.​application_theme_template_idinteger

ID of the theme template to use

Example: 1
post.​country_idsArray of arrays

Array of country IDs

Example: [1,2]
post.​use_search_engineboolean

Whether to optimize for search engines

Example: true
post.​show_on_site_searchboolean

Whether to show in site search

Example: true
post.​post_datestring(date)

Date of the post

Example: "2021-01-01"
post.​post_authorstring

Author of the post

Example: "John Doe"
post.​summarystring

Summary of the post

Example: "This is a summary of the post"
post.​preview_urlstring

URL to preview the post

Example: "https://example.com/preview"
post.​search_engine_optimizer_attributesobject
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/posts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "post": {
      "title": "My New Post",
      "description": "Post content here",
      "image_url": "https://example.com/image.jpg",
      "active": true,
      "application_theme_template_id": 1,
      "country_ids": [
        1,
        2
      ],
      "use_search_engine": true,
      "show_on_site_search": true,
      "post_date": "2021-01-01",
      "post_author": "John Doe",
      "summary": "This is a summary of the post",
      "preview_url": "https://example.com/preview",
      "search_engine_optimizer_attributes": {
        "title": "string",
        "description": "string",
        "image_url": "string"
      }
    }
  }'

Responses

created

Bodyapplication/json
postobject
metaobject
Response
application/json
{ "post": { "id": 0, "title": "string", "description": "string", "slug": "string", "image_url": "string", "active": true, "application_theme_template_id": 0, "created_at": "string", "updated_at": "string", "countries": [], "custom_slug": true, "use_search_engine": true, "show_on_site_search": false, "post_date": "2021-01-01", "post_author": "John Doe", "summary": "This is a summary of the post", "preview_url": "https://example.com/preview", "search_engine_optimizer": {} }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Show a post

Request

Get details of a specific post

Path
idintegerrequired

Post ID

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

Responses

successful

Bodyapplication/json
postobject
metaobject
Response
application/json
{ "post": { "id": 0, "title": "string", "description": "string", "slug": "string", "image_url": "string", "active": true, "application_theme_template_id": 0, "created_at": "string", "updated_at": "string", "countries": [], "custom_slug": true, "use_search_engine": true, "show_on_site_search": false, "post_date": "2021-01-01", "post_author": "John Doe", "summary": "This is a summary of the post", "preview_url": "https://example.com/preview", "search_engine_optimizer": {} }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Update a post

Request

Update an existing post

Path
idintegerrequired

Post ID

Bodyapplication/json
postobjectrequired
post.​titlestring

Title of the post

Example: "Updated Post Title"
post.​descriptionstring

Content/description of the post

Example: "Updated content"
post.​image_urlstring

URL to post cover image

Example: "https://example.com/new-image.jpg"
post.​activeboolean

Whether the post is active

Example: false
post.​application_theme_template_idinteger

ID of the theme template to use

Example: 2
post.​post_datestring(date)
Example: "2021-01-01"
post.​post_authorstring
Example: "John Doe"
post.​summarystring
Example: "This is a summary of the post"
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/posts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "post": {
      "title": "Updated Post Title",
      "description": "Updated content",
      "image_url": "https://example.com/new-image.jpg",
      "active": false,
      "application_theme_template_id": 2,
      "post_date": "2021-01-01",
      "post_author": "John Doe",
      "summary": "This is a summary of the post"
    }
  }'

Responses

successful

Bodyapplication/json
postobject
metaobject
Response
application/json
{ "post": { "id": 0, "title": "string", "description": "string", "slug": "string", "image_url": "string", "active": true, "application_theme_template_id": 0, "created_at": "string", "updated_at": "string", "countries": [], "custom_slug": true, "use_search_engine": true, "show_on_site_search": false, "post_date": "2021-01-01", "post_author": "John Doe", "summary": "This is a summary of the post", "preview_url": "https://example.com/preview", "search_engine_optimizer": {} }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Update a post

Request

Update an existing post (PUT method)

Path
idintegerrequired

Post ID

Bodyapplication/json
postobjectrequired
post.​titlestring

Title of the post

Example: "Updated Post Title"
post.​descriptionstring

Content/description of the post

Example: "Updated content"
post.​image_urlstring

URL to post cover image

Example: "https://example.com/new-image.jpg"
post.​activeboolean

Whether the post is active

Example: false
post.​application_theme_template_idinteger

ID of the theme template to use

Example: 2
post.​post_datestring(date)
Example: "2021-01-01"
post.​post_authorstring
Example: "John Doe"
post.​summarystring
Example: "This is a summary of the post"
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/posts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "post": {
      "title": "Updated Post Title",
      "description": "Updated content",
      "image_url": "https://example.com/new-image.jpg",
      "active": false,
      "application_theme_template_id": 2,
      "post_date": "2021-01-01",
      "post_author": "John Doe",
      "summary": "This is a summary of the post"
    }
  }'

Responses

successful

Bodyapplication/json
postobject
metaobject
Response
application/json
{ "post": { "id": 0, "title": "string", "description": "string", "slug": "string", "image_url": "string", "active": true, "application_theme_template_id": 0, "created_at": "string", "updated_at": "string", "countries": [], "custom_slug": true, "use_search_engine": true, "show_on_site_search": false, "post_date": "2021-01-01", "post_author": "John Doe", "summary": "This is a summary of the post", "preview_url": "https://example.com/preview", "search_engine_optimizer": {} }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

Delete a post

Request

Delete a post (hard delete)

Path
idintegerrequired

Post ID

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

Responses

successful

Bodyapplication/json
postobject
metaobject
Response
application/json
{ "post": { "id": 0, "title": "string", "description": "string", "slug": "string", "image_url": "string", "active": true, "application_theme_template_id": 0, "created_at": "string", "updated_at": "string", "countries": [], "custom_slug": true, "use_search_engine": true, "show_on_site_search": false, "post_date": "2021-01-01", "post_author": "John Doe", "summary": "This is a summary of the post", "preview_url": "https://example.com/preview" }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }

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