Roles
/
Lists roles for a company

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

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

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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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://fluid-commerce.redocly.app/_mock/docs/apis/swagger/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"
  }
}

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