PSA Data Export guide

Create Freshdesk API credentials for backup

At a glance

Set up least-privilege Freshdesk read access using agent API key or OAuth, with tenant and regional details checked before backup.

Published · Updated
On this page

Before you create credentials

Sign in as an administrator authorized to create integrations. Decide who owns rotation and revocation. Confirm the account plan exposes the modules you need and use a dedicated integration identity rather than a person's everyday login.

Create the Freshdesk credential

Use a dedicated agent whose role can view the intended tickets; locate its API key in profile settings and retain the Freshdesk domain. The current native model is agent API key or OAuth. Follow the Freshdesk official documentation in the live tenant because labels, available scopes, and regional hosts can change.

Choose read access

Request read access only for tickets and custom fields, public replies and private notes, contacts and companies, and attachment metadata and downloadable files. Do not grant create, update, or delete permissions when the vendor offers separate scopes. Some products attach visibility to the underlying user role even when a token itself exists.

Record connection details safely

Keep the credential secret together with the tenant identifier, subdomain or base URL, region/data center, expiration date, and granted scopes. Do not paste secrets into tickets, screenshots, source control, browser localStorage, or this marketing site.

Validate the connection

Call a harmless documented read endpoint, confirm the expected tenant, then list a small sample from each selected record group. Record permission failures and unavailable modules. Ticket detail can include only the first ten conversations; use the conversations endpoint for the remainder. Agent role permissions constrain API visibility.

Rotate or revoke access

Create the replacement first, validate it, update the consuming application through its secret store, then revoke the prior credential. Recheck scheduled captures after a role, license, region, or owner changes.

Plan your independent PSA archive

Keep source history available after your move. Request an invitation to BackupPSA. We’ll contact you if you’re selected for an invitation. You can also contact us about your platform.

We’ll only use your email to contact you about BackupPSA access.

Questions about your PSA? Email contact@backuppsa.com.