Actions & Endpoints
Introduction
The Freshdesk Integration with Rewst delivers a robust set of actions and endpoints for interacting with Freshdesk. Below is a summary of each section, highlighting the diverse capabilities and opportunities provided through the Freshdesk Integration:
Actions
Agents
List Agents
GET <example>.freshdesk.com/agents
List all agents (users) matching the supplied parameters
Get Agent
GET <example>.freshdesk.com/agents/{agent_id}
Get an agent (user) by ID
Companies
List Companies
GET <example>.freshdesk.com/companies
List all companies
Search Companies
GET <example>.freshdesk.com/companies/autocomplete
Search for a company using its name
Filter Companies
GET <example>.freshdesk.com/search/companies
(Beta) Use custom company fields that you have created in your account to filter through the companies and get a list of companies matching the specified company fields
Get Company
GET <example>.freshdesk.com/companies/{company_id}
Get a company by ID
Create Company
POST <example>.freshdesk.com/companies
Adds a new company in Freshdesk
Update Company
PUT <example>.freshdesk.com/companies/{company_id}
Updates a company by ID
Delete Company
DELETE <example>.freshdesk.com/companies/{company_id}
Deletes a company by ID, once deleted a company cannot be restored. Deleting a company does not delete the contacts that are associated with it.
Contacts
List Contacts
GET <example>.freshdesk.com/contacts
List all contacts, use filters to view only specific contacts
Search Contacts
GET <example>.freshdesk.com/contacts/autocomplete
Search for a contact using their name
Filter contacts
GET <example>.freshdesk.com/search/contacts
(Beta) Use custom contact fields that you have created in your account to filter through the contacts and get a list of contacts matching the specified contact fields
Get Contact
GET <example>.freshdesk.com/contacts/{contact_id}
Get a contact by ID
Create Contact
POST <example>.freshdesk.com/contacts
Adds a new contact record
Update Contact
PUT <example>.freshdesk.com/contacts/{contact_id}
Update a contact by ID
Soft Delete Contact
DELETE <example>.freshdesk.com/contacts/{contact_id}
Soft delete a contact by ID
Permanently Delete Contact
DELETE <example>.freshdesk.com/contacts/{contact_id}/hard_delete
Hard delete a contact to completely remove it from the portal. Can be used for GDPR compliance.
Restore Contact
PUT <example>.freshdesk.com/contacts/{contact_id}/restore
Used to restore contacts that have been soft-deleted from a Freshdesk account
Send Invite to a Contact
PUT <example>.freshdesk.com/contacts/{contact_id}/send_invite
Used to send an activation email to an existing contact for email verification. Once the activation is complete, these contacts can log in to the customer portal using their password and check the status of their tickets.
Convert Contact to Agent
PUT <example>.freshdesk.com/contacts/{contact_id}/make_agent
Makes a new Agent for an existing Contact
Conversations
Create Reply
POST <example>.freshdesk.com/tickets/{ticket_id}/reply
Create a reply to a ticket or conversation
Create Note
POST <example>.freshdesk.com/tickets/{ticket_id}/notes
Create a note for a ticket
Generic Request
Freshdesk API Request
GET <example>.freshdesk.com/<url_path>
Generic action for making authenticated requests against the Freshdesk API
Groups
List Groups
GET <example>.freshdesk.com/groups
List all groups
Get Group
GET <example>.freshdesk.com/groups/{group_id}
Get a single group by ID
Roles
List Roles
GET <example>.freshdesk.com/roles
List all roles
Get Role
GET <example>.freshdesk.com/roles/{role_id}
Get a single role by ID
Skills
List Skills
GET <example>.freshdesk.com/skills
List all skills
Get Skill
GET <example>.freshdesk.com/skills/{skill_id}
Get a single skill by ID
Tickets
Create Ticket
POST <example>.freshdesk.com/tickets
Create Freshdesk Ticket
List Tickets
GET <example>.freshdesk.com/tickets
List Freshdesk Tickets
Get Ticket
GET <example>.freshdesk.com/tickets/{ticket_id}
Get Freshdesk Ticket
Update Ticket
PUT <example>.freshdesk.com/tickets/{ticket_id}
Update Freshdesk Ticket
Time Entries
List Time Entries
GET <example>.freshdesk.com/time_entries
List all time entries created by agents. Use filters to view only specific time entries.
Create a Time Entry
POST <example>.freshdesk.com/tickets/{ticket_id}/time_entries
Adds a new time entry to a given ticket
Update Time Entry
PUT <example>.freshdesk.com/time_entries/{time_entry_id}
Update a single time entry by ID
Toggle Time Entry Timer
PUT <example>.freshdesk.com/time_entries/{time_entry_id}/toggle_timer
Start or stop the timer for a given time entry
Delete Time Entry
DELETE <example>.freshdesk.com/time_entries/{time_entry_id}
Permanently deletes a given time entry, note that once deleted time entries cannot be restored.
Last updated
