Actions (61)
Tickets · 23
- Add staff private notePOST /api/1.1/json/ticket/{ticket_number}/staff_pvtnote/
Add a private note on a ticket for staff.
documented - Add user replyPOST /api/1.1/json/ticket/{ticket_number}/user_reply/
Add a public reply from the ticket requester.
documented - Create multiple ticketsPOST /api/1.1/json/tickets/
Create several tickets in a single request.
documented - Create ticketPOST /api/1.1/json/tickets/
Create a new ticket.
documented - Delete ticketPOST /api/1.1/json/ticket/{ticket_number}/delete/
Delete the ticket.
documented - Forward ticketPOST /api/1.1/json/ticket/{ticket_number}/forward/
Forward a ticket to an external email address.
documented - Get ticket detailsGET /api/1.1/json/ticket/{ticket_number}/
Retrieve details for a specific ticket.
documented - List categoriesGET /api/1.1/json/categories/
List ticket categories available for routing.
documented - List prioritiesGET /api/1.1/json/priorities/
List ticket priorities.
documented - List prioritiesGET /api/1.1/json/priorities/
Read ticket priorities.
documented - List staffGET /api/1.1/json/staff/
List HappyFox staff/agents.
documented - List staffGET /api/1.1/json/staff/
List HappyFox staff/agents.
documented - List statusesGET /api/1.1/json/statuses/
List ticket statuses.
documented - List ticket custom fieldsGET /api/1.1/json/ticket_custom_fields/
Metadata for all ticket custom fields.
documented - List ticketsGET /api/1.1/json/tickets/
Return a list of all tickets.
documented - List tickets (paginated)GET /api/1.1/json/tickets/?size={size}&page={page}
Return tickets in a paginated fashion.
documented - Move ticketPOST /api/1.1/json/ticket/{ticket_number}/move/
Move the ticket to another category.
documented - Show ticket custom field changesGET /api/1.1/json/ticket/{ticket_number}/?show_cf_changes=true
Return a ticket along with its CF change history.
documented - Subscribe to ticketPOST /api/1.1/json/ticket/{ticket_number}/subscribe/
Subscribe a staff member to receive ticket updates.
documented - Unsubscribe from ticketPOST /api/1.1/json/ticket/{ticket_number}/unsubscribe/
Unsubscribe a staff member from ticket updates.
documented - Update ticket custom fieldsPOST /api/1.1/json/ticket/{ticket_number}/update_custom_fields/
Update values of ticket custom fields.
documented - Update ticket propertiesPOST /api/1.1/json/ticket/{ticket_number}/staff_update/
Update status, priority, assignee, etc., for a ticket.
documented - Update ticket tagsPOST /api/1.1/json/ticket/{ticket_number}/update_tags/
Add or remove tags on a ticket.
documented
Contacts · 16
- Add/Edit contacts in a contact groupPOST /api/1.1/json/contact_group/{group_id}/update_contacts/
Add/edit multiple contacts in a contact group.
documented - Create contact groupPOST /api/1.1/json/contact_groups/
Create a new contact group.
documented - Create or update contactPOST /api/1.1/json/users/
Create a new contact or update an existing one.
documented - Create or update multiple contactsPOST /api/1.1/json/users/
Add/edit multiple contacts in a single request.
documented - Delete contacts from groupPOST /api/1.1/json/contact_group/{group_id}/delete_contacts/
Remove contacts from a contact group.
documented - Edit contact by idPOST /api/1.1/json/user/{id}/
Edit a single contact by its ID.
documented - Edit contact groupPOST /api/1.1/json/contact_group/{group_id}/
Edit a contact group.
documented - Get contact by emailGET /api/1.1/json/user/{email_address}/
Retrieve a contact by email address.
documented - Get contact by idGET /api/1.1/json/user/{id}/
Retrieve a contact by internal ID.
documented - Get contact group detailsGET /api/1.1/json/contact_group/{group_id}/
Get details for a specific contact group.
documented - List contact custom fieldsGET /api/1.1/json/user_custom_fields/
Metadata for all contact custom fields.
documented - List contact groupsGET /api/1.1/json/contact_groups/
List all contact groups.
documented - List contactsGET /api/1.1/json/users/
Read contacts.
documented - List contactsGET /api/1.1/json/users/
List contacts (ticket requesters).
documented - List contacts (paginated)GET /api/1.1/json/users/?size={size}&page={page}
Paginated list of contacts.
documented - Update contact primary phonePOST /api/1.1/json/user/{id}/
Update primary phone for a contact.
documented
Assets · 9
- Asset type detailsGET /api/1.1/json/asset_type/{asset_type_id}/
Read details for a single asset type.
documented - Create assetPOST /api/1.1/json/assets/?asset_type={asset_type_id}
Create a new asset in a specific asset type.
documented - Delete assetDELETE /api/1.1/json/asset/{asset_id}/
Delete an asset.
documented - Get assetGET /api/1.1/json/asset/{asset_id}/
Read a single asset by its backend ID.
documented - List all asset custom fieldsGET /api/1.1/json/asset_custom_fields/
Metadata for all asset custom fields.
documented - List asset custom fieldsGET /api/1.1/json/assets/?asset_type={asset_type_id}
List custom fields for assets (per asset type).
documented - List asset typesGET /api/1.1/json/asset_types/
Read all asset types.
documented - List assetsGET /api/1.1/json/assets/?asset_type={asset_type_id}&size={size}&page={page}
Paginated list of assets filtered by asset type.
documented - Update assetPUT /api/1.1/json/asset/{asset_id}/
Update an existing asset.
documented
Reports · 8
- List reportsGET /api/1.1/json/reports/
Read list of available reports.
documented - View SLA performanceGET /api/1.1/json/report/{report_id}/sla-perf/
Read SLA performance data for a report.
documented - View contact activityGET /api/1.1/json/report/{report_id}/contactactivity/
Read contact activity data for a report.
documented - View report summaryGET /api/1.1/json/report/{report_id}/
View the summary for a given report.
documented - View response statsGET /api/1.1/json/report/{report_id}/responsestats/
Read response statistics for a report.
documented - View staff activityGET /api/1.1/json/report/{report_id}/staffactivity/
Read staff activity data for a report.
documented - View staff performanceGET /api/1.1/json/report/{report_id}/staffperformance/
Read staff performance data for a report.
documented - View tabular dataGET /api/1.1/json/report/{report_id}/tabulardata/
Read the tabular data for a report.
documented
Knowledge Base · 5
- Get KB articleGET /api/1.1/json/kb/article/{article_id}/
Export a single external KB article.
documented - Get KB sectionGET /api/1.1/json/kb/section/{section_id}/
Export a single KB section.
documented - List KB sectionsGET /api/1.1/json/kb/sections/
Read Knowledge Base sections.
documented - List external KB articlesGET /api/1.1/json/kb/articles/
Read external Knowledge Base articles.
documented - List internal KB articlesGET /api/1.1/json/kb/internal-articles/
Read internal Knowledge Base articles.
documented