happyfox_list_tickets
List or search tickets
List tickets, newest activity first, with optional filters and HappyFox's search syntax. Paginated (page_info + data). Search `q` examples: `status:"New","In Progress"`, `priority:"High"`, `assignee:none`, `tag:"billing"`, `contact:"[email protected]"`, `unresponded:true`, `breached:true`, `duedate:overdue`, `created-after:"2026/01/31"`, `last-modified-on-or-after:"2026/09/01"`, `"Custom Field":"value"`. Separate several filters with a space. HappyFox: GET /api/1.1/json/tickets/.
输入参数qpagesizesortfieldsstatuscategoryminify_response
happyfox_get_ticket
Get one ticket
Fetch a ticket with its full conversation: status, priority, category, contact, assignee, custom fields, SLA breaches and every update (messages, private notes, property changes, attachment links that expire in 5 minutes). HappyFox: GET /api/1.1/json/ticket/<ticket_number>/.
输入参数ticket_number必填show_cf_changes
happyfox_list_contacts
List or search contacts
List contacts (customers), paginated, or search them. Search `q` fields: name, email, phone (digits only, no +), updated_since, created_since — e.g. `name:adam email:[email protected]` (space-separated, all must match). HappyFox: GET /api/1.1/json/users/.
输入参数qpagesize
happyfox_get_contact
Get one contact
Fetch a contact by id or by email address — phones, contact groups, ticket counts and custom fields. HappyFox: GET /api/1.1/json/user/<id or email>/.
输入参数contact必填
happyfox_list_contact_groups
List contact groups
List contact groups (typically customer companies) with their tagged email domains. HappyFox: GET /api/1.1/json/contact_groups/.
无需输入参数。
happyfox_get_contact_group
Get one contact group
Fetch a contact group and its member contacts. HappyFox: GET /api/1.1/json/contact_group/<id>/.
输入参数contact_group_id必填
happyfox_list_categories
List categories
List ticket categories (queues) with their ids — needed to create a ticket or filter tickets. HappyFox: GET /api/1.1/json/categories/.
无需输入参数。
happyfox_list_staff
List agents
List agents (staff) with their ids, roles, categories and active flag — the `staff` id every reply/note needs, and assignee ids. HappyFox: GET /api/1.1/json/staff/.
无需输入参数。
happyfox_list_statuses
List statuses
List ticket statuses with ids and behaviour (pending / completed) — ids used to change a ticket's status. HappyFox: GET /api/1.1/json/statuses/.
无需输入参数。
happyfox_list_priorities
List priorities
List ticket priorities with ids — ids used to set a ticket's priority. HappyFox: GET /api/1.1/json/priorities/.
无需输入参数。
happyfox_list_ticket_custom_fields
List ticket custom fields
List ticket custom fields: id, type, choices (with choice ids), required flags and categories. Use the ids as t-cf-<id>. HappyFox: GET /api/1.1/json/ticket_custom_fields/.
无需输入参数。
happyfox_list_contact_custom_fields
List contact custom fields
List contact custom fields: id, type, choices and required flag. Use the ids as c-cf-<id>. HappyFox: GET /api/1.1/json/user_custom_fields/.
无需输入参数。
happyfox_list_reports
List reports
List the saved reports (id, name, description) from the Reports module. HappyFox: GET /api/1.1/json/reports/.
无需输入参数。
happyfox_get_report_summary
Get a report summary
Summary counts for a saved report: ticket, completed, assigned, pending and unassigned counts. HappyFox: GET /api/1.1/json/report/<id>/.
输入参数report_id必填
happyfox_get_report_tabular_data
Get a report's ticket rows
The tabular view of a saved report — one row per ticket (display_id, subject, status, assignee, due date), paginated. HappyFox: GET /api/1.1/json/report/<id>/tabulardata/.
输入参数pagesizereport_id必填
happyfox_list_kb_articles
Export knowledge-base articles
Export the knowledge base: external (customer-facing) articles by default, or internal (agent-only) articles. HappyFox: GET /api/1.1/json/kb/articles/ or /kb/internal-articles/.
输入参数internal
happyfox_create_ticket
Create a ticket
Open a new ticket on behalf of a contact (created if the email is new). Needs a category id (a public category), a subject and a message in `text` or `html`. HappyFox: POST /api/1.1/json/tickets/.
输入参数ccbcchtmlname必填tagstextemail必填phonesubject必填assigneecategory必填due_date另有 3 个
happyfox_add_staff_reply
Reply to a ticket as an agent
Add an agent reply to a ticket and/or change its status, priority, assignee, due date or tags. The contact is emailed ONLY if update_customer is true (HappyFox default: false). With no message it just updates properties. Moving to a completed status may require the category's compulsory custom fields. HappyFox: POST /api/1.1/json/ticket/<ticket_number>/staff_update/.
输入参数ccbcchtmltagsstaff必填statussubjectassigneedue_datepriorityplaintexttime_spent另有 4 个
happyfox_add_private_note
Add a private note to a ticket
Add an internal note (never sent to the contact), optionally alerting agents and changing status, priority, assignee, due date or tags. HappyFox: POST /api/1.1/json/ticket/<ticket_number>/staff_pvtnote/.
输入参数htmltagsalertstaff必填statusassigneedue_datepriorityplaintexttime_spentcustom_fieldsticket_number必填
happyfox_update_ticket_tags
Add or remove ticket tags
Add and/or remove tags on a ticket without touching anything else. HappyFox: POST /api/1.1/json/ticket/<ticket_number>/update_tags/.
输入参数addremovestaff_id必填ticket_number必填
happyfox_update_ticket_custom_fields
Edit a ticket's custom fields
Set ticket custom-field values (t-cf-<id>, ids from happyfox_list_ticket_custom_fields). HappyFox: POST /api/1.1/json/ticket/<ticket_number>/update_custom_fields/.
输入参数staff必填custom_fields必填ticket_number必填
happyfox_create_contact
Create a contact
Create a contact. HappyFox treats this as create-or-edit keyed on email: if the email already exists that contact is updated, and any contact custom field NOT passed is reset — use happyfox_update_contact to edit an existing contact. HappyFox: POST /api/1.1/json/users/.
输入参数name必填email必填phonescustom_fields
happyfox_update_contact
Edit a contact
Edit an existing contact's name, email or contact custom fields (c-cf-<id>). Phone numbers are edited via happyfox_create_contact with the phone id. HappyFox: POST /api/1.1/json/user/<id>/.
输入参数nameemailcontact_id必填custom_fields
