Get ticket with the Freshdesk API
Returns 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.
- Identifier
- freshdesk_get_ticket
The request
POST https://connect.reportei.com/api/tools/freshdesk_get_ticket/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"ticket_id": 1
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| ticket_id | integer | Yes | Id of the ticket, from List tickets or Search tickets. |
| include | string | No | Comma-separated extras: conversations (up to ten, oldest first), requester (email, id, mobile, name and phone), company (id and name) and stats (closed, resolved and first response times). Each one costs more API credits. |
Supported connections
Your customer connects their Freshdesk account once, with one of the modes below. The same connection serves every tool of the toolkit.
Username and password
Your customer enters the app credentials on a Connect screen, or your system sends them with POST /api/customer-toolkits, with no screen.
When connecting, your customer also enters {domain}: the address of their account on the app's API.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/freshdesk_get_ticket. It becomes your agent's tool definition with no conversion.
Other Freshdesk tools
- 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.
- 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.
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.
