freshdesk-api

Build integrations with the Freshdesk REST API v2 for tickets, contacts, and companies.

1|Updated May 6, 2026
One-click install
npx skills add https://github.com/surfingalien/FinSurfing --skill freshdesk-api-surfingalien
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: freshdesk-api
Source: https://github.com/surfingalien/FinSurfing/tree/main/.claude/skills/freshdesk-api
Command: npx skills add https://github.com/surfingalien/FinSurfing --skill freshdesk-api-surfingalien

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Working with the Freshdesk helpdesk API requires knowing its authentication scheme, rate limits, pagination rules, search syntax, and status/priority codes. This Skill provides complete operational guidance for building integrations, extracting support data, and automating ticket workflows without digging through scattered documentation. ## Core Features & Use Cases - Ticket Management: Create, update, search, and bulk-update tickets with conversations, time entries, and satisfaction ratings. - Contact & Company Operations: Full CRUD, merging, CRM sync via external IDs, and search across contacts and companies. - Webhooks & Automation: Configure event-driven webhooks for ticket creation, status changes, and replies with signature verification examples. - Use Case: Export all resolved tickets from the last month, compute average resolution time with jq, and push a summary to Slack via a webhook handler. ## Quick Start Ask the assistant to list all open high-priority tickets from your Freshdesk domain using your API key.

Frequently Asked Questions about freshdesk-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I authenticate with the Freshdesk API?

Freshdesk uses HTTP Basic Authentication with your API key as the username and X as the password. Find your API key under Profile Settings in the Freshdesk admin portal, then pass it via curl -u or a Base64-encoded Authorization header.

How do I search Freshdesk tickets by status and priority?

Use the Search API endpoint /api/v2/search/tickets with a query parameter like "status:2 AND priority:3". Status values are 2 (Open), 3 (Pending), 4 (Resolved), 5 (Closed); priority ranges from 1 (Low) to 4 (Urgent).

How do I handle Freshdesk API rate limits?

Monitor the X-Ratelimit-Remaining header on every response and retry HTTP 429 errors with exponential backoff. Note that include parameters consume extra API credits, so embedding requester and company data costs 3 credits per call.

Does Freshdesk support webhooks for ticket events?

Yes, configure webhooks under Admin → Automations for ticket creation and update events. Webhooks are limited to 1000 per hour, retry every 30 minutes on failure, and payloads can be verified with an HMAC-SHA256 signature.

What SDKs are available for the Freshdesk API?

Community SDKs exist for Python (python-freshdesk), Node.js (node-freshdesk-api), and Ruby (freshdesk-ruby). For PHP, Java, and TypeScript, you can call the REST API directly with standard HTTP clients as shown in the reference examples.

How do I paginate through all Freshdesk tickets?

Use the page and per_page parameters with per_page set to the maximum of 100, incrementing page until an empty array is returned. Responses also include a Link header with a rel="next" URL for navigation.