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.

By default, the list response omits type-specific nested attributes (such as csa, csa_order_form, dpa, baa, and other agreement-type sub-models). Pass full=true to include those nested attributes in the list response, or use GET /v1/agreements/{id} to retrieve a single full 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.

Set draft to true to save the agreement without sending it. Draft agreements can be sent later using POST /v1/agreements/{id}/send.

When creating from a template, you can override template defaults by passing agreement-type-specific attribute objects inside the agreement body (e.g. csa_attributes, dpa_attributes). See #/components/schemas/agreement-type-overrides-schema for all override keys and their field schemas.

Sends a draft agreement to the recipient, transitioning its status from draft to sent_waiting_for_initial_review. The agreement must currently be in draft status.

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.

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.

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.

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.

Downloads a PDF copy of an agreement. Returns the file as application/pdf binary content with a Content-Disposition header containing the filename. Provide the agreement UUID.

Generates a shareable review link for an agreement. Returns a JSON object with a link URL that can be shared with recipients. Provide the agreement UUID.