ClientSuccess Open API v2.0 – ClientSuccess Help Center

Getting Started

To get started with the new ClientSuccess API v2.0, please visit the new Developer Portal. The new Portal provides updated documentation for all of our API’s, and consolidates them into one location.

The ClientSuccess API v2 allows you to build ClientSuccess functionality into any app by listing, creating, updating or deleting data for the following functions including the new Contracts API v2.0 as show below.

API Access

The new Developer Portal provides the following API features:

v1 API’s for Clients and Contacts (See v1 details below)
v2 API’s for Clients, Contacts, and Contracts (Select v2 from API version in header)
The new Usage API is available for customers wanting to send usage data to ClientSuccess.
Easier examples and the ability to send API calls right from within the portal after logging in so you can see exactly what data will be returned.

For direct links to the latest API's and documentation please go to:

Open API: https://api.clientsuccess.com

Usage API: https://usage.clientsuccess.com

Access to v1 API and Documentation

If you need access to the v1 API's or documentation, you can switch to the v1 API in the drop-down bellow.

API User

We highly recommend creating a separate user account in ClientSuccess named "API Access" for working with the API. Please make sure to use "API Access" in the name of the user to ensure you are not charged for this user account.

Note: Please use this new developer portal for access to the API's. The old Apiary site is in the process of being deprecated.

If you don't see a function you would like to be able to leverage, please submit a request to support@clientsuccess.com for the feature enhancement.

Related articles