Contacts

Fluid Rep APIs (1.0)

The Fluid Rep APIs provide endpoints for authenticated Reps (Users) to access their own data and perform actions on their behalf.

Authentication

These APIs use User tokens for authentication. User tokens are obtained through:

  • Magic link authentication
  • JWT exchange (/api/user_companies/jwt_exchange)
  • Token exchange (/api/user_companies/token_exchange)

Unlike Company APIs which use Company API tokens for administrative access, Rep APIs authenticate the individual user and provide access to their personal data, orders, team, and settings.

For Company-level management APIs, see the Company APIs documentation.

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

Authentication

Operations

User Profile

Operations

Contacts

Operations

List contacts

Request

Returns all contacts for the current user.

Contacts include leads, customers, and prospects captured through various channels including MySite forms, shared media, and manual entry.

Query
filterstring

Filter by status: all, leads, customers, prospects, archived

searchstring

Search by name, email, or phone

pageinteger

Page number for pagination

per_pageinteger

Number of results per page (max 100)

curl -i -X GET \
  'https://docs.fluid.app/_mock/docs/apis/rep/api/contacts?filter=string&page=0&per_page=0&search=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

contacts retrieved

Bodyapplication/jsonArray [
object
]
Response
application/json
[
  {
    "id": 4829,
    "token": "ct_8f3a2b1c9d7e",
    "first_name": "Michael",
    "last_name": "Scott",
    "full_name": "Michael Scott",
    "email": "m.scott@dundermifflin.com",
    "phone": "+1-570-555-0100",
    "avatar_url": "https://cdn.dundermifflin.com/contacts/michael-scott.jpg",
    "status": "lead",
    "lead_type": "organic",
    "city": "Scranton",
    "state": "PA"
  },
  {
    "id": 4830,
    "token": "ct_2c4d6e8f0a1b",
    "first_name": "Jim",
    "last_name": "Halpert",
    "full_name": "Jim Halpert",
    "email": "j.halpert@dundermifflin.com",
    "phone": "+1-570-555-0101",
    "status": "customer",
    "city": "Scranton",
    "state": "PA"
  },
  {
    "id": 4831,
    "token": "ct_3d5e7f9a1b2c",
    "first_name": "Pam",
    "last_name": "Beesly",
    "full_name": "Pam Beesly",
    "email": "p.beesly@dundermifflin.com",
    "phone": "+1-570-555-0102",
    "status": "customer",
    "city": "Scranton",
    "state": "PA"
  }
]

Create a contact

Request

Creates a new contact for the current user.

This can be used to manually add leads, customers, or prospects. The contact will be associated with the authenticated user's account.

Bodyapplication/json
first_namestringrequired
Example: "Stanley"
last_namestringrequired
Example: "Hudson"
emailstring
Example: "s.hudson@dundermifflin.com"
phonestring
Example: "+1-570-555-0103"
statusstring
Enum"lead""customer""prospect"
Example: "prospect"
addressstring
Example: "1725 Slough Avenue"
citystring
Example: "Scranton"
statestring
Example: "PA"
postal_codestring
Example: "18505"
reasonstring
Example: "Interested in crossword puzzle paper"
curl -i -X POST \
  https://docs.fluid.app/_mock/docs/apis/rep/api/contacts \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "first_name": "Stanley",
    "last_name": "Hudson",
    "email": "s.hudson@dundermifflin.com",
    "phone": "+1-570-555-0103",
    "status": "prospect",
    "address": "1725 Slough Avenue",
    "city": "Scranton",
    "state": "PA",
    "postal_code": "18505",
    "reason": "Interested in crossword puzzle paper"
  }'

Responses

contact created

Bodyapplication/json
object
Response
application/json
{
  "id": 4832,
  "token": "ct_4e6f8a0b2c3d",
  "first_name": "Stanley",
  "last_name": "Hudson",
  "full_name": "Stanley Hudson",
  "email": "s.hudson@dundermifflin.com",
  "status": "prospect"
}

Tasks

Operations

Media

Operations

Libraries

Operations

Orders

Operations

MySite

Operations

Analytics

Operations

Events

Operations

Training

Operations