{ "opencollection": "1.0.0", "info": { "name": "Freshdesk REST Agents Tickets API", "version": "2.0" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Tickets", "type": "folder" }, "items": [ { "info": { "name": "List all tickets", "type": "http" }, "http": { "method": "GET", "url": "https://{domain}.freshdesk.com/api/v2/tickets", "params": [ { "name": "page", "value": "", "type": "query", "description": "Page number for paginated results." }, { "name": "per_page", "value": "", "type": "query", "description": "Number of results per page (max 100)." }, { "name": "filter", "value": "", "type": "query", "description": "Pre-defined filter to apply. Options include new_and_my_open, watching, spam, deleted." }, { "name": "requester_id", "value": "", "type": "query", "description": "Filter tickets by requester ID." }, { "name": "email", "value": "", "type": "query", "description": "Filter tickets by requester email address." }, { "name": "updated_since", "value": "", "type": "query", "description": "Return tickets updated since the given date-time in UTC format." }, { "name": "order_by", "value": "", "type": "query", "description": "Field to order results by." }, { "name": "order_type", "value": "", "type": "query", "description": "Sort direction for results." }, { "name": "include", "value": "", "type": "query", "description": "Include additional information such as requester, stats, or description." } ] }, "docs": "Retrieves a paginated list of tickets from the helpdesk. By default, only tickets that have not been deleted or marked as spam are returned. Use filter query parameters to narrow results by status, requester, agent, group, or updated date." }, { "info": { "name": "Create a ticket", "type": "http" }, "http": { "method": "POST", "url": "https://{domain}.freshdesk.com/api/v2/tickets", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new support ticket. At minimum, a requester identifier (email, phone, requester_id, or twitter_id) and a subject or description must be provided." }, { "info": { "name": "View a ticket", "type": "http" }, "http": { "method": "GET", "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id", "params": [ { "name": "ticket_id", "value": "", "type": "path", "description": "Unique identifier of the ticket." }, { "name": "include", "value": "", "type": "query", "description": "Include additional information in the response." } ] }, "docs": "Retrieves the details of a specific ticket by its ID, including all standard and custom fields." }, { "info": { "name": "Update a ticket", "type": "http" }, "http": { "method": "PUT", "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id", "params": [ { "name": "ticket_id", "value": "", "type": "path", "description": "Unique identifier of the ticket." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of an existing ticket. Only the fields provided in the request body will be updated." }, { "info": { "name": "Delete a ticket", "type": "http" }, "http": { "method": "DELETE", "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id", "params": [ { "name": "ticket_id", "value": "", "type": "path", "description": "Unique identifier of the ticket." } ] }, "docs": "Soft-deletes a ticket, moving it to the trash. The ticket can be restored later using the restore endpoint." }, { "info": { "name": "Restore a deleted ticket", "type": "http" }, "http": { "method": "PUT", "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id/restore", "params": [ { "name": "ticket_id", "value": "", "type": "path", "description": "Unique identifier of the ticket." } ] }, "docs": "Restores a previously soft-deleted ticket from the trash." }, { "info": { "name": "Create an outbound email ticket", "type": "http" }, "http": { "method": "POST", "url": "https://{domain}.freshdesk.com/api/v2/tickets/outbound_email", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new outbound email ticket, allowing agents to initiate email conversations with customers." }, { "info": { "name": "List watchers on a ticket", "type": "http" }, "http": { "method": "GET", "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id/watchers", "params": [ { "name": "ticket_id", "value": "", "type": "path", "description": "Unique identifier of the ticket." } ] }, "docs": "Retrieves the list of agents watching the specified ticket." }, { "info": { "name": "Watch a ticket", "type": "http" }, "http": { "method": "POST", "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id/watch", "params": [ { "name": "ticket_id", "value": "", "type": "path", "description": "Unique identifier of the ticket." } ] }, "docs": "Adds the authenticated agent as a watcher on the specified ticket." }, { "info": { "name": "List associated tickets", "type": "http" }, "http": { "method": "GET", "url": "https://{domain}.freshdesk.com/api/v2/tickets/:ticket_id/associated_tickets", "params": [ { "name": "ticket_id", "value": "", "type": "path", "description": "Unique identifier of the ticket." } ] }, "docs": "Retrieves tickets associated with the specified tracker ticket." }, { "info": { "name": "Merge tickets", "type": "http" }, "http": { "method": "PUT", "url": "https://{domain}.freshdesk.com/api/v2/tickets/merge", "body": { "type": "json", "data": "{}" } }, "docs": "Merges one or more secondary tickets into a primary ticket. The secondary tickets are closed and their conversations are added to the primary ticket." }, { "info": { "name": "Bulk update tickets", "type": "http" }, "http": { "method": "POST", "url": "https://{domain}.freshdesk.com/api/v2/tickets/bulk_update", "body": { "type": "json", "data": "{}" } }, "docs": "Updates properties on multiple tickets at once." }, { "info": { "name": "Bulk delete tickets", "type": "http" }, "http": { "method": "POST", "url": "https://{domain}.freshdesk.com/api/v2/tickets/bulk_delete", "body": { "type": "json", "data": "{}" } }, "docs": "Soft-deletes multiple tickets at once, moving them to the trash." }, { "info": { "name": "List all ticket fields", "type": "http" }, "http": { "method": "GET", "url": "https://{domain}.freshdesk.com/api/v2/ticket_fields" }, "docs": "Retrieves all default and custom ticket fields." } ] } ], "bundled": true }