Actions & Endpoints


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:



List Agents

GET <example>

List all agents (users) matching the supplied parameters

Get Agent

GET <example>{agent_id}

Get an agent (user) by ID


List Companies

GET <example>

List all companies

Search Companies

GET <example>

Search for a company using its name

Filter Companies

GET <example>

(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>{company_id}

Get a company by ID

Create Company

POST <example>

Adds a new company in Freshdesk

Update Company

PUT <example>{company_id}

Updates a company by ID

Delete Company

DELETE <example>{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.


List Contacts

GET <example>

List all contacts, use filters to view only specific contacts

Search Contacts

GET <example>

Search for a contact using their name

Filter contacts

GET <example>

(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>{contact_id}

Get a contact by ID

Create Contact

POST <example>

Adds a new contact record

Update Contact

PUT <example>{contact_id}

Update a contact by ID

Soft Delete Contact

DELETE <example>{contact_id}

Soft delete a contact by ID

Permanently Delete Contact

DELETE <example>{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>{contact_id}/restore

Used to restore contacts that have been soft-deleted from a Freshdesk account

Send Invite to a Contact

PUT <example>{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>{contact_id}/make_agent

Makes a new Agent for an existing Contact


Create Reply

POST <example>{ticket_id}/reply

Create a reply to a ticket or conversation

Create Note

POST <example>{ticket_id}/notes

Create a note for a ticket

Generic Request

Freshdesk API Request

GET <example><url_path>

Generic action for making authenticated requests against the Freshdesk API


List Groups

GET <example>

List all groups

Get Group

GET <example>{group_id}

Get a single group by ID


List Roles

GET <example>

List all roles

Get Role

GET <example>{role_id}

Get a single role by ID


List Skills

GET <example>

List all skills

Get Skill

GET <example>{skill_id}

Get a single skill by ID


Create Ticket

POST <example>

Create Freshdesk Ticket

List Tickets

GET <example>

List Freshdesk Tickets

Get Ticket

GET <example>{ticket_id}

Get Freshdesk Ticket

Update Ticket

PUT <example>{ticket_id}

Update Freshdesk Ticket

Time Entries

List Time Entries

GET <example>

List all time entries created by agents. Use filters to view only specific time entries.

Create a Time Entry

POST <example>{ticket_id}/time_entries

Adds a new time entry to a given ticket

Update Time Entry

PUT <example>{time_entry_id}

Update a single time entry by ID

Toggle Time Entry Timer

PUT <example>{time_entry_id}/toggle_timer

Start or stop the timer for a given time entry

Delete Time Entry

DELETE <example>{time_entry_id}

Permanently deletes a given time entry, note that once deleted time entries cannot be restored.

Last updated