Skip to content
Talk to an Engineer Dashboard

Freshdesk

Connect to Freshdesk. Manage tickets, contacts, companies, and customer support workflows

Connect to Freshdesk. Manage tickets, contacts, companies, and customer support workflows

Freshdesk logo

Supports authentication: Basic Auth

Create a new agent in Freshdesk. Email is required and must be unique. Agent will receive invitation email to set up account. At least one role must be assigned.

NameTypeRequiredDescription
agent_typenumberNoType of agent (1=Support Agent, 2=Field Agent, 3=Collaborator)
emailstringYesEmail address of the agent (must be unique)
focus_modebooleanNoFocus mode setting for the agent
group_idsarray<number>NoArray of group IDs to assign the agent to
languagestringNoLanguage preference of the agent
namestringNoFull name of the agent
occasionalbooleanNoWhether the agent is occasional (true) or full-time (false)
role_idsarray<number>YesArray of role IDs to assign to the agent (at least one required)
signaturestringNoAgent email signature in HTML format
skill_idsarray<number>NoArray of skill IDs to assign to the agent
ticket_scopenumberYesTicket permission level (1=Global Access, 2=Group Access, 3=Restricted Access)
time_zonestringNoTime zone of the agent

Delete an agent from Freshdesk. This action is irreversible and will remove the agent from the system. The agent will no longer have access to the helpdesk and all associated data will be permanently deleted.

NameTypeRequiredDescription
agent_idnumberYesID of the agent to delete

Retrieve a list of agents from Freshdesk with filtering options. Returns agent details including IDs, contact information, roles, and availability status. Supports pagination with up to 100 agents per page.

NameTypeRequiredDescription
emailstringNoFilter agents by email address
mobilestringNoFilter agents by mobile number
pagenumberNoPage number for pagination (starts from 1)
per_pagenumberNoNumber of agents per page (max 100)
phonestringNoFilter agents by phone number
statestringNoFilter agents by state (fulltime or occasional)

Create a new contact in Freshdesk. Email and name are required. Supports custom fields, company assignment, and contact segmentation.

NameTypeRequiredDescription
addressstringNoAddress of the contact
company_idnumberNoCompany ID to associate with the contact
custom_fieldsobjectNoKey-value pairs for custom field values
descriptionstringNoDescription about the contact
emailstringYesEmail address of the contact
job_titlestringNoJob title of the contact
languagestringNoLanguage preference of the contact
mobilestringNoMobile number of the contact
namestringYesFull name of the contact
phonestringNoPhone number of the contact
tagsarray<string>NoArray of tags to associate with the contact
time_zonestringNoTime zone of the contact

Retrieve a list of all roles from Freshdesk. Returns role details including IDs, names, descriptions, default status, and timestamps. This endpoint provides information about the different permission levels and access controls available in the Freshdesk system.

Create a new ticket in Freshdesk. Requires either requester_id, email, facebook_id, phone, twitter_id, or unique_external_id to identify the requester.

NameTypeRequiredDescription
cc_emailsarray<string>NoArray of email addresses to be added in CC
custom_fieldsobjectNoKey-value pairs containing custom field names and values
descriptionstringNoHTML content of the ticket describing the issue
emailstringNoEmail address of the requester. If no contact exists, will be added as new contact.
group_idnumberNoID of the group to which the ticket has been assigned
namestringNoName of the requester
prioritynumberNoPriority of the ticket. 1=Low, 2=Medium, 3=High, 4=Urgent
requester_idnumberNoUser ID of the requester. For existing contacts, can be passed instead of email.
responder_idnumberNoID of the agent to whom the ticket has been assigned
sourcenumberNoChannel through which ticket was created. 1=Email, 2=Portal, 3=Phone, 7=Chat, 9=Feedback Widget, 10=Outbound Email
statusnumberNoStatus of the ticket. 2=Open, 3=Pending, 4=Resolved, 5=Closed
subjectstringNoSubject of the ticket
tagsarray<string>NoArray of tags to be associated with the ticket
typestringNoHelps categorize the ticket according to different kinds of issues

Retrieve details of a specific ticket by ID. Includes ticket properties, conversations, and metadata.

NameTypeRequiredDescription
includestringNoAdditional resources to include (stats, requester, company, conversations)
ticket_idnumberYesID of the ticket to retrieve

Update an existing ticket in Freshdesk. Note: Subject and description of outbound tickets cannot be updated.

NameTypeRequiredDescription
custom_fieldsobjectNoKey-value pairs containing custom field names and values
descriptionstringNoHTML content of the ticket (cannot be updated for outbound tickets)
group_idnumberNoID of the group to which the ticket has been assigned
namestringNoName of the requester
prioritynumberNoPriority of the ticket. 1=Low, 2=Medium, 3=High, 4=Urgent
responder_idnumberNoID of the agent to whom the ticket has been assigned
statusnumberNoStatus of the ticket. 2=Open, 3=Pending, 4=Resolved, 5=Closed
subjectstringNoSubject of the ticket (cannot be updated for outbound tickets)
tagsarray<string>NoArray of tags to be associated with the ticket
ticket_idnumberYesID of the ticket to update

Retrieve a list of tickets with filtering and pagination. Supports filtering by status, priority, requester, and more. Returns 30 tickets per page by default.

NameTypeRequiredDescription
company_idnumberNoFilter by company ID
emailstringNoFilter by requester email
filterstringNoFilter name (new_and_my_open, watching, spam, deleted)
includestringNoAdditional resources to include (description, requester, company, stats)
pagenumberNoPage number for pagination (starts from 1)
per_pagenumberNoNumber of tickets per page (max 100)
requester_idnumberNoFilter by requester ID
updated_sincestringNoFilter tickets updated since this timestamp (ISO 8601)

Add a public reply to a ticket conversation. The reply will be visible to the customer and will update the ticket status if specified.

NameTypeRequiredDescription
bcc_emailsarray<string>NoArray of email addresses to BCC on the reply
bodystringYesHTML content of the reply
cc_emailsarray<string>NoArray of email addresses to CC on the reply
from_emailstringNoEmail address to send the reply from
ticket_idnumberYesID of the ticket to reply to
user_idnumberNoID of the agent sending the reply