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 GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/pages?by_metadata={}&page_number=1&per_page=10' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
[ { "pagination": { … } } ]
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/api/company/pages \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "page": { "title": "Page Title", "html_code": "<p>Page content</p>", "publish": true, "image_url": "https://example.com/image.jpg", "available_countries": [ "US" ], "metadata": {} } }'
{ "id": 1, "title": "Page Title", "slug": "page-title", "label": "Trending", "display_tag": "Display tag", "share_link": "https://example.com/page-title", "active": true, "metadata": {}, "preview_url": "https://example.com/page-title?preview=true", "countries": [ { … } ], "stripped_description": "Page description", "views": 100, "leads": 10, "image_url": "https://example.com/image.jpg", "source": "builder", "publish": true, "prompts": [ { … } ], "html_code": "string", "prompts_enabled": true, "json": "string", "application_theme_template": { "id": 0, "name": "string", "themeable_type": "string", "content": "string", "stylesheet": "string", "status": "string", "created_at": "string", "updated_at": "string", "script": {}, "schema": {}, "content_without_schema": "string", "images": [], "metadata": {}, "category": "string" }, "search_engine_optimizer": { "id": 0, "title": "string", "description": "string", "image_url": "string" }, "use_search_engine": true, "show_on_site_search": true, "email": "string", "open_graph": { "id": 0, "title": "string", "description": "string", "image_url": "string" } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/pages/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "id": 1, "title": "Page Title", "slug": "page-title", "label": "Trending", "display_tag": "Display tag", "share_link": "https://example.com/page-title", "active": true, "metadata": {}, "preview_url": "https://example.com/page-title?preview=true", "countries": [ { … } ], "stripped_description": "Page description", "views": 100, "leads": 10, "image_url": "https://example.com/image.jpg", "source": "builder", "publish": true, "prompts": [ { … } ], "html_code": "string", "prompts_enabled": true, "json": "string", "application_theme_template": { "id": 0, "name": "string", "themeable_type": "string", "content": "string", "stylesheet": "string", "status": "string", "created_at": "string", "updated_at": "string", "script": {}, "schema": {}, "content_without_schema": "string", "images": [], "metadata": {}, "category": "string" }, "search_engine_optimizer": { "id": 0, "title": "string", "description": "string", "image_url": "string" }, "use_search_engine": true, "show_on_site_search": true, "email": "string", "open_graph": { "id": 0, "title": "string", "description": "string", "image_url": "string" } }
curl -i -X PUT \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/pages/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "page": { "title": "Updated Title", "html_code": "<p>Updated content</p>", "publish": true, "metadata": {} } }'
{ "id": 1, "title": "Page Title", "slug": "page-title", "label": "Trending", "display_tag": "Display tag", "share_link": "https://example.com/page-title", "active": true, "metadata": {}, "preview_url": "https://example.com/page-title?preview=true", "countries": [ { … } ], "stripped_description": "Page description", "views": 100, "leads": 10, "image_url": "https://example.com/image.jpg", "source": "builder", "publish": true, "prompts": [ { … } ], "html_code": "string", "prompts_enabled": true, "json": "string", "application_theme_template": { "id": 0, "name": "string", "themeable_type": "string", "content": "string", "stylesheet": "string", "status": "string", "created_at": "string", "updated_at": "string", "script": {}, "schema": {}, "content_without_schema": "string", "images": [], "metadata": {}, "category": "string" }, "search_engine_optimizer": { "id": 0, "title": "string", "description": "string", "image_url": "string" }, "use_search_engine": true, "show_on_site_search": true, "email": "string", "open_graph": { "id": 0, "title": "string", "description": "string", "image_url": "string" } }
curl -i -X DELETE \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/pages/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/pages/{id}/send_to_top' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/pages/{id}/duplicate?lang=string' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
curl -i -X PATCH \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/company/pages/{id}/append_metadata' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "metadata": {} }'
{ "status": "string", "data": { "page": { … } } }
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/pages?by_language=string&country_id=0&page=1&per_page=20&search_query=string&sorted_by=priority_asc&status=active&with_category_id=0&with_tag_id=0' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "items": [ { … } ], "meta": { "request_id": "string", "timestamp": "string", "pagination": { … } } }
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/pages \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "page": { "title": "New Page", "label": "Featured", "display_tag": "Tag", "stripped_description": "Page description", "image_url": "https://example.com/image.jpg", "source": "builder", "publish": true, "prompts_enabled": true, "json": "{}", "use_search_engine": true, "show_on_site_search": true, "email": "page@example.com", "page_content": "<h1>Hello, world!</h1>", "countries": [ "US" ], "metadata": { "key": "value" }, "search_engine_optimizer": { "title": "SEO Title", "description": "SEO Description", "image_url": "https://example.com/seo-image.jpg" }, "open_graph": { "title": "OG Title", "description": "OG Description", "image_url": "https://example.com/og-image.jpg" }, "content": "<h1>Hello, world!</h1>", "variables": { "company_name": "ACME Inc.", "site_url": "https://example.com", "current_year": "2025" }, "stylesheet": "<style>body { background-color: #f0f0f0; }</style>", "translations": { "en": { "hello": "Hello" }, "fr": { "hello": "Bonjour" } }, "taggings_attributes": [ { "tag_id": 1 } ] } }'
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/pages/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
{ "item": { "id": 1, "title": "New Page", "slug": "new-page", "share_link": "https://example.com/p/abc123", "active": true, "stripped_description": "This is a page description", "views": 0, "leads": 0, "image_url": "https://example.com/image.jpg", "metadata": {}, "publish": true, "publish_at": "2025-01-01T00:00:00Z", "label": "Featured", "display_tag": "Tag", "prompts_enabled": true, "default": false, "use_for_enrollment_completion": false, "use_search_engine": true, "show_on_site_search": true, "email": "page@example.com", "application_theme_template_id": 1, "application_theme_id": 1, "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z", "url": "https://example.com/page", "page_content": "<h1>Hello, world!</h1>", "prompts": [ … ], "source": "builder", "countries": [], "open_graph": { … }, "search_engine_optimizer": { … }, "custom_slug": false }, "meta": { "request_id": "string", "timestamp": "string" } }
curl -i -X PUT \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/pages/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "page": { "title": "Updated Page", "label": "Trending", "display_tag": "Display tag", "stripped_description": "Updated description", "image_url": "https://example.com/image.jpg", "source": "builder", "publish": true, "prompts_enabled": true, "json": "{}", "use_search_engine": true, "show_on_site_search": true, "email": "page@example.com", "countries": [ "US" ], "metadata": { "key": "value" }, "search_engine_optimizer": { "title": "SEO Title", "description": "SEO Description", "image_url": "https://example.com/seo-image.jpg" }, "open_graph": { "title": "OG Title", "description": "OG Description", "image_url": "https://example.com/og-image.jpg" }, "content": "<h1>Hello, world!</h1>", "variables": { "company_name": "ACME Inc.", "site_url": "https://example.com", "current_year": "2025" }, "stylesheet": "<style>body { background-color: #f0f0f0; }</style>" } }'
curl -i -X DELETE \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/pages/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
curl -i -X POST \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/pages/{id}/clone' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/pages/{id}/views' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
curl -i -X GET \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/pages/{id}/leads' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Set the status of the page(s) or 'delete' to perform soft deletion
curl -i -X PATCH \ https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/pages/bulk_status_update \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "status": "active", "page_ids": [ 0 ] }'
{ "message": "Pages were successfully deleted.", "meta": { "request_id": "string", "timestamp": "string" } }
curl -i -X POST \ https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/pages/import \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: multipart/form-data'
{ "message": "Import has successfully started. Please check back later.", "meta": { "request_id": "string", "timestamp": "string" } }
curl -i -X POST \ 'https://docs.fluid.app/_mock/docs/apis/company.api/api/v202506/pages/{id}/promote_to_template' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "themeable_type": "product" }'
{ "item": { "application_theme_template": { … } }, "meta": { "request_id": "string", "timestamp": "string" } }
Social Media