Macha

How to Find Your Freshdesk API Key

Abbas, Customer Support & AI, Macha

Written by

Ankeet Guha, Co-founder & CTO, Macha

Reviewed by

Published July 24, 2026

Updated July 24, 2026

Your Freshdesk API key is the credential that lets a script, an integration, or an AI layer read and write the same tickets your agents work in — and it lives in a slightly surprising place: your own agent profile, not an admin console. That's because the key is tied to you, the individual agent, and inherits your permissions. This guide walks the exact click-path to reveal it, explains why Freshdesk hides the value behind a reCAPTCHA, shows how to actually use the key for HTTP Basic authentication, and covers the security hygiene — resetting, per-agent scoping, and rotation — that keeps a leaked key from becoming a real problem.

How to Find Your Freshdesk API Key

Where the API key actually lives

The first thing to understand is that in Freshdesk the API key is a per-agent credential, not an account-wide one you generate in an admin panel. Each agent has their own key, and any request made with it runs with that agent's role and permissions. Per Freshworks' How To Find Your API Key documentation, an agent with a restricted role will find the API scoped to exactly what that role can see and do — so a key belonging to a limited agent won't quietly hand out admin-level access.

This design has a nice consequence and an awkward one. The nice part: you can hand different integrations different agents' keys and each one is naturally sandboxed to that agent's scope. The awkward part: people go looking under Admin and can't find anything, because it isn't there.

Step 1: Open your Profile Settings and reveal the key

Here's the exact path. It's the same on the current Freshdesk plans and the older Blossom/Garden/Estate/Forest tiers.

  1. Log in to your Freshdesk support portal as the agent whose key you want.
  2. Click your profile picture in the top-right corner.
  3. Select Profile Settings.
  4. In the right-hand pane, click the View API key button.
  5. Complete the reCAPTCHA verification when prompted.
  6. Copy the revealed key and store it somewhere safe.

That reCAPTCHA step is deliberate, not a glitch. Freshdesk gates the reveal of the key value behind a human-verification challenge so that a hijacked browser session or an automated scraper can't silently lift the credential just by loading the settings page. It's a small friction that meaningfully raises the bar on casual theft.

The agent Profile Settings page in Freshdesk (demousermacha), where an agent finds their API key. The 'View API Key' button is top-right; Freshdesk gates the actual key reveal behind a reCAPTCHA confirmation, so the key value itself is not shown.
The agent Profile Settings page in Freshdesk (demousermacha), where an agent finds their API key. The 'View API Key' button is top-right; Freshdesk gates the actual key reveal behind a reCAPTCHA confirmation, so the key value itself is not shown.

As the caption notes, the screenshot above shows the View API Key button in place but not the key itself — that's the real, expected UX. Freshdesk only renders the actual string after you clear the reCAPTCHA, so there's nothing to see (and nothing you should ever paste into a screenshot, a ticket, or a chat message).

Step 2: Use the key to authenticate

Freshdesk's REST API v2 uses plain HTTP Basic Authentication. You pass your API key as the username and any non-empty string — conventionally the single character X — as the password. There's no OAuth 2.0 handshake for the v2 API; the key is your credential. The Freshworks developer API reference documents the base URL as https://<your-domain>.freshdesk.com/api/v2/.

A quick test to confirm the key works — fetching the first page of tickets:

curl -v -u YOUR_API_KEY:X \
  -H "Content-Type: application/json" \
  https://yourcompany.freshdesk.com/api/v2/tickets

Under the hood, curl -u Base64-encodes YOUR_API_KEY:X into an Authorization: Basic ... header. If you're building the header yourself instead of using curl's -u flag, encode that same key:X string:

{
  "request": "GET https://yourcompany.freshdesk.com/api/v2/tickets",
  "headers": {
    "Authorization": "Basic <base64 of YOUR_API_KEY:X>",
    "Content-Type": "application/json"
  }
}

A 200 OK with a JSON array of tickets means the key is valid. A 401 with an invalid_credentials error means the key is wrong, disabled, or belongs to a deactivated agent.

Step 3: Reset the key when you need to rotate it

If a key leaks — committed to a public repo, pasted in a chat, or handed to a vendor you've stopped working with — you rotate it by resetting it from the same Profile Settings screen. Be clear-eyed about the blast radius first, though. Per Freshworks' Where can I find my API key? article, resetting the key disconnects every app and integration currently using the old key — not just the one you're worried about. There's a single key per agent, so a reset is all-or-nothing for that agent.

Practical hygiene that follows from this:

  1. Use a dedicated service agent for integrations rather than a real person's account, so rotating a key doesn't disrupt a human's own tooling.
  2. Scope that agent's role to only what the integration needs — the key inherits the role, so a read-only integration should ride on a read-only agent.
  3. Rotate on a schedule, and immediately after anyone with access leaves.
  4. Never hard-code the key in client-side code, a mobile app, or anything that ships to a browser — it grants full API access at that agent's permission level.

The honest limits — plan gating, rate limits, and what a key can't do

The API key mechanism is simple and dependable, but it has real edges worth naming. First, plan gating: API access isn't available on the entry-level tier (the old Sprout plan, and correspondingly the current Free plan). You need Growth, Pro, or Enterprise — or one of the legacy Blossom/Garden/Estate/Forest plans — for the key to do anything at all.

Second, rate limits are account-wide and can bite fast. Per Freshworks' rate-limits documentation, the per-minute ceilings are roughly:

PlanAPI calls / minuteNotable per-endpoint sub-limits (Growth)
Free0 (no API access)
Growth200Ticket Create 80, Ticket Update 80, Tickets List 20
Pro400Higher, but still per-endpoint capped
Enterprise700Highest tier
Trial50For evaluation only

Those limits are per account, not per agent — spreading work across multiple agents' keys doesn't multiply your budget. Exceed them and you get an HTTP 429 with a Retry-After header telling you how long to back off. If you want the full breakdown of endpoints, auth, and pagination, we cover it in how to use the Freshdesk API.

Third — and this is the honest ceiling — a key gets you access, not behaviour. It authenticates a request; it doesn't read a ticket, understand the customer's problem, or decide what to do. Turning "I have a valid key" into "tickets get triaged, answered, and updated automatically" is exactly the build-versus-buy decision, because everything past authentication — polling, parsing, deciding, writing — is code you either write and maintain or hand to a platform.

That platform layer is where an AI agent for customer service fits, and it's worth being precise about the relationship. Macha runs on top of the Freshdesk you already use as a native connector — it is not a help desk replacement. You paste your subdomain and this same API key into Macha once, and from then on it reads and writes the same tickets your team does: drafting grounded replies, triaging by intent, and calling out to your own systems through a custom tool when an answer needs live order or account data. You don't write or babysit any of the Basic-auth plumbing above. (Macha connects to Freshdesk specifically — not Freshchat, Freshservice, or Freshcaller — and credits are consumed per AI action, not per resolution; the pricing page has the details.) If you'd rather see automation patterns before wiring anything up, how to automate Freshdesk with AI walks through the common ones.

The clean division: Freshdesk issues and scopes the key and stays the system of record; you decide whether the work on the other side of that key is yours to build or a layer to bolt on.

FAQ

Where is the Freshdesk API key located? In your agent Profile Settings, not in Admin. Click your profile picture (top right) → Profile SettingsView API key, then complete the reCAPTCHA. The key is specific to your agent account and inherits your role's permissions.

Why can't I see the key value on the settings page? Freshdesk hides the actual key behind a reCAPTCHA challenge and only reveals it after you pass verification. This prevents a hijacked session or scraper from lifting the credential just by loading the page. Seeing only a View API key button — not the key itself — is the expected behaviour.

How do I use the API key to authenticate? Freshdesk API v2 uses HTTP Basic Auth: pass the API key as the username and any dummy password (usually X). For example: curl -u YOUR_API_KEY:X https://yourcompany.freshdesk.com/api/v2/tickets. There's no OAuth 2.0 for the v2 API.

What happens when I reset my API key? Resetting generates a new key and disconnects every app or integration using the old one — not just a single app. There's one key per agent, so rotate deliberately and re-authenticate your integrations afterward.

Is the API key available on every Freshdesk plan? No. API access is unavailable on the entry tier (old Sprout, current Free). It's available on Growth, Pro, and Enterprise (and the legacy Blossom/Garden/Estate/Forest plans), each with its own per-minute rate limit. Confirm against your own plan.

Want the same key to do more than authenticate a script? Start a free trial of Macha and connect it to your Freshdesk in minutes.

Macha

About Macha

Macha is an AI agent platform that works on top of the help desk you already use — Zendesk, Freshdesk, Gorgias, or Front — and connects to the rest of your stack, even your own internal systems. Its AI agents resolve tickets and automate entire workflows end to end, all set up in plain English, no code. Learn more about Macha →

Zendesk
5.0 on Zendesk Marketplace

Loved by support teams worldwide

See what support teams are saying about Macha AI.

The application seems excellent to me! We are still testing, and we need support for some details and they were extremely efficient too!

Daniela Costa

Daniela Costa

Head of Support, Seabra

Macha has been a great addition to our support toolkit. It generates clear, well-organized responses that fit naturally into our workflow. One feature we particularly appreciate is its ability to automatically reply in the same language as the ticket.

Marius F

Marius F

Support Head, Zentana

We've been using Macha for a little while now and it's been really great addition so far! It's powerful, convenient, and makes getting work done a lot easier for our agents.

Alexander Wedén

Alexander Wedén

Head of Support

Support team is very helpful and responsive. Really enjoy how lightweight this is within Zendesk itself vs other more intrusive tools.

Cathleen Wright

Cathleen Wright

Zendesk Admin, Cortex IO

So far it's pretty good! Our queries are a little nuanced, so we can't always use it, but it's got enough utility for us. It can even incorporate our bilingual country with greetings in a second language.

Jae Oliver

Jae Oliver

Head of Support, Wise

Really enjoying using Macha, it has made a noticeable difference to our support team in a short amount of time. I really like the ticket summary feature, saves us a lot of time.

Harry Jackson

Harry Jackson

Head of Support, Crumb

Macha AI is a great addition to my workspace! It's powerful, convenient, and it really makes productivity so much easier for our agents!

Dave G

Dave G

Head of Support, Cyber Power Systems

Very impressed! AI integration for Zendesk has certainly come a long way and Macha seems to set the standard for now. This will for sure save lot of time in our support team.

Pauli Juel

Pauli Juel

Head of CS, Dokument24

Macha has been working great for us so far! The auto-responses are accurate and our resolution time has dropped significantly.

Lana T

Lana T

Zendesk Admin, Swotzy

Macha AI is a great addition. The knowledge base feature means our agents always have the right answers at their fingertips.

Mischa Wolf

Mischa Wolf

Head of Support, Topi

We're enjoying this integration so far. It's made our support team more efficient and our customers get faster responses.

Paula G

Paula G

Head of Customer Support, Xly Studio

The team enjoys using it. It saves considerable time on common questions and the integration options are excellent.

Kilian Leister

Kilian Leister

Support Head, Didriksons

Ready to supercharge your team with AI?

Get started in minutes. Connect your tools, configure your agents, and let AI handle the rest.

500 free credits · no time limit, no credit card