https://api.commonpaper.comAuthorization
1 2 3curl --request GET \ --url https://api.commonpaper.com/v1/agreements \ --header 'Authorization: Bearer YOUR_KEY_HERE'
{}Authorization
template_id
owner_email
owner_id
signer_email
signer_id
cc_users
agreement
1 2 3 4 5curl --request POST \ --url https://api.commonpaper.com/v1/agreements \ --header 'Authorization: Bearer YOUR_KEY_HERE' \ --header 'Content-Type: application/json' \ --data '{"template_id":"f48e65e1-43da-3282-ebe4-8dfc43bb9033","owner_email":"ben@example.com","owner_id":"5d3676a8-ac48-734e-7f71-f549a6633f38","signer_email":"jake@example.com","signer_id":"fed1f08a-9d54-bc0b-2080-bc7bc85198d8","agreement":{"recipient_name":"Art Vandelay","recipient_email":"art@vandelay.com"}}'
{
"template_id": "f48e65e1-43da-3282-ebe4-8dfc43bb9033",
"owner_email": "ben@example.com",
"owner_id": "5d3676a8-ac48-734e-7f71-f549a6633f38",
"signer_email": "jake@example.com",
"signer_id": "fed1f08a-9d54-bc0b-2080-bc7bc85198d8",
"agreement": {
"recipient_name": "Art Vandelay",
"recipient_email": "art@vandelay.com"
}
}Authorization
id
1 2 3curl --request GET \ --url https://api.commonpaper.com/v1/agreements/:id \ --header 'Authorization: Bearer YOUR_KEY_HERE'
{}Authorization
id
1 2 3curl --request GET \ --url https://api.commonpaper.com/v1/agreements/:id/history \ --header 'Authorization: Bearer YOUR_KEY_HERE'
{}Authorization
id
1 2 3curl --request PATCH \ --url https://api.commonpaper.com/v1/agreements/:id/void \ --header 'Authorization: Bearer YOUR_KEY_HERE'
{}Authorization
id
1 2 3curl --request PATCH \ --url https://api.commonpaper.com/v1/agreements/:id/resend_email \ --header 'Authorization: Bearer YOUR_KEY_HERE'
{}Authorization
id
agreement
1 2 3 4 5curl --request PATCH \ --url https://api.commonpaper.com/v1/agreements/:id/reassign \ --header 'Authorization: Bearer YOUR_KEY_HERE' \ --header 'Content-Type: application/json' \ --data '{"agreement":{"recipient_name":"Art Vandelay","recipient_email":"art@example.com","add_recipient_as_cc":true}}'
{
"agreement": {
"recipient_name": "Art Vandelay",
"recipient_email": "art@example.com",
"add_recipient_as_cc": true
}
}{}Authorization
1 2 3curl --request GET \ --url https://api.commonpaper.com/v1/agreement_history \ --header 'Authorization: Bearer YOUR_KEY_HERE'
{}Authorization
1 2 3curl --request GET \ --url https://api.commonpaper.com/v1/templates \ --header 'Authorization: Bearer YOUR_KEY_HERE'
Authorization
id
1 2 3curl --request GET \ --url https://api.commonpaper.com/v1/templates/:id \ --header 'Authorization: Bearer YOUR_KEY_HERE'
Authorization
1 2 3curl --request GET \ --url https://api.commonpaper.com/v1/users \ --header 'Authorization: Bearer YOUR_KEY_HERE'
{}Authorization
id
1 2 3curl --request GET \ --url https://api.commonpaper.com/v1/users/:id \ --header 'Authorization: Bearer YOUR_KEY_HERE'
{}Authorization
1 2 3curl --request GET \ --url https://api.commonpaper.com/v1/agreement_types \ --header 'Authorization: Bearer YOUR_KEY_HERE'
{}Authorization
1 2 3curl --request GET \ --url https://api.commonpaper.com/v1/agreement_statuses \ --header 'Authorization: Bearer YOUR_KEY_HERE'
{}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.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
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.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
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.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
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.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
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.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
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.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
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.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
The agreement object
This endpoint returns a list of agreement history events for all agreements in your Common Paper organization.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
This endpoint returns a list of agreement templates that have been created within Common Paper, and their attributes.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
This endpoint returns the details of a specific agreement template within Common Paper by providing its uuid. Returns the details of the template.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
This endpoint returns a list of all users within your Common Paper organization.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
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.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
This endpoint returns a list of all agreement types within Common Paper, including any custom types you defined in your organization.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
This endpoint returns a list of all possible agreement statuses within Common Paper. Agreement statuses indicate the current state of an agreement.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.