Skip to navigation

CLM API 101

View as Markdown

Developing with the CLM API is only available for CLM customers with a production account. To purchase a plan to gain access to the CLM API, contact Docusign Sales.

The Docusign CLM API enables developers to interact with Docusign CLM documents, data, and services. Most objects and services available in the Docusign CLM web application are supported in the API. Users and groups are managed through Docusign Admin. See Object API for more information.

For additional issues or requests, visit the Docusign Support Center.

The Docusign CLM API contains the following logical sub-APIs for working programmatically with Docusign CLM:

  • Object API: API methods that create, read, update, and delete (CRUD) Docusign CLM objects, such as folders.
  • Task API: API methods that expose Docusign CLM services that are invoked as asynchronous tasks, such as zipping files or running searches.
  • Content API: API methods for uploading, downloading, and versioning documents in Docusign CLM.

Base URLs

All API URLs use the following format:

https://[base url]/[version]/[Docusign Account Id]/[resource identifier]

Docusign CLM is distributed across several data centers, and the base URLs for the Object, Task, and Content APIs are data center–specific. You can determine the data center associated with an account by looking at the subdomain of the URL after you log in to the Docusign CLM web application (for example, na11 or s1.us). Content API URLs are properties of the document and folder objects and are discoverable at run time.

You can also get your account-related URLs, including the base CLM API URLs, by making a GET request to these endpoints:

UAT: https://authuat.springcm.com/api/v2/{Docusign API Account ID}/account

Production: https://auth.springcm.com/api/v2/{Docusign API Account ID}/account

To find your Docusign API Account ID, log in to your eSignature account and select Admin from the top menu, then select Apps and Keys from the left navigation. Copy your API Account ID value.

Note: Similar to endpoints for resources, these endpoints require:

  • CLM to be enabled for your account.
  • A valid access token in the authorization header. You must request the springcm_read scope when you request the access token. See Authentication for details.

Production endpoints

APIEndpoint
Production Object APIhttps://api.[datacenter].clm.docusign.net, https://api[datacenter].springcm.com
Production Task APIhttps://api[datacenter].springcm.com, https://api.[datacenter].clm.docusign.net
Production Content Upload APIhttps://apiupload[datacenter].springcm.com, https://apiupload.[datacenter].clm.docusign.net
Production Content Download APIhttps://apidownload[datacenter].springcm.com, https://apidownload.[datacenter].clm.docusign.net

UAT endpoints

APIEndpoint
UAT Object APIhttps://apiuat[datacenter].springcm.com, https://api.[datacenter].clm.demo.docusign.net
UAT Task APIhttps://apiuat[datacenter].springcm.com, https://api.[datacenter].clm.demo.docusign.net
UAT Content Upload APIhttps://apiuploaduat[datacenter].springcm.com, https://apiupload.[datacenter].clm.demo.docusign.net
UAT Content Download APIhttps://apidownloaduat[datacenter].springcm.com, https://apidownload.[datacenter].clm.demo.docusign.net

Request and response formats

The Docusign CLM Object and Task APIs support JSON for all requests and responses. The Content API by default will download documents in the native format in which they were uploaded. For certain document types, Docusign CLM will also maintain a copy of the document in additional formats such as .PDF, .PNG, or .TXT. See the Content API reference for more information.

Places to start

Start learning about developing with the CLM API: