Events
/
List Company Events

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
company.api.json
company.api.yaml
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

Create Company Event

Request

Add a new event for the company with details like title, dates, location, and optional media content.

Bodyapplication/jsonrequired
eventobject(Event3)required
Example: {"title":"Type Race","description":"Fluid Type Racing Game. Winner gets all expenses paid 1 month vacation trip to Bali.","start_date":"2024-03-28","end_date":"2024-04-01","start_time":"9:56:0","end_time":"19:56:0","time_zone":"Asia/Kathmandu","url":"https://google.com","active":true,"venue":"Pokhara","available_countries":["us","in","fin"],"images_attributes":[{"image_url":"https://images.furnituredealer.net/img/products/liberty_furniture/color/double%20bridge--816253672_152-cd-gts-b6.jpg","position":1},{"image_url":"https://images.furnituredealer.net/img/products/steve_silver/color/david-1172854226_di100c-b1.jpg"}]}
event.​titlestringrequired
Example: "Type Race"
event.​descriptionstringrequired
Example: "Fluid Type Racing Game. Winner gets all expenses paid 1 month vacation trip to Bali."
event.​start_datestringrequired
Example: "2024-03-28"
event.​end_datestringrequired
Example: "2024-04-01"
event.​start_timestringrequired
Example: "9:56:0"
event.​end_timestringrequired
Example: "19:56:0"
event.​time_zonestringrequired
Example: "Asia/Kathmandu"
event.​urlstringrequired
Example: "https://google.com"
event.​activebooleanrequired
Example: true
event.​venuestringrequired
Example: "Pokhara"
event.​available_countriesArray of stringsrequired
Example: ["us","in","fin"]
event.​images_attributesArray of objects(ImagesAttribute)required
Example: [{"image_url":"https://images.furnituredealer.net/img/products/liberty_furniture/color/double%20bridge--816253672_152-cd-gts-b6.jpg","position":1},{"image_url":"https://images.furnituredealer.net/img/products/steve_silver/color/david-1172854226_di100c-b1.jpg"}]
event.​images_attributes[].​image_urlstringrequired
Example: "https://images.furnituredealer.net/img/products/liberty_furniture/color/double%20bridge--816253672_152-cd-gts-b6.jpg"
event.​images_attributes[].​positioninteger(int32)
Example: 1
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/company/events \
  -H 'Content-Type: application/json' \
  -d '{
    "event": {
      "title": "Type Race",
      "description": "Fluid Type Racing Game. Winner gets all expenses paid 1 month vacation trip to Bali.",
      "start_date": "2024-03-28",
      "end_date": "2024-04-01",
      "start_time": "9:56:0",
      "end_time": "19:56:0",
      "time_zone": "Asia/Kathmandu",
      "url": "https://google.com",
      "active": true,
      "venue": "Pokhara",
      "available_countries": [
        "us",
        "in",
        "fin"
      ],
      "images_attributes": [
        {
          "image_url": "https://images.furnituredealer.net/img/products/liberty_furniture/color/double%20bridge--816253672_152-cd-gts-b6.jpg",
          "position": 1
        },
        {
          "image_url": "https://images.furnituredealer.net/img/products/steve_silver/color/david-1172854226_di100c-b1.jpg"
        }
      ]
    }
  }'

Responses

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"

List Company Events

Request

Retrieves a list of events associated with the company.

curl -i -X GET \
  https://docs.fluid.app/_mock/docs/apis/company.api/api/company/events

Responses

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"

Update Company Event

Request

Updates the details of a specific company event

Path
eventIdintegerrequired

The unique identifier of the event to update

Bodyapplication/jsonrequired
eventobject(Event4)required
Example: {"title":"Type Race","description":"Fluid Type Racing Game. Winner gets all expense paid 1 month vacation trip to Bali. The winner will also get the salary/wages for the vacation month.","available_countries":["npl","us"]}
event.​titlestringrequired
Example: "Type Race"
event.​descriptionstringrequired
Example: "Fluid Type Racing Game. Winner gets all expense paid 1 month vacation trip to Bali. The winner will also get the salary/wages for the vacation month."
event.​available_countriesArray of stringsrequired
Example: ["npl","us"]
curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/events/{eventId}' \
  -H 'Content-Type: application/json' \
  -d '{
    "event": {
      "title": "Type Race",
      "description": "Fluid Type Racing Game. Winner gets all expense paid 1 month vacation trip to Bali. The winner will also get the salary/wages for the vacation month.",
      "available_countries": [
        "npl",
        "us"
      ]
    }
  }'

Responses

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"

Get Company Event Details

Request

Retrieves the details of a specific event for a company.

Path
eventIdintegerrequired

The unique identifier of the company event

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/events/{eventId}'

Responses

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"

Delete Company Event

Request

Deletes a specific event associated with the company.

Path
eventIdintegerrequired

The unique identifier of the event to delete

curl -i -X DELETE \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/events/{eventId}'

Responses

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"

Send Event Notifications

Request

Sends notifications about an event to concerned parties based on specified countries.

Path
eventIdintegerrequired

The unique identifier of the event to send notifications for

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/events/{eventId}/send_notifications'

Responses

Headers
Content-Typestring

The content type of the response

Example: "application/json"
Content-Lengthstring

The length of the response content in bytes

Example: "981"
X-Request-Idstring

A unique identifier for the request

Example: "b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa"

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

Menus

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

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

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