Contacts
/
Get contacts with optional filters

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://docs.fluid.app/_mock/docs/apis/swagger/
Production server with company subdomain
https://{company}.fluid.app/
Local development server
http://fluid.lvh.me:{port}/

Agreements

Operations

ApplePay

Operations

Application Themes

Operations

ApplicationThemeTemplates

Operations

Authentication

Operations

Callback Definitions

Operations

Callback Registrations

Operations

Carts

Operations

Company Custom Catch Ups

Operations

Company Discounts

Operations

Company Droplets

Operations

Company 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

Contacts

Operations

Get contacts with optional filters

Request

Query
search_querystring

Filter contacts with search query that matches with their first name, last name, email, or phone

sorted_bystring

Sort the records by one of the supported attributes:

  • created_at
  • first_name
  • user_name
  • activities

The sort attribute should be followed by one of the order directives: '_asc', '_desc'

Example: sorted_by=id_asc
pageinteger

Page number for pagination

Default 1
per_pageinteger

Number of records per page

Default 10
by_metadatastring(json)

Search JSON meta data

Default "{}"
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/contacts?by_metadata={}&page=1&per_page=10&search_query=string&sorted_by=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Bodyapplication/json
contactsArray of objects
metaobject
Response
application/json
{
  "contacts": [
    { … }
  ],
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z",
    "total_count": 42,
    "total_pages": 3,
    "current_page": 1
  }
}

Create a contact

Request

Bodyapplication/json
contactobjectrequired
contact.​first_namestringnon-emptyrequired
contact.​last_namestringnon-emptyrequired
contact.​language_codestringnon-empty
contact.​country_codestringnon-empty
contact.​statusstringnon-empty
contact.​emailstringnon-empty
contact.​phonenull or string
contact.​addressstringnon-empty
contact.​citystringnon-empty
contact.​statestringnon-empty
contact.​postal_codestringnon-empty
contact.​affiliateobject
contact.​metadataobject
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/company/contacts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contact": {
      "first_name": "string",
      "last_name": "string",
      "language_code": "string",
      "country_code": "string",
      "status": "string",
      "email": "string",
      "phone": null,
      "address": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "affiliate": {},
      "metadata": {}
    }
  }'

Responses

created

Retrieves a Contact

Request

Path
idobjectrequired
id.​idintegerrequired
Bodyapplication/json
idintegerrequired
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/contacts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0
  }'

Responses

successful

Updates a contact

Request

Path
idobjectrequired
id.​idintegerrequired
id.​contactobjectrequired
id.​contact.​first_namestringnon-empty
id.​contact.​last_namestringnon-empty
id.​contact.​language_codestringnon-empty
id.​contact.​country_codestringnon-empty
id.​contact.​statusstringnon-empty
id.​contact.​emailstringnon-empty
id.​contact.​phonenull or string
id.​contact.​addressstringnon-empty
id.​contact.​citystringnon-empty
id.​contact.​statestringnon-empty
id.​contact.​postal_codestringnon-empty
id.​contact.​affiliateobject
id.​contact.​metadataobject
Bodyapplication/json
idintegerrequired
contactobjectrequired
contact.​first_namestringnon-empty
contact.​last_namestringnon-empty
contact.​language_codestringnon-empty
contact.​country_codestringnon-empty
contact.​statusstringnon-empty
contact.​emailstringnon-empty
contact.​phonenull or string
contact.​addressstringnon-empty
contact.​citystringnon-empty
contact.​statestringnon-empty
contact.​postal_codestringnon-empty
contact.​affiliateobject
contact.​metadataobject
curl -i -X PUT \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/contacts/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "contact": {
      "first_name": "string",
      "last_name": "string",
      "language_code": "string",
      "country_code": "string",
      "status": "string",
      "email": "string",
      "phone": null,
      "address": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "affiliate": {},
      "metadata": {}
    }
  }'

Responses

successful

Deletes a contact

Request

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

Responses

successful

Get Company User Details by email

Request

Query
emailstring(email)required
curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/contacts/find_by_email?email=user%40example.com' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

successful

Append metadata field

Request

Path
idintegerrequired

Contact's Id

Bodyapplication/json
metadataobjectrequired

A JSON object that can store any custom data structure. When provided, merges with existing metadata data.

curl -i -X PATCH \
  'https://docs.fluid.app/_mock/docs/apis/swagger/api/company/contacts/{id}/append_metadata' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "metadata": {}
  }'

Responses

success

Bodyapplication/json
contactobject
metaobject
Response
application/json
{
  "contact": {
    "id": "13423",
    "token": "aF1VXFfkjMi9bhCXaE8u5a3B",
    "first_name": "John",
    "last_name": "Nash",
    "full_name": "",
    "avatar_url": "https://example.com/images/product.png",
    "status": "new",
    "email": "email@example.com",
    "email2": "email@example.com",
    "phone": "+1-1234567890",
    "phone2": "+1-1234567890",
    "phone_id": "",
    "address": "123 Main St",
    "address2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001",
    "language_id": 234,
    "country_id": 96,
    "lead_type": "Web Chat",
    "ip": "1.1.1.1",
    "requested_at": "2025-01-16T04:22:43.809Z",
    "best_time": "Afternoon",
    "time_zone": "America/New_York",
    "reason": "I enjoy working from home",
    "income": "$2500-5000 per Month",
    "hours": "11-15 hours per week",
    "invest": "$750 - $1000",
    "interest": "Ready to get started!",
    "discarded_at": "2025-01-16T04:22:43.809Z",
    "metadata": {}
  },
  "meta": {
    "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b",
    "timestamp": "2024-12-10T08:04:10Z"
  }
}

Currencies

Operations

Customer Orders

Operations

CustomerNotes

Operations

Customers

Operations

Domains

Operations

Drop Zones

Operations

Droplets

Operations

Enrollment Packs

Operations

Enrollments

Operations

Fantasy Points

Operations

Fluid Pay

Operations

GlobalEmbeds

Operations

Inventory Levels

Operations

Multi-Factor Authentications

Operations

Notifications

Operations

Order Fulfillments

Operations

Orders

Operations

Pages

Operations

Payment

Operations

Payment Accounts

Operations

Payments

Operations

Paypal

Operations

Products

Operations

Public Companies

Operations

Redirects

Operations

Refunds

Operations

Roles

Operations

Shares

Operations

Subscription Orders

Operations

Subscription Plans

Operations

Subscriptions

Operations

Tracking Informations

Operations

Tree Nodes

Operations

Trees

Operations

Users

Operations

Variant Countries

Operations

Webhooks

Operations

returns a list of all droplet categories

Request

curl -i -X GET \
  https://docs.fluid.app/_mock/docs/apis/swagger/api/droplet_categories \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

returns a list of droplet categories

Bodyapplication/json
droplet_categoriesArray of objects(DropletCategory)
metaobject
Response
application/json
{
  "droplet_categories": [
    { … }
  ],
  "meta": {
    "request_id": "123e4567-e89b-12d3-a456-426614174000",
    "timestamp": "2021-01-01T00:00:00Z"
  }
}