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.
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/api/users/create_and_invite \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "user": { "email": "string", "first_name": null, "last_name": null, "company_id": 0, "roles": null, "admin_roles": [ 0 ], "phone": null, "external_id": null, "share_guid": null, "username": null } }'
{ "user": { "id": 123, "email": "existing@example.com", "first_name": "Existing", "last_name": "User" }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/users \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "country_code": "string", "language_code": "string", "user": { "email": "string", "first_name": "string", "last_name": "string", "password": "string", "avatar": "string", "phone": "string", "google_id": "string", "bio": "string", "facebook": "string", "instagram": "string", "twitter": "string", "linkedin": "string", "whatsapp": "string", "wechat": "string", "youtube": "string", "zip_code": "string", "dob": "2019-08-24", "gender": "string", "time_zone": "string", "push_notifications": true, "email_notifications": true, "sms_notifications": true, "external_id": "string", "username": "string", "active": true, "role": "admin", "admin_roles": [ 0 ], "affiliate": { "id": "string", "external_id": "string", "username": "string", "email": "string" } } }'
user created with admin role and admin_roles
External identifier for the user
User's unique username within the company
Whether the user is active in the company
URL to the user's personal site
External ID of Rank the User is linked to
Unique identifier for sharing content
User's metadata JSON object containing optional metadata about the user, such as tracking data, or third-party identifiers.
Date and time the user was created
Roles of the user
User's affiliate information
User's avatar URL
User's Bio
User's Facebook profile URL
User's LinkedIn profile URL
User's YouTube channel URL
User's Do Not Disturb preference
Use this address by default when there are multiple addresses
{ "user_company": { "id": 0, "first_name": "John", "last_name": "Doe", "image_url": "https://example.com/image.jpg", "company_id": 42, "external_id": "EXT123456", "username": "johny_jobs", "active": true, "mysite_url": "https://mycompany.com/johny_jobs", "rank": "234234", "share_guid": "a6848f0b", "legacy_number": "+18001234567", "metadata": { … }, "created_at": "2021-01-01T00:00:00Z", "roles": [ … ], "email": "string", "full_name": "John Doe", "affiliate": "{id: 1, external_id: 3, username: \"johny_jobs\", email: \"johny.jobs@example.com\", credit: \"a6848f0b\"}", "rank_id": 234234, "user": { … } }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/users?by_metadata={}&page=1&per_page=50&role=string&search_query=string&sorted_by=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "user_companies": [ { … } ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z", "pagination": { … } } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/users/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
user found via auth token
External identifier for the user
User's unique username within the company
Whether the user is active in the company
URL to the user's personal site
External ID of Rank the User is linked to
Unique identifier for sharing content
User's metadata JSON object containing optional metadata about the user, such as tracking data, or third-party identifiers.
Date and time the user was created
Roles of the user
User's affiliate information
User's avatar URL
User's Bio
User's Facebook profile URL
User's LinkedIn profile URL
User's YouTube channel URL
User's Do Not Disturb preference
Use this address by default when there are multiple addresses
{ "user_company": { "id": 0, "first_name": "John", "last_name": "Doe", "image_url": "https://example.com/image.jpg", "company_id": 42, "external_id": "EXT123456", "username": "johny_jobs", "active": true, "mysite_url": "https://mycompany.com/johny_jobs", "rank": "234234", "share_guid": "a6848f0b", "legacy_number": "+18001234567", "metadata": { … }, "created_at": "2021-01-01T00:00:00Z", "roles": [ … ], "email": "string", "full_name": "John Doe", "affiliate": "{id: 1, external_id: 3, username: \"johny_jobs\", email: \"johny.jobs@example.com\", credit: \"a6848f0b\"}", "rank_id": 234234, "user": { … } }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X PATCH \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/users/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "user": { "email": "string", "first_name": "string", "last_name": "string", "password": "string", "avatar": "string", "phone": "string", "google_id": "string", "bio": "string", "facebook": "string", "instagram": "string", "twitter": "string", "linkedin": "string", "whatsapp": "string", "wechat": "string", "youtube": "string", "zip_code": "string", "dob": "2019-08-24", "gender": "string", "time_zone": "string", "push_notifications": true, "email_notifications": true, "sms_notifications": true, "external_id": "string", "username": "string", "active": true, "role": "admin", "admin_roles": [ 0 ], "affiliate": { "id": "string", "external_id": "string", "username": "string", "email": "string" } } }'
user role updated to admin with admin_roles
External identifier for the user
User's unique username within the company
Whether the user is active in the company
URL to the user's personal site
External ID of Rank the User is linked to
Unique identifier for sharing content
User's metadata JSON object containing optional metadata about the user, such as tracking data, or third-party identifiers.
Date and time the user was created
Roles of the user
User's affiliate information
User's avatar URL
User's Bio
User's Facebook profile URL
User's LinkedIn profile URL
User's YouTube channel URL
User's Do Not Disturb preference
Use this address by default when there are multiple addresses
{ "user_company": { "id": 0, "first_name": "John", "last_name": "Doe", "image_url": "https://example.com/image.jpg", "company_id": 42, "external_id": "EXT123456", "username": "johny_jobs", "active": true, "mysite_url": "https://mycompany.com/johny_jobs", "rank": "234234", "share_guid": "a6848f0b", "legacy_number": "+18001234567", "metadata": { … }, "created_at": "2021-01-01T00:00:00Z", "roles": [ … ], "email": "string", "full_name": "John Doe", "affiliate": "{id: 1, external_id: 3, username: \"johny_jobs\", email: \"johny.jobs@example.com\", credit: \"a6848f0b\"}", "rank_id": 234234, "user": { … } }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X DELETE \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/users/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "id": 1, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X PATCH \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/users/{id}/append_metadata' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "metadata": { "profile_complete": true, "preferences": { "theme": "dark", "newsletter": true } } }'
{ "user_company": { "id": 0, "first_name": "John", "last_name": "Doe", "image_url": "https://example.com/image.jpg", "company_id": 42, "external_id": "EXT123456", "username": "johny_jobs", "active": true, "mysite_url": "https://mycompany.com/johny_jobs", "rank": "234234", "share_guid": "a6848f0b", "legacy_number": "+18001234567", "metadata": { … }, "created_at": "2021-01-01T00:00:00Z", "roles": [ … ], "email": "string", "full_name": "John Doe", "affiliate": "{id: 1, external_id: 3, username: \"johny_jobs\", email: \"johny.jobs@example.com\", credit: \"a6848f0b\"}", "rank_id": 234234, "user": { … } }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/users/find?email=string&external_id=string&share_guid=string&token=string&username=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "id": 1, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/users?page=0'
OK
[ { "id": 3470, "external_id": null, "username": null, "active": true, "affiliate": {}, "user": { … } } ]
Password for the user. This will be assigned if the User does not exist yet or if they do not have a password set.
curl -i -X POST \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/users?active=true&email=string&external_id=string&username=string' \ -H 'Content-Type: application/json' \ -d '{ "affiliate": { "id": null, "external_id": null, "username": "sammysample12", "email": null }, "username": "", "active": true, "email": "juliete1411232@google.com", "first_name": "fussname", "last_name": "lassname", "password": "", "avatar": "", "phone": "", "google_id": "", "bio": "", "facebook": "", "instagram": "", "twitter": "", "linkedin": "", "whatsapp": "", "wechat": "", "youtube": "", "zip_code": "", "dob": "", "gender": "", "time_zone": "", "push_notifications": "", "email_notifications": "", "sms_notifications": "", "language_code": "en", "country_code": "US" }'
Created
{ "id": 3477, "external_id": "", "username": "", "active": true, "affiliate": {}, "user": { "email": "juliete1411232@google.com", "first_name": "fussname", "last_name": "lassname", "avatar": "", "phone": "", "google_id": "", "bio": "", "facebook": "", "instagram": "", "twitter": "", "linkedin": "", "whatsapp": "", "wechat": "", "youtube": "", "zip_code": "", "dob": null, "gender": "", "time_zone": "", "language": { … }, "country": { … } } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/users/{id}'
OK
{ "id": 3470, "external_id": null, "username": null, "active": true, "affiliate": {}, "user": { "email": "pralishkayastha@gmail.com", "first_name": "Yucatán", "last_name": "résumé", "avatar": null, "phone": null, "google_id": null, "bio": null, "facebook": null, "instagram": null, "twitter": null, "linkedin": null, "whatsapp": null, "wechat": null, "youtube": null, "zip_code": null, "dob": null, "gender": null, "time_zone": null, "language": { … }, "country": { … } } }
curl -i -X PUT \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/users/{id}' \ -H 'Content-Type: application/json' \ -d '{ "affiliate": { "id": 3355, "external_id": null, "username": null, "email": null }, "first_name": "testfirst", "last_name": "testlast", "avatar": "", "phone": "+14844145967", "google_id": "julies.home", "bio": "hi im jules", "facebook": "jle", "instagram": "jules", "twitter": "jj", "linkedin": "ju", "whatsapp": "ul", "wechat": "9865326598", "youtube": "juleshome", "zip_code": "97655", "dob": "1997-08-08", "gender": "female", "time_zone": "CST", "push_notifications": "", "email_notifications": "", "sms_notifications": "" }'
OK
{ "id": 3484, "external_id": null, "username": "", "active": true, "affiliate": { "id": 3355, "email": "nitesh@tester.com" }, "user": { "email": "juliete1411232111@google.com", "first_name": "testfirst", "last_name": "testlast", "avatar": "", "phone": "+14844145967", "google_id": "julies.home", "bio": "hi im jules", "facebook": "jle", "instagram": "jules", "twitter": "jj", "linkedin": "ju", "whatsapp": "ul", "wechat": "9865326598", "youtube": "juleshome", "zip_code": "97655", "dob": "1997-08-08", "gender": "female", "time_zone": "CST", "language": { … }, "country": { … } } }
curl -i -X DELETE \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/users/{id}'
"User deleted successfully."
Social Media