Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Freshdesk

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.

PropertiesDescriptionType
agent_typeType of agent (1=Support Agent, 2=Field Agent, 3=Collaborator)number
emailEmail address of the agent (must be unique)string
focus_modeFocus mode setting for the agentboolean
group_idsArray of group IDs to assign the agent toarray<number>
languageLanguage preference of the agentstring
nameFull name of the agentstring
occasionalWhether the agent is occasional (true) or full-time (false)boolean
role_idsArray of role IDs to assign to the agent (at least one required)array<number>
signatureAgent email signature in HTML formatstring
skill_idsArray of skill IDs to assign to the agentarray<number>
ticket_scopeTicket permission level (1=Global Access, 2=Group Access, 3=Restricted Access)number
time_zoneTime zone of the agentstring

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.

PropertiesDescriptionType
agent_idID of the agent to deletenumber

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.

PropertiesDescriptionType
emailFilter agents by email addressstring
mobileFilter agents by mobile numberstring
pagePage number for pagination (starts from 1)number
per_pageNumber of agents per page (max 100)number
phoneFilter agents by phone numberstring
stateFilter agents by state (fulltime or occasional)string

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

PropertiesDescriptionType
addressAddress of the contactstring
company_idCompany ID to associate with the contactnumber
custom_fieldsKey-value pairs for custom field valuesobject
descriptionDescription about the contactstring
emailEmail address of the contactstring
job_titleJob title of the contactstring
languageLanguage preference of the contactstring
mobileMobile number of the contactstring
nameFull name of the contactstring
phonePhone number of the contactstring
tagsArray of tags to associate with the contactarray<string>
time_zoneTime zone of the contactstring

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.

PropertiesDescriptionType
cc_emailsArray of email addresses to be added in CCarray<string>
custom_fieldsKey-value pairs containing custom field names and valuesobject
descriptionHTML content of the ticket describing the issuestring
emailEmail address of the requester. If no contact exists, will be added as new contact.string
group_idID of the group to which the ticket has been assignednumber
nameName of the requesterstring
priorityPriority of the ticket. 1=Low, 2=Medium, 3=High, 4=Urgentnumber
requester_idUser ID of the requester. For existing contacts, can be passed instead of email.number
responder_idID of the agent to whom the ticket has been assignednumber
sourceChannel through which ticket was created. 1=Email, 2=Portal, 3=Phone, 7=Chat, 9=Feedback Widget, 10=Outbound Emailnumber
statusStatus of the ticket. 2=Open, 3=Pending, 4=Resolved, 5=Closednumber
subjectSubject of the ticketstring
tagsArray of tags to be associated with the ticketarray<string>
typeHelps categorize the ticket according to different kinds of issuesstring

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

PropertiesDescriptionType
includeAdditional resources to include (stats, requester, company, conversations)string
ticket_idID of the ticket to retrievenumber

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

PropertiesDescriptionType
custom_fieldsKey-value pairs containing custom field names and valuesobject
descriptionHTML content of the ticket (cannot be updated for outbound tickets)string
group_idID of the group to which the ticket has been assignednumber
nameName of the requesterstring
priorityPriority of the ticket. 1=Low, 2=Medium, 3=High, 4=Urgentnumber
responder_idID of the agent to whom the ticket has been assignednumber
statusStatus of the ticket. 2=Open, 3=Pending, 4=Resolved, 5=Closednumber
subjectSubject of the ticket (cannot be updated for outbound tickets)string
tagsArray of tags to be associated with the ticketarray<string>
ticket_idID of the ticket to updatenumber

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

PropertiesDescriptionType
company_idFilter by company IDnumber
emailFilter by requester emailstring
filterFilter name (new_and_my_open, watching, spam, deleted)string
includeAdditional resources to include (description, requester, company, stats)string
pagePage number for pagination (starts from 1)number
per_pageNumber of tickets per page (max 100)number
requester_idFilter by requester IDnumber
updated_sinceFilter tickets updated since this timestamp (ISO 8601)string

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

PropertiesDescriptionType
bcc_emailsArray of email addresses to BCC on the replyarray<string>
bodyHTML content of the replystring
cc_emailsArray of email addresses to CC on the replyarray<string>
from_emailEmail address to send the reply fromstring
ticket_idID of the ticket to reply tonumber
user_idID of the agent sending the replynumber