The Fluid Rep APIs provide endpoints for authenticated Reps (Users) to access their own data and perform actions on their behalf.
E-mail support@fluid.app
License MIT
The Fluid Rep APIs provide endpoints for authenticated Reps (Users) to access their own data and perform actions on their behalf.
These APIs use User tokens for authentication. User tokens are obtained through:
/api/user_companies/jwt_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.
curl -i -X POST \ 'https://docs.fluid.app/_mock/docs/apis/rep/api/authentication/send_mfa?email=string&fluid_shop=string'
{ "multi_factor_authentication": { "uuid": "string", "authenticated": true, "verification_channel": "string", "verification_code_expires_at": "string" }, "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/rep/api/authentication/confirm_mfa \ -H 'Content-Type: application/json' \ -d '{ "uuid": "drp_p4r9jsl305iduqrsl0ujdth35jhuy2al", "multi_factor_authentication": { "verification_code": "543432" } }'
{ "authenticated": true, "auth_type": "rep", "companies": [ { … } ], "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2025-02-03T08:04:10Z" } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/rep/api/authentication/me?jwt=string'
{ "user": { "id": 1, "first_name": "Mike", "last_name": "Tingey", "email": "mike@example.com", "avatar_url": "https://d1r16g5m5p3ba7.cloudfront.net/uploads/user/avatar/980190962/avatar.png", "root_admin": true }, "user_company": { "id": 1, "company_id": 226157151, "company_name": "Fluid", "roles": "[\"admin\", \"developer\"]", "user_type": "admin", "logo_url": "https://cdn.filestackcontent.com/1Rnqia44T2mLcXuFZCTV", "icon_url": "https://cdn.filestackcontent.com/1Rnqia44T2mLcXuFZCTV", "fluid_shop": "myco.fluid.app", "company_colors": { … } }, "meta": { "request_id": "72591788-c981-47d1-8dd5-1cc0e1612815", "timestamp": "2025-05-08T06:18:09Z" } }
curl -i -X POST \ 'https://docs.fluid.app/_mock/docs/apis/rep/api/authentication/resend_mfa?uuid=string'
{ "multi_factor_authentication": { "uuid": "string", "verification_channel": "test@example.com", "verification_code_expires_at": "2025-02-17T08:00:01Z", "authenticated": "false" }, "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/rep/api/authentication/company/{fluid_shop}'
{ "company": { "name": "string", "logo_url": "https://example.com/logo.png", "color": "#000000", "fluid_shop": "myco.fluid.app", "primary_domain_hostname": "myco.com" }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2025-02-03T08:04:10Z" } }
curl -i -X PUT \ 'https://docs.fluid.app/_mock/docs/apis/rep/api/authentication/company/{company_id}/switch' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "company": { "id": 1, "name": "fluid", "fluid_shop": "myco.fluid.app", "logo_url": "https://example.com/logo.png", "jwt": "eyJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJjdX...", "redirect_path": "/admin/dashboard" }, "meta": { "request_id": "f5473a8c-8a86-4e0e-b3e8-95392003921b", "timestamp": "2025-02-03T08:04:10Z" } }