Skip to main content

Using the Common Paper API

An overview of what you can do with the Common Paper API, and how Admins generate and delete API keys on the Integrations page.

Written by Mark Frantz

The Common Paper API lets you integrate agreement creation, sending, and tracking directly into your own applications and workflows. If your team manages high volumes of agreements or wants to automate parts of the contract process, the API gives you programmatic access to everything the platform can do. API access is available on all plans, including the free tier.

What you can do with the API

  • Query agreement data - Retrieve metadata, status, and key terms for any agreement in your account.

  • Create and edit agreements - Create agreements from your templates, save them as drafts, and update drafts before sending. Only drafts can be edited through the API. To change an agreement you've already sent, use Propose Changes in Common Paper.

  • Send agreements - Automate the process of sending agreements for signature.

  • Track agreement status - Monitor in real time whether an agreement has been viewed, signed, or completed.

  • Manage templates - Create, retrieve, and update templates for any agreement type, including NDAs, CSAs, Design Partner Agreements, DPAs, BAAs, PSAs, LOIs, Pilots, and Software Licenses.

  • Access organization data - Retrieve information about your organization.

Getting started

To start using the API, click Integrations in the left sidebar and find the API card. Click Generate API key to create a new key. You can generate multiple keys - for example, one per integration or environment.

Each key is identified by its last four characters and shows who created it and when. Once generated, copy your key immediately - it will not be shown again.

Who can generate API keys

Only Admins can generate or delete API keys. If you aren't an Admin, you won't see the Generate API key button. Ask an Admin in your organization to create a key for you.

You also need a verified email address. Until your email is verified, the Generate API key button is disabled and the card shows Verify your email to generate a key. Click Resend verification email below the button if you need a new verification link.

Managing your API keys

All of your active keys are listed on the API card of the Integrations page. Admins can delete a key at any time by clicking Delete next to it.

NOTE: Deleting a key immediately revokes access for any integration using it. Update your integrations before deleting a key they depend on.

API documentation

For the full reference and detailed documentation, visit the Common Paper API docs.

Did this answer your question?