PSA Data Export guide
Create HaloPSA API credentials for backup
Set up least-privilege HaloPSA read access using OAuth 2.0 client ID and secret, with tenant and regional details checked before backup.
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 HaloPSA credential
Register an application under Configuration › Integrations › HaloPSA API, use client credentials with read-only permissions, and record auth/resource URLs. The current native model is OAuth 2.0 client ID and secret. Follow the HaloPSA official documentation in the live tenant because labels, available scopes, and regional hosts can change.
Choose read access
Request read access only for tickets, actions, and notes, clients, users, and sites, time and contract data, and invoices where licensed. 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. Record both the authorization and resource-server URLs from the tenant. Hosted and self-hosted Halo deployments can use different hosts.
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. Join the waitlist for invitation-only BackupPSA access, or contact us about your platform.