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.

template_id may be the UUID of a Common Paper standard template, an uploaded PDF template (type uploaded_template from GET /v1/templates), or a custom template (from GET /v1/custom_templates).

To create an amendment, omit template_id and set agreement_type to Amendment. Set agreement.parent_agreement_id to the agreement being amended, set agreement.negotiations_allowed (required, since there is no template to default it from), and put the amendment terms in agreement.amendment_attributes.

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 Overriding Template Defaults for the override key for each agreement type, and Template Parameters for their fields.

When creating from a custom template, pass field values in agreement.custom_field_values, keyed by the field keys in the template's YAML definition. Template defaults fill any fields you omit, and a required field with no default and no submitted value returns a 400 naming the field. Values are validated against each field's input type (select and radio against their options, multiselect as an array of selections each validated against the options, number and currency as numeric, date as YYYY-MM-DD, email as a valid address); an invalid value returns a 400 naming the field. See Custom Templates.

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.

Updates a draft agreement. Only agreements in draft status can be edited; anything else returns a 422. The editable fields mirror what the draft form in Common Paper can change, and only the fields you send are changed - omitted fields keep their current values. Send the draft with POST /v1/agreements/{id}/send when it is ready.

Every agreement type takes the same cover page fields and differs only in the term object it owns, so pick the request body variant matching the draft's agreement_type from GET /v1/agreements/{id}.

Nested term attributes must include the term's id. A term object such as csa_attributes or design_partner_attributes replaces the record the agreement already owns when it arrives without a matching id, which would silently drop every field you did not send. Read the id from GET /v1/agreements/{id} and pass it back; a missing or mismatched id returns a 422 naming the id it expected and leaves the draft untouched.

Example: edit the cover page of an NDA draft

Code
curl -X PATCH "https://api.commonpaper.com/v1/agreements/AGREEMENT_UUID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agreement": {
      "recipient_name": "Art Vandelay",
      "recipient_organization": "Vandelay Industries",
      "purpose": "Evaluating a potential partnership.",
      "term": 2
    }
  }'

Example: change who signs for your organization

Code
curl -X PATCH "https://api.commonpaper.com/v1/agreements/AGREEMENT_UUID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agreement": {
      "default_signer_email": "legal@example.com"
    }
  }'

Example: update the order form on a CSA draft

Code
curl -X PATCH "https://api.commonpaper.com/v1/agreements/AGREEMENT_UUID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agreement": {
      "csa_order_form_attributes": {
        "id": "CSA_ORDER_FORM_UUID",
        "subscription_period": 2,
        "subscription_period_unit": "year(s)",
        "cloud_service_description": "An analytics and reporting platform."
      }
    }
  }'

Example: update the terms on a Design draft

Code
curl -X PATCH "https://api.commonpaper.com/v1/agreements/AGREEMENT_UUID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agreement": {
      "design_partner_attributes": {
        "id": "DESIGN_PARTNER_UUID",
        "product_description": "An analytics and reporting platform.",
        "term_amount": 6,
        "term_unit": "month(s)"
      }
    }
  }'

See Overriding Template Defaults for the term field reference.

Deletes a draft agreement. Only agreements in draft status can be deleted; to stop an agreement that has already been sent, use PATCH /v1/agreements/{id}/void instead. The caller must be an admin of the organization or the owner of the draft.

A draft cannot be deleted while a DPA or BAA uses it as its underlying agreement. Void or delete that agreement first.

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.