Company Mobile Widgets
/
Retrieve a paginated list of mobile widgets

Fluid Commerce APIs (1.0)

The Fluid Commerce APIs provides a comprehensive set of APIs designed to integrate Fluid's powerful services into your applications seamlessly. This bundle offers robust functionality for enhancing messaging solutions, streamlining data management, and improving customer interactions. With detailed documentation, secure authentication, and flexible integration options, the Fluid Public API Bundle is engineered to help you leverage our services efficiently and effectively, unlocking new potentials and achieving greater connectivity within your systems.

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

Admins

Operations

Agreements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Commerce Orders

Operations

Companies

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Mobile Widgets

Operations

Retrieve a paginated list of mobile widgets

Request

Retrieves a paginated list of mobile widgets.

Query
pageinteger

Page number

Default 1
per_pageinteger

Number of items per page

Default 20
curl -i -X GET \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/mobile_widgets?page=1&per_page=20' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

mobile widgets retrieved

Bodyapplication/json
mobile_widgetsArray of objects
metaobject
Response
application/json
{
  "mobile_widgets": [
    { … }
  ],
  "meta": {
    "request_id": "fcca8c13-a8de-4632-a3ef-4374f0dee632",
    "timestamp": "2025-05-19T20:01:35Z",
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

Create a new mobile widget

Request

Creates a new mobile widget for the company.

Bodyapplication/json
namestringrequired
Example: "MWidget"
embed_urlstringrequired
Example: "https://unseenktm.com"
heightintegerrequired
Example: 190
cover_image_urlstringrequired
Example: "https://www.example.com/test.jpg"
page_scopeobject
curl -i -X POST \
  https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/mobile_widgets \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "MWidget",
    "embed_url": "https://unseenktm.com",
    "height": 190,
    "cover_image_url": "https://www.example.com/test.jpg",
    "page_scope": {
      "home": true,
      "explore": false
    }
  }'

Responses

mobile widget created

Bodyapplication/json
mobile_widgetobject
metaobject
Response
application/json
{
  "mobile_widget": {
    "id": 48,
    "company_id": 298486374,
    "name": "MWidget",
    "embed_url": "https://unseenktm.com",
    "height": 90,
    "cover_image_url": "https://www.example.com/test.jpg",
    "page_scope": { … },
    "droplet_installation_id": 825425119
  },
  "meta": {
    "request_id": "78559f54-b876-4a62-b69f-ed95355fe1d7",
    "timestamp": "2025-05-19T20:02:43Z"
  }
}

Retrieve a specific mobile widget

Request

Retrieves a specific mobile widget by ID.

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

Responses

mobile widget found

Update a mobile widget

Request

Updates an existing mobile widget.

Path
idintegerrequired
Bodyapplication/json
namestring
Example: "Updated Widget"
embed_urlstring
Example: "updated.com"
heightinteger
Example: 200
cover_image_urlstring
Example: "https://www.example.com/test.jpg"
page_scopeobject
droplet_installation_idinteger or null
Example: 825425119
curl -i -X PUT \
  'https://fluid-commerce.redocly.app/_mock/docs/apis/swagger/api/company/mobile_widgets/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated Widget",
    "embed_url": "updated.com",
    "height": 200,
    "cover_image_url": "https://www.example.com/test.jpg",
    "page_scope": {
      "home": true,
      "explore": false
    },
    "droplet_installation_id": 825425119
  }'

Responses

mobile widget updated

Delete a mobile widget

Request

Deletes a mobile widget.

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

Responses

mobile widget deleted

Company Pages

Operations

Pages

Operations

Company Popups

Operations

Company Settings - Checkout

Operations

Company Settings - Countries

Operations

Company Settings - Languages

Operations

Company Settings - Social Media

Operations

Company Settings - Warehouses

Operations

Company Webhook Events

Operations

Contacts

Operations

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplet Categories

Operations

Droplet Installations

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

File Resources

Operations

Fluid Pay

Operations

Form Elements

Operations

Forms

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Labels

Operations

Multi Factor Authentications

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Onboarding

Operations

Order Fulfillments

Operations

Orders

Operations

Payment

Operations

Payment Accounts

Operations

Payment Integrations

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Prompts

Operations

Public Companies

Operations

Public Drop Zones

Operations

Ranks

Operations

Redirects

Operations

Refunds

Operations

Reps

Operations

Roles

Operations

Settings

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tags

Operations

Tax Categories

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Variants

Operations

Webhooks

Operations