Freshdesk tools
The 13 Freshdesk operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List ticketsGETLists tickets, newest first by default. Without updated_since only tickets created in the last 30 days come back, and spam or deleted tickets only come with filter. Pages are numbered from 1, up to page 300; a page with fewer tickets than per_page is the last one.
- Search ticketsGETSearches tickets with a filter query, for example by status, priority, agent, group, tag or a custom field. Returns total and results, 30 tickets per page, up to page 10. Archived tickets are left out, and changes take a few minutes to show up.
- Get ticketGETReturns one ticket with its status, priority, requester_id, responder_id, group_id, tags, custom_fields and description. The requester email, company name and conversations only come through include.
- Create ticketPOSTCreates a ticket. Identify the requester with requester_id, email, phone or unique_external_id; an email or phone not yet in Freshdesk creates the contact. Fields marked required_for_agents in List ticket fields must be sent too, or Freshdesk refuses the ticket.
- Update ticketPUTUpdates a ticket: send only the fields to change, and tags as the full list the ticket should keep. Status 4 resolves and 5 closes it, and closing needs the fields marked required_for_closure in List ticket fields. Spam or deleted tickets return 405, and outbound tickets keep their subject and description.
- List ticket conversationsGETLists the replies and notes of a ticket, with body (HTML), body_text, private, incoming, user_id and source (0 reply, 2 note). Pages are numbered from 1; a page with fewer items than per_page is the last one.
- Create ticket replyPOSTReplies to the requester of a ticket. Freshdesk emails the reply to the requester, so it is visible to the customer. Tickets from web chat or the mobile SDK take structured content instead of body, which this tool does not send.
- Create ticket notePOSTAdds a note to a ticket. Notes are private by default, visible only to agents; with private false the requester can see it too.
- List ticket fieldsGETLists the ticket fields of the helpdesk with their choices: agent ids in the agent field, group ids in the group field, product ids, status values including custom ones, ticket types, and the name of each custom field, which is its key in custom_fields. required_for_agents and required_for_closure mark the fields create, update and closing need.
- List contactsGETLists contacts, the customers who raise tickets, with id, name, email, phone, mobile, company_id, tags and custom_fields. Filters combine, and only unblocked and undeleted contacts come by default. Pages are numbered from 1; a page with fewer contacts than per_page is the last one.
- Create contactPOSTCreates a contact. name is mandatory, plus at least one of email, phone, mobile or unique_external_id. An email address that already belongs to a contact returns 409.
- Update contactPUTUpdates a contact: send only the fields to change, and tags and other_emails as the full lists the contact should keep. Blocked or deleted contacts return 405.
- Search companiesGETFinds companies by name and returns the id and name of each, the company_id that tickets and contacts take.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
