Overview
Quick Tour Provide faster and better support for your customers.
Get a Demo See HappyFox Helpdesk in action.
Features
Ticketing System Deliver exceptional customer service with HappyFox.
Knowledge Base Promote self-service; build help and FAQ pages.
Canned Actions Respond faster using templated responses and actions.
Automation Reduce the time spent on repetitive tasks.
Task Management Create and manage all the tasks involved in resolving a ticket.
Asset Management Track hardware and software assets in one place.
Help Desk Reports Monitor, refine and improve your customer engagement.
By Use Case
Help Desk Software Track requests from multiple channels in a single place.
Ticketing System Deliver exceptional customer service with HappyFox.
IT Help Desk Software The best helpdesk software for modern IT teams
Email Management Provide support via email without cluttering your inbox.
Customer Service A customer service management software that promises retention
Shared Inbox Organize, collaborate & measure your high-volume shared inboxes
Multi-Brand Help Desk Provide centralized support for multiple brands
Contact Center Software Omnichannel support for your cloud contact center
Resources
E-books & Guides Resources to reinvent your customer service experience.
Webinars Learn how to make the most of HappyFox products.
Case Studies Thousands of great companies call HappyFox a great friend.
Videos Checkout our library of educational videos.
Support Center What can we help you with? Talk to our customer support.
Blog Learn tips, stories, and new techniques.
API Technical Reference
A Staff is a person handling Helpdesk duties like responding to incoming tickets, solving the requests / problems covered in the tickets.
Retrieve a list of all staff.
| URL | <base_uri> / <response_format> /staff/ |
|---|---|
| HTTP Method | GET |
| Response Data | List of staff |
JSON
[
{
"name": "Scott ",
"email": "scott@example.com",
"role": {
"name": "Administrator",
"id": 1
},
"active": true,
"id": 2,
"categories": [
1,
2,
4,
5
],
"permissions": [
"manage_staff",
"manage_contacts",
"manage_templates",
"manage_kb",
"manage_smart_rules",
"email_reply",
"web_reply",
"edit_replies",
"delete_replies",
"delete_tickets",
"close_tickets",
"move_tickets",
"split_tickets",
"assign_tickets",
"set_due_date",
"manage_categories",
"manage_priorities",
"manage_statuses",
"manage_ticket_custom",
"manage_client_custom",
"manage_integrations",
"manage_canned_actions",
"all_tickets",
"relate_tickets",
"manage_sla",
"reassign_tickets",
"act_on_closed",
"change_ticket_contact",
"create_ticket_in_any_category",
"move_ticket_to_any_category",
"create_edit_reports",
"export_reports",
"forward_tickets",
"manage_contact_groups",
"edit_subject",
"view_reports"
]
},
{
"name": "James ",
"email": "james@example.com",
"role": {
"name": "Administrator",
"id": 1
},
"active": true,
"id": 3,
"categories": [
1,
2,
4,
5
],
"permissions": [
"manage_staff",
"manage_contacts",
"manage_templates",
"manage_kb",
"manage_smart_rules",
"email_reply",
"web_reply",
"edit_replies",
"delete_replies",
"delete_tickets",
"close_tickets",
"move_tickets",
"split_tickets",
"assign_tickets",
"set_due_date",
"manage_categories",
"manage_priorities",
"manage_statuses",
"manage_ticket_custom",
"manage_client_custom",
"manage_integrations",
"manage_canned_actions",
"all_tickets",
"relate_tickets",
"manage_sla",
"reassign_tickets",
"act_on_closed",
"change_ticket_contact",
"create_ticket_in_any_category",
"move_ticket_to_any_category",
"create_edit_reports",
"export_reports",
"forward_tickets",
"manage_contact_groups",
"edit_subject",
"view_reports"
]
},
{
"name": "Adam Smith",
"email": "adam.smith@example.com",
"role": {
"name": "Administrator",
"id": 1
},
"active": true,
"id": 1,
"categories": [
1,
2,
4,
5
],
"permissions": [
"manage_staff",
"manage_contacts",
"manage_templates",
"manage_kb",
"manage_smart_rules",
"email_reply",
"web_reply",
"edit_replies",
"delete_replies",
"delete_tickets",
"close_tickets",
"move_tickets",
"split_tickets",
"assign_tickets",
"set_due_date",
"manage_categories",
"manage_priorities",
"manage_statuses",
"manage_ticket_custom",
"manage_client_custom",
"manage_integrations",
"manage_canned_actions",
"all_tickets",
"relate_tickets",
"manage_sla",
"reassign_tickets",
"act_on_closed",
"change_ticket_contact",
"create_ticket_in_any_category",
"move_ticket_to_any_category",
"create_edit_reports",
"export_reports",
"forward_tickets",
"manage_contact_groups",
"edit_subject",
"view_reports"
]
}
]
Retrieve details of a staff using their ID.
| URL | <base_uri> / <response_format> /staff/<id>/ |
|---|---|
| HTTP Method | GET |
| Response Data | Staff |
JSON
[
{
"name": "Adam Smith",
"email": "adam.smith@example.com",
"role": {
"name": "Administrator",
"id": 1
},
"active": true,
"id": 1,
"categories": [
1,
2,
4,
5
],
"permissions": [
"manage_staff",
"manage_contacts",
"manage_templates",
"manage_kb",
"manage_smart_rules",
"email_reply",
"web_reply",
"edit_replies",
"delete_replies",
"delete_tickets",
"close_tickets",
"move_tickets",
"split_tickets",
"assign_tickets",
"set_due_date",
"manage_categories",
"manage_priorities",
"manage_statuses",
"manage_ticket_custom",
"manage_client_custom",
"manage_integrations",
"manage_canned_actions",
"all_tickets",
"relate_tickets",
"manage_sla",
"reassign_tickets",
"act_on_closed",
"change_ticket_contact",
"create_ticket_in_any_category",
"move_ticket_to_any_category",
"create_edit_reports",
"export_reports",
"forward_tickets",
"manage_contact_groups",
"edit_subject",
"view_reports"
]
}
]
Retrieve details of a staff using their email address.
| URL | <base_uri> / <response_format> /staff/<email>/ |
|---|---|
| HTTP Method | GET |
| Response Data | Staff |
JSON
[
{
"name": "Adam Smith",
"email": "adam.smith@example.com",
"role": {
"name": "Administrator",
"id": 1
},
"active": true,
"id": 1,
"categories": [
1,
2,
4,
5
],
"permissions": [
"manage_staff",
"manage_contacts",
"manage_templates",
"manage_kb",
"manage_smart_rules",
"email_reply",
"web_reply",
"edit_replies",
"delete_replies",
"delete_tickets",
"close_tickets",
"move_tickets",
"split_tickets",
"assign_tickets",
"set_due_date",
"manage_categories",
"manage_priorities",
"manage_statuses",
"manage_ticket_custom",
"manage_client_custom",
"manage_integrations",
"manage_canned_actions",
"all_tickets",
"relate_tickets",
"manage_sla",
"reassign_tickets",
"act_on_closed",
"change_ticket_contact",
"create_ticket_in_any_category",
"move_ticket_to_any_category",
"create_edit_reports",
"export_reports",
"forward_tickets",
"manage_contact_groups",
"edit_subject",
"view_reports"
]
}
]