Getting API access
The ClientSuccess Open API (v2.0) lets you programmatically read and write Clients, Contacts, and Contracts, and push product usage data via the Usage API. See the ClientSuccess Open API v2.0 article for endpoint details and the Developer Portal.
Where to find your API key
Log in as a user with the Admin role.
Go to Settings → API.
Copy your API key. Keys are long-lived — you do not need to generate a new one for each session.
Don't see Settings → API? Your user role doesn't have admin access. Ask an account admin to retrieve the key or to grant you the Admin role. Support cannot send API keys over email or chat for security reasons.
Setting up a dedicated API user
For production integrations, we recommend a dedicated API user account rather than a personal login, so the integration doesn't break when team members change. Create the user under Settings → Team, grant Admin, and generate the key while logged in as that user.
Troubleshooting integration sync issues
For CRM and other integrations (Salesforce, HubSpot, Stripe, Zapier, NPS apps), most sync problems fall into one of four buckets. Work through these in order:
1. Check credentials and connection status
Go to Settings → Integrations and open the integration in question.
Confirm the connection shows as active/authorized. Expired or revoked credentials (e.g., a password change, a deactivated connected user, or an expired token on the CRM side) are the most common cause of a sync silently stopping.
If the connection looks broken, reauthorize it with an account that has the required permissions in the external system.
2. Check sync direction and filters
Integrations sync in the direction(s) and scope you've configured. If records or updates aren't appearing:
Confirm the sync direction for the affected record type (e.g., ClientSuccess → CRM, CRM → ClientSuccess, or both). Disabling one direction does not disable the other, but configuration changes can unintentionally affect related recipes.
Review your sync filters and field mappings — records that don't match the filter criteria are skipped by design.
3. Check for recent configuration changes
If a sync "worked until recently," ask what changed around that date: integration settings edited, fields renamed or deleted in either system, users deactivated, or permission changes in the external system. Pinning down the date the sync stopped dramatically speeds up diagnosis.
4. Test with a single record
Update one record that should sync (e.g., edit a contact in the source system) and watch for it in the destination. This tells you whether the sync is fully down or only affecting certain records.
What to include when contacting support
If the checklist above doesn't resolve it, contact support@clientsuccess.com with the following — including these up front usually saves a full day of back-and-forth:
Which integration (e.g., Salesforce, HubSpot, Intercom, Stripe) and which record types are affected (clients, contacts, contracts, engagements).
Sync direction affected (into ClientSuccess, out of ClientSuccess, or both).
When it last worked — the approximate date the issue started.
2–3 example records (names or IDs in both systems) that should have synced but didn't.
The exact error message, if you're seeing one, and a screenshot if possible.
Recent changes you're aware of in either system (settings, fields, users, permissions).
Common questions
Can support generate an API key for me?
No — API keys are self-service from Settings → API and require Admin access on your account. This keeps key access auditable inside your own organization.
Does the API support exports?
Yes — the API can pull customer, contact, pulse, and revenue data programmatically, which is the right approach for recurring automated exports. For one-off or scheduled manual exports, see Exporting and Reporting on Customer Data.
My engagements stopped syncing to my CRM
Work through the troubleshooting checklist above, paying special attention to step 2 — engagement sync is configured separately from client/contact sync, and changes to one sync direction are sometimes made without realizing the other direction was affected. If engagements stopped on a specific date, include that date when you contact support.