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.
Filter reps with search query that matches with their email, first name, last name, share guid or external id
Sort the records by one of the supported attributes:
The sort attribute should be followed by one of the order directives: '_asc', '_desc'
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/reps?active=true&page=0&per_page=100&search_query=string&sorted_by=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "reps": [ { … } ], "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z", "pagination": { … } } }
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/api/v2/reps \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "rep": { "first_name": null, "last_name": null, "email": null, "phone": null, "active": null, "external_id": null, "username": null, "share_guid": null, "language_code": null, "country_code": null } }'
{ "rep": { "id": 0, "active": true, "external_id": "string", "username": "string", "first_name": "string", "last_name": "string", "created_at": "2019-08-24T14:15:22Z", "image_url": "string", "roles": "user", "share_guid": "string", "country_code": "string", "language_code": "string", "computed_full_name": "string", "computed_email": "string", "phone": "string" }, "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/v2/reps/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "rep": { "id": 0, "active": true, "external_id": "string", "username": "string", "first_name": "string", "last_name": "string", "created_at": "2019-08-24T14:15:22Z", "image_url": "string", "roles": "user", "share_guid": "string", "country_code": "string", "language_code": "string", "computed_full_name": "string", "computed_email": "string", "phone": "string", "rank": "string", "joined_date": "string", "customer_id": 0, "enroller": {} }, "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/v2/reps/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "id": 0, "rep": { "first_name": null, "last_name": null, "email": null, "phone": null, "active": null, "external_id": null, "username": null, "share_guid": null, "language_code": null, "country_code": null } }'
{ "rep": { "id": 0, "active": true, "external_id": "string", "username": "string", "first_name": "string", "last_name": "string", "created_at": "2019-08-24T14:15:22Z", "image_url": "string", "roles": "user", "share_guid": "string", "country_code": "string", "language_code": "string", "computed_full_name": "string", "computed_email": "string", "phone": "string", "rank": "string", "joined_date": "string", "customer_id": 0, "enroller": {} }, "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/v2/reps/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "id": 0, "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/v2/reps/{id}/update_enroller' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "id": 0, "enroller_id": 0, "transfer_points": null }'
{ "enroller_update": { "rep_id": 0, "enroller_id": 0, "transfer_points": true, "message": "string" }, "meta": { "request_id": "123e4567-e89b-12d3-a456-426614174000", "timestamp": "2021-01-01T00:00:00Z" } }
Social Media