API Documentation

BASE URL
https://api.commonpaper.com

Agreements

This endpoint allows users to view a list of agreements that have been created within Common Paper. Users can filter and sort agreements based on various criteria, such as created_at, status, and agreement_type.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

GET
/v1/agreements
1

Create Agreement

This endpoint allows the user to create an agreement in Common Paper. The user must supply ONE of either an id or email for both signer and owner.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Request Body

template_id

required, string

owner_email

optional, string

owner_id

optional, string

signer_email

optional, string

signer_id

optional, string

cc_users

optional, array of strings

agreement

required, object
POST
/v1/agreements
1
EXAMPLE BODY
{
  "template_id": "dd322e06-383a-34f0-56e4-f9649c94cafa",
  "owner_email": "ben@example.com",
  "cc_users": [
    "mark@example.com",
    "mark@example.com",
    "mark@example.com",
    "mark@example.com",
    "mark@example.com"
  ],
  "agreement": {
    "recipient_name": "Art Vandelay",
    "recipient_email": "art@vandelay.com",
    "recipient_organization_name": "Vandelay Industries",
    "message": "This is the agreement we spoke about.",
    "test_agreement": false
  }
}

Agreement by id

This endpoint allows users to retrieve a specific agreement from Common Paper by providing its uuid. Returns the details of the agreement, such as the parties involved, the terms of the agreement, and the status.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

id

required
GET
/v1/agreements/:id
1

History of an agreement by id

This endpoint returns the history of events for a specific agreement within Common Paper. Returns who made the changes, when they were made, and a description of the change.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

id

required
GET
/v1/agreements/:id/history
1

Voiding an agreement

This endpoint allows users to void a specific agreement within Common Paper. Voiding an agreement means that it is no longer valid and cannot be executed.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

id

required
PATCH
/v1/agreements/:id/void
1

Resend the most recent email for an agreement

This endpoint resends the last notification email sent to the recipient party in a specific agreement within Common Paper, usually to move the process along a little faster.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

id

required
PATCH
/v1/agreements/:id/resend_email
1

Reassign an agreement to another email

This endpoint allows users to reassign a specific agreement within Common Paper to a different recipient. This may be necessary if the original assignee is no longer available or if a different user is better suited to handle the agreement.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

id

required

Request Body

agreement

required, object

The agreement object

PATCH
/v1/agreements/:id/reassign
1
EXAMPLE BODY
{
  "agreement": {
    "recipient_name": "Art Vandelay",
    "recipient_email": "art@example.com",
    "comments": "This is the agreement we spoke about on the phone.",
    "add_recipient_as_cc": true
  }
}

Agreement History

This endpoint returns a list of agreement history events for all agreements in your Common Paper organization.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

GET
/v1/agreement_history
1

Templates

This endpoint returns a list of agreement templates that have been created within Common Paper, and their attributes.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

GET
/v1/templates
1

Template by id

This endpoint returns the details of a specific agreement template within Common Paper by providing its uuid. Returns the details of the template.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

id

required
GET
/v1/templates/:id
1

Users

This endpoint returns a list of all users within your Common Paper organization.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

GET
/v1/users
1

Users by id

This endpoint returns the profile information of a specific user within your Common Paper accouunt based on their uuid. Returns the user's profile information, such as their name, email, and role.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

id

required
GET
/v1/users/:id
1

Agreement Types

This endpoint returns a list of all agreement types within Common Paper, including any custom types you defined in your organization.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

GET
/v1/agreement_types
1

Agreement Statuses

This endpoint returns a list of all possible agreement statuses within Common Paper. Agreement statuses indicate the current state of an agreement.

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

GET
/v1/agreement_statuses
1