Create, view, and manage agreements including sending, voiding, and reassigning
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
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
OK
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.
The owner is the sender of the agreement. The signer is the individual who is signing the agreement from the owners organization. The recipient email is the counterparty.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Rate Limiting Response
typestring · requiredA URI reference that identifies the problem.
titlestring · requiredA short, human-readable summary of the problem.
statusnumber · requiredThe HTTP status code.
instancestring
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.
path Parameters
idrequired
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
OK
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.
path Parameters
idrequired
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
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.
path Parameters
idrequired
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
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.
path Parameters
idrequired
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
OK
recipient_namestring