HappyFox Email API
Author: d | 2025-04-24
Discover new APIs and use cases through the HappyFox API directory below. Use the HappyFox APIs to integrate HappyFox data and unlock new workflows. API: Create and Manage Assets in HappyFox API for Asset Management API for HappyFox API to create custom fields with dynamic values Contacts and Contact Groups API endpoints Enabling API in your HappyFox account Get reports via API How to create an API Key and Auth Code in HappyFox?
API for HappyFox - HappyFox Support
API provided by the HappyFox helpdesk is a RESTful web service. It supports operations like creating a ticket, adding updates to a ticket, listing tickets and users of the Helpdesk. It supports JSON, Form Url encoded and Multipart Form Data formats as payload.Requirements: The API requires following skills in any programming language. Making HTTP requests (using GET and POST HTTP methods as a minimum requirement). Doing HTTP Basic Authentication. Generating and reading data in the JSON format. Optionally making HTTP POST requests using content type of "multipart/form-data" (needed for ticket attachments)Documentation Conventions:The documentation indicates parameters that need to be replaced with actual values using the format . The entire string including the enclosing should be replaced.For example, if the parameter email is it should be replaced with the required email addressEndpoint url format: /api/1.1//The above tail url has to be suffixed with your HappyFox account url as shown belowEg. HTTP POST API calls are to be explicitly marked as https. Else, it would be considered as GET onlyNote: If you are using a custom domain, please use the custom domain urlAPI key and auth code are to be passed in Basic HTTP authentication format only. - refers the module which is being accessed viz., /tickets/, /users/ etc A full constructed example url is shown below. knowledge base article consists of all operations that can be done via the users endpoint.For HTTP POST methods, please ensure the IDs of the custom fields are as per /api/1.1/json/user_custom_fields/ List of topics covered in this articleNote: All timestamps in API responses are in UTC1. Get a list of contacts2. Search contacts3. Contact detail page4. Add new contact/Edit existing contact5. Add/Edit multiple contacts6. Remove contact(s) from Contact Group7. Enable/Disable login permission8. Get a list of all contact groups9. Get contact group details10. Create a contact group11. Edit contact group12. Add/Edit contacts of a contact group13. List all contact custom fields1. Get a list of contactsAPI Endpoint: /api/1.1/json/users/Method: GETExample response:{ "page_info": { "count": 10, "last_index": 62, "page_count": 7, "start_index": 1, "end_index": 10 }, "data": [ { "name": "John Doe", "primary_phone": { "type": "m", "number": "98765432", "id": 1 }, "phones": [ { "type": "m", "number": "98765432", "id": 1 } ], "created_at": null, "updated_at": null, "pending_tickets_count": 2, "contact_groups": [ { "tagged_domains": "example.com", "access_all_tickets_in_group": false, "description": "Example contact group", "name": "sample 21", "id": 2 } ], "tickets_count": 2, "id": 4, "email": "[email protected]", "custom_fields": [ { "name": "A", "value": null,
API to change requester email address - HappyFox Support
API provided by the HappyFox helpdesk is a RESTful web service. It supports operations like creating a ticket, adding updates to a ticket, listing tickets and users of the Helpdesk. It supports JSON, Form Url encoded and Multipart Form Data formats as payload.Requirements:The API requires following skills in any programming language. Making HTTP requests (using GET and POST HTTP methods as a minimum requirement). Doing HTTP Basic Authentication. Generating and reading data in the JSON format. Optionally making HTTP POST requests using content type of "multipart/form-data" (needed for ticket attachments)Documentation Conventions:The documentation indicates parameters that need to be replaced with actual values using the format . The entire string including the enclosing should be replaced.For example, if the parameter email is it should be replaced with the required email addressEndpoint url format : /api/1.1//The above tail url has to be suffixed with your HappyFox account url as shown belowEg. If you are using a custom domain, please use the custom domain urlNote: All timestamps in API responses are in UTCAPI key and auth code are to be passed in Basic HTTP authentication format only. - refers the module which is being accessed viz., /reports/, /users/ etc A full constructed example url is shown below. knowledge base article consists of all operations that can be done via the reports endpoint.1. Get list of all reports2. View report summary3. View tabular view of a report4. View response stats5. View Staff Performance6. View Staff Activity7. View Contact Activity8. View SLA Performance9. Runtime filtering and sorting of reports1. Get list of all reportsProvides a paginated list of all reports that have been created and saved in the Main Menu --> All Reports module.API Endpoint: /api/1.1/json/reports/Method: GETExample Response:{ "last_index": 7, "rows": [ { "description": "", "name": "Test report", "id": 7 }, { "description": "All tickets that are created in the last week", "name": "Tickets created in last one week", "id": 3 } ], "page_count": 1, "start_index": 1, "end_index": 7}2. View Report SummaryTo see the summary of a report showing ticket count, completed count, assigned count etc, in one shot. API Endpoint: /api/1.1/json/report//The id of a report can be obtained from the /reports/ endpoint.Method: GETExample Response{ "ticket_count": 0, "completed_count": 0, "assigned_count": 0, "pending_count": 0, "unassigned_count": 0}3. View Tabular View of a reportThis endpoint allows access to the most frequently used option in the reports module from the UI, Tabular view.API Endpoint: /api/1.1/json/report//tabulardata/Method: GETExample Response:{ "rows": [ { "display_id": "#NCC00003439", "due_date": "24 Apr 2019", "status_id": 5, "status_name": "open", "assignee": "Pradeep CE", "id": 3439, "subject": "Test Ticket" }, { "display_id": "#CFC00003432", "due_date": "26 Apr 2019", "status_id": 3, "status_name": "new", "assignee": "-", "id": 3432, "subject": "Example ticket" } ], "sort_key": "duedate", "page_count": 5, "end_index": 10, "sort_order": "a", "last_index": 42,Handling Email Loops in HappyFox
This functionality, not only optimizes agent workloads, but also offers custom app integrations to address specific business needs. Chat bots, support ticketing, and live conversations are integrated into a single unified platform.Freshdesk ensures data security with stringent audits of networks and systems, along with adherence to regulatory compliance. It offers custom SSL certificates to safeguard your domain, and facilitates controlled access with features such as IP whitelisting and identity & access management. The platform is highly customizable, allowing for personalized workflows and agent roles, aligning with your business’s unique needs and fostering a secure, efficient, and responsive customer service environment. HappyFox offers a straightforward and efficient help desk and ticket management solution. Designed to centralize and simplify omnichannel requests, it facilitates a single platform where you can convert emails, phone calls, chats, social media interactions, and web requests into actionable tickets. This tool seamlessly integrates with HappyFox Chat and other live chat widgets, recording all customer conversations as tickets in the help desk system. It also manages knowledge base articles and FAQs in multiple languages, encouraging self-service among end-users, allowing you to reduce ticket volume.HappyFox integrates with popular SaaS applications, enhancing its utility by integrating information from other CRMs, online stores, call centers, or project management tools into its interface. HappyFox also provides a powerful automation suite. It facilitates the crafting of smart rules that dictate trigger conditions and can automate everyday actions, along with intelligent ticket assignment algorithms to expedite the support process.To augment collaboration and efficient problem-solving, HappyFox allows for private notes to facilitate internal discussions amongst team members. This feature, alongside the ability to create ticket templates and preset responses, streamlines the process of managing and responding to customer issues. Furthermore, task management capabilities let you break down complex tickets into smaller tasks, making the resolution process more organized and manageable. This is complemented by a robust reporting module, offering real-time insights that can assist in optimizing support strategies and identifying areas for improvement.HappyFox also offers enterprise-level security functionalities. It includes features like IP restrictions, custom SSL certificates, two-factor authentication, and session-based security to safeguard data and. Discover new APIs and use cases through the HappyFox API directory below. Use the HappyFox APIs to integrate HappyFox data and unlock new workflows.Now Available: HappyFox API Portal
HappyFox provides you with RESTful APIs where you can create a ticket, add updates to a ticket, list tickets and users and much more. JSON, Form Urlencoded and Multipart Form Data are the supported formats for the APIs.What you need, how you can use it, API version, Resource URI and all other information can be found here on this exclusive page for APIs How to create API auth code and key Tickets endpoint Contacts and contact groups endpoint Reports endpoint Set multiple option custom fields using API Asset management via API Export Knowledge Base API Rate limting API to create custom fields with dynamic valuesIf your HappyFox account is hosted in EU, please use .happyfox.netNote: All timestamps in API responses are in UTCOther commonly used endpoints are listed below.API key and auth code are to be passed in Basic HTTP authentication format only.1. List categoriesAPI Endpoint: GET2. List staffs/agentsAPI Endpoint: GET3. List all statusesAPI Endpoint: GET4. List metadata of all ticket custom fields API Endpoint: GET5. List metadata of all contact custom fieldsAPI Endpoint: .happyfox.com/api/1.1/json/user_custom_fields/"> GET6. Export Knowledge BaseHTTP Method: GET API Endpoints: External articles - .happyfox.com/api/1.1/json/kb/articles/"> articles - .happyfox.com/api/1.1/json/kb/internal-articles/"> sections - .happyfox.com/api/1.1/json/kb/sections/"> single article - .happyfox.com/api/1.1/json/kb/article/"> single section - .happyfox.com/api/1.1/json/kb/section/ above url allows you to access one article a time, using the article id provided from the /articles/ endpoint in the previous step. This is applicable only for external articles.Enabling API in your HappyFox account
And public knowledge bases c) Customer happiness ratings d) Reports and dashboards e) Help centre theme gallery f) Ticket sharing g) Scheduled reports h) Help centre customisation i) Zia (an AI-powered assistant) 3) Groove For small to medium-sized businesses, Groove is among the most cost-effective cloud-based Help Desk Software solutions. It helps enables to communicate with their customers via email, social media, live chat, and phone calls. According to multiple users, Groove’s Help Desk is quicker to set up, easier to use, and offers a much better customer experience than Zendesk and Freshdesk. Groove’s Help Desk Software allows companies to organise, accept, track, and respond to support requests. Key features include: a) Ticketing b) Customer satisfaction ratings c) Live chat d) Knowledge base e) Self-service portals f) SLO management g) Customisable Workflows h) Multiple mailboxes i) Task management j) Reporting and analytics Looking to hone the skill of tracking, trending, and measuring complaint data efficiently? Our Call Control Strategies for Customer Service Course will guide you - Sign up now! 4) LiveAgent LiveAgent's free Help Desk Software is the ideal starting point for new businesses that want a robust system but are unable to afford an enterprise-level plan. However, there are some limitations, like the ability to view tickets older than seven days. If your company handles a high volume of support requests, consider upgrading to one of LiveAgent's paid plans. LiveAgent offers live chats, calls, emails, unlimited agents, and contact forms. Through its ticketing system, you can receive all support requests from all channels in a single inbox, which you can easily file as a ticket. Additionally, LiveAgent lets you set up a free knowledge base so that customers can solve their problems without contacting your support team. Key features include: a) Ticket management through centralised customer inquiries b) Live chat c) Call centre features like unlimited call recordings and IVR d) Knowledge base e) Social media integration f) Automation of tasks such as ticket distribution and follow-ups g) Customer satisfaction ratings h) Customisable workflows i) Reporting and analytics: j) Integrations with tools like CRM systems, Slack, and Trello5) ZendeskZendesk streamlines customer support with time-saving tools like automation and triggers. It's intuitive and easy-to-use support desk software built with customers and agents in mind. Zendesk’s Help Desk Software features include: a) Custom views b) Self-service options c) Automated routing d) Custom branding e) Analytics and Reporting f) Live chat and messaging g) Omnichannel support h) Integrated voice software i) Collaboration tools j) SDKs, API, and app integrations k) Multi-language support6) HappyFox HappyFox is a cloud-based Help Desk solution for various team sizes and industries. It includes the essential features of a Help Desk, including ticketing management, smart automation, advanced reporting, and more. But HappyFox has relatively fewer app integrations, compared to an option like Zendesk. Also, HappyFox offers neither a free trial nor a free plan, so you must pay to try the software. The company offers four plans, each requiring at least five Help Desk agents, and theAPI for Asset Management - HappyFox Support
HappyFox Chat has dedicated desktop apps to make the chat experience amazing with native Desktop notifications.Desktop apps are available for Mac and Windows operating systems. You download the desktop apps from Apps -> Goodies.Once you download, you can view the HappyFox Chat app icon in the dock. On Windows, you can view the app in Start menu.You can have the app running in the background and get notified whenever there are new incoming chats. Agents will get sound and desktop notifications for incoming chats requests and view the notifications on the app's icon in the system tray as well.Desktop notification :System tray notification:On Mac app, you will find a HappyFox Chat icon on the top menu bar as well. On clicking the icon, it will show you the drop-down with different options.When the agent clicks offline your chat availability becomes unavailable and the HappyFox Chat icon on the top menu bar will also be greyed out. Agent will know if they are offline or online to take chats, without even checking the Mac app.. Discover new APIs and use cases through the HappyFox API directory below. Use the HappyFox APIs to integrate HappyFox data and unlock new workflows. API: Create and Manage Assets in HappyFox API for Asset Management API for HappyFox API to create custom fields with dynamic values Contacts and Contact Groups API endpoints Enabling API in your HappyFox account Get reports via API How to create an API Key and Auth Code in HappyFox?Comments
API provided by the HappyFox helpdesk is a RESTful web service. It supports operations like creating a ticket, adding updates to a ticket, listing tickets and users of the Helpdesk. It supports JSON, Form Url encoded and Multipart Form Data formats as payload.Requirements: The API requires following skills in any programming language. Making HTTP requests (using GET and POST HTTP methods as a minimum requirement). Doing HTTP Basic Authentication. Generating and reading data in the JSON format. Optionally making HTTP POST requests using content type of "multipart/form-data" (needed for ticket attachments)Documentation Conventions:The documentation indicates parameters that need to be replaced with actual values using the format . The entire string including the enclosing should be replaced.For example, if the parameter email is it should be replaced with the required email addressEndpoint url format: /api/1.1//The above tail url has to be suffixed with your HappyFox account url as shown belowEg. HTTP POST API calls are to be explicitly marked as https. Else, it would be considered as GET onlyNote: If you are using a custom domain, please use the custom domain urlAPI key and auth code are to be passed in Basic HTTP authentication format only. - refers the module which is being accessed viz., /tickets/, /users/ etc A full constructed example url is shown below. knowledge base article consists of all operations that can be done via the users endpoint.For HTTP POST methods, please ensure the IDs of the custom fields are as per /api/1.1/json/user_custom_fields/ List of topics covered in this articleNote: All timestamps in API responses are in UTC1. Get a list of contacts2. Search contacts3. Contact detail page4. Add new contact/Edit existing contact5. Add/Edit multiple contacts6. Remove contact(s) from Contact Group7. Enable/Disable login permission8. Get a list of all contact groups9. Get contact group details10. Create a contact group11. Edit contact group12. Add/Edit contacts of a contact group13. List all contact custom fields1. Get a list of contactsAPI Endpoint: /api/1.1/json/users/Method: GETExample response:{ "page_info": { "count": 10, "last_index": 62, "page_count": 7, "start_index": 1, "end_index": 10 }, "data": [ { "name": "John Doe", "primary_phone": { "type": "m", "number": "98765432", "id": 1 }, "phones": [ { "type": "m", "number": "98765432", "id": 1 } ], "created_at": null, "updated_at": null, "pending_tickets_count": 2, "contact_groups": [ { "tagged_domains": "example.com", "access_all_tickets_in_group": false, "description": "Example contact group", "name": "sample 21", "id": 2 } ], "tickets_count": 2, "id": 4, "email": "[email protected]", "custom_fields": [ { "name": "A", "value": null,
2025-03-27API provided by the HappyFox helpdesk is a RESTful web service. It supports operations like creating a ticket, adding updates to a ticket, listing tickets and users of the Helpdesk. It supports JSON, Form Url encoded and Multipart Form Data formats as payload.Requirements:The API requires following skills in any programming language. Making HTTP requests (using GET and POST HTTP methods as a minimum requirement). Doing HTTP Basic Authentication. Generating and reading data in the JSON format. Optionally making HTTP POST requests using content type of "multipart/form-data" (needed for ticket attachments)Documentation Conventions:The documentation indicates parameters that need to be replaced with actual values using the format . The entire string including the enclosing should be replaced.For example, if the parameter email is it should be replaced with the required email addressEndpoint url format : /api/1.1//The above tail url has to be suffixed with your HappyFox account url as shown belowEg. If you are using a custom domain, please use the custom domain urlNote: All timestamps in API responses are in UTCAPI key and auth code are to be passed in Basic HTTP authentication format only. - refers the module which is being accessed viz., /reports/, /users/ etc A full constructed example url is shown below. knowledge base article consists of all operations that can be done via the reports endpoint.1. Get list of all reports2. View report summary3. View tabular view of a report4. View response stats5. View Staff Performance6. View Staff Activity7. View Contact Activity8. View SLA Performance9. Runtime filtering and sorting of reports1. Get list of all reportsProvides a paginated list of all reports that have been created and saved in the Main Menu --> All Reports module.API Endpoint: /api/1.1/json/reports/Method: GETExample Response:{ "last_index": 7, "rows": [ { "description": "", "name": "Test report", "id": 7 }, { "description": "All tickets that are created in the last week", "name": "Tickets created in last one week", "id": 3 } ], "page_count": 1, "start_index": 1, "end_index": 7}2. View Report SummaryTo see the summary of a report showing ticket count, completed count, assigned count etc, in one shot. API Endpoint: /api/1.1/json/report//The id of a report can be obtained from the /reports/ endpoint.Method: GETExample Response{ "ticket_count": 0, "completed_count": 0, "assigned_count": 0, "pending_count": 0, "unassigned_count": 0}3. View Tabular View of a reportThis endpoint allows access to the most frequently used option in the reports module from the UI, Tabular view.API Endpoint: /api/1.1/json/report//tabulardata/Method: GETExample Response:{ "rows": [ { "display_id": "#NCC00003439", "due_date": "24 Apr 2019", "status_id": 5, "status_name": "open", "assignee": "Pradeep CE", "id": 3439, "subject": "Test Ticket" }, { "display_id": "#CFC00003432", "due_date": "26 Apr 2019", "status_id": 3, "status_name": "new", "assignee": "-", "id": 3432, "subject": "Example ticket" } ], "sort_key": "duedate", "page_count": 5, "end_index": 10, "sort_order": "a", "last_index": 42,
2025-04-24HappyFox provides you with RESTful APIs where you can create a ticket, add updates to a ticket, list tickets and users and much more. JSON, Form Urlencoded and Multipart Form Data are the supported formats for the APIs.What you need, how you can use it, API version, Resource URI and all other information can be found here on this exclusive page for APIs How to create API auth code and key Tickets endpoint Contacts and contact groups endpoint Reports endpoint Set multiple option custom fields using API Asset management via API Export Knowledge Base API Rate limting API to create custom fields with dynamic valuesIf your HappyFox account is hosted in EU, please use .happyfox.netNote: All timestamps in API responses are in UTCOther commonly used endpoints are listed below.API key and auth code are to be passed in Basic HTTP authentication format only.1. List categoriesAPI Endpoint: GET2. List staffs/agentsAPI Endpoint: GET3. List all statusesAPI Endpoint: GET4. List metadata of all ticket custom fields API Endpoint: GET5. List metadata of all contact custom fieldsAPI Endpoint: .happyfox.com/api/1.1/json/user_custom_fields/"> GET6. Export Knowledge BaseHTTP Method: GET API Endpoints: External articles - .happyfox.com/api/1.1/json/kb/articles/"> articles - .happyfox.com/api/1.1/json/kb/internal-articles/"> sections - .happyfox.com/api/1.1/json/kb/sections/"> single article - .happyfox.com/api/1.1/json/kb/article/"> single section - .happyfox.com/api/1.1/json/kb/section/ above url allows you to access one article a time, using the article id provided from the /articles/ endpoint in the previous step. This is applicable only for external articles.
2025-03-30And public knowledge bases c) Customer happiness ratings d) Reports and dashboards e) Help centre theme gallery f) Ticket sharing g) Scheduled reports h) Help centre customisation i) Zia (an AI-powered assistant) 3) Groove For small to medium-sized businesses, Groove is among the most cost-effective cloud-based Help Desk Software solutions. It helps enables to communicate with their customers via email, social media, live chat, and phone calls. According to multiple users, Groove’s Help Desk is quicker to set up, easier to use, and offers a much better customer experience than Zendesk and Freshdesk. Groove’s Help Desk Software allows companies to organise, accept, track, and respond to support requests. Key features include: a) Ticketing b) Customer satisfaction ratings c) Live chat d) Knowledge base e) Self-service portals f) SLO management g) Customisable Workflows h) Multiple mailboxes i) Task management j) Reporting and analytics Looking to hone the skill of tracking, trending, and measuring complaint data efficiently? Our Call Control Strategies for Customer Service Course will guide you - Sign up now! 4) LiveAgent LiveAgent's free Help Desk Software is the ideal starting point for new businesses that want a robust system but are unable to afford an enterprise-level plan. However, there are some limitations, like the ability to view tickets older than seven days. If your company handles a high volume of support requests, consider upgrading to one of LiveAgent's paid plans. LiveAgent offers live chats, calls, emails, unlimited agents, and contact forms. Through its ticketing system, you can receive all support requests from all channels in a single inbox, which you can easily file as a ticket. Additionally, LiveAgent lets you set up a free knowledge base so that customers can solve their problems without contacting your support team. Key features include: a) Ticket management through centralised customer inquiries b) Live chat c) Call centre features like unlimited call recordings and IVR d) Knowledge base e) Social media integration f) Automation of tasks such as ticket distribution and follow-ups g) Customer satisfaction ratings h) Customisable workflows i) Reporting and analytics: j) Integrations with tools like CRM systems, Slack, and Trello5) ZendeskZendesk streamlines customer support with time-saving tools like automation and triggers. It's intuitive and easy-to-use support desk software built with customers and agents in mind. Zendesk’s Help Desk Software features include: a) Custom views b) Self-service options c) Automated routing d) Custom branding e) Analytics and Reporting f) Live chat and messaging g) Omnichannel support h) Integrated voice software i) Collaboration tools j) SDKs, API, and app integrations k) Multi-language support6) HappyFox HappyFox is a cloud-based Help Desk solution for various team sizes and industries. It includes the essential features of a Help Desk, including ticketing management, smart automation, advanced reporting, and more. But HappyFox has relatively fewer app integrations, compared to an option like Zendesk. Also, HappyFox offers neither a free trial nor a free plan, so you must pay to try the software. The company offers four plans, each requiring at least five Help Desk agents, and the
2025-04-19HappyFox, Inc is headquartered in Irvine, California. HappyFox is a software-as-a-service (SaaS) support platform. We offer an enterprise-grade help desk ticketing system and an intuitively designed live chat software. We serve over 12,000 companies in 70+ countries. HappyFox is used by companies that span across education, media, e-commerce, retail, information technology, manufacturing, non-profit, government and many other verticals that have an internal or external support function. HappyFox Help Desk has been rated as the Best Help Desk Software by PC Mag. HappyFox Chat is the top voted Live Chat Software at launch on the ProductHunt platform. Our Vision We believe in bringing “happy” back into the support function of any organization. Our thoughtfully built applications are focused on agent productivity and success. Happy Agents. Happy Customers. Company Leadership Shalin Jain is the CEO of HappyFox Inc. He has over 16 years of entrepreneurial experience and having worked with thousands of companies, assisting them in implementing great support processes. He has won several entrepreneurial awards including Pathfinders in 2013. Our Product Suite Awards & Recognition
2025-03-30