Templates

This endpoint returns a list of agreement templates that have been created within Common Paper, including uploaded PDF templates.

By default, the list response includes shared template attributes only (such as name, version, roles, and agreement_type). Type-specific attributes and nested objects (such as governing_law_region or template_csa_order_form) are excluded. Pass full=true to include those attributes in the list response, or use GET /v1/templates/{id} to retrieve a single full template.

Uploaded PDF templates appear with type uploaded_template. These are PDFs uploaded in Common Paper (not Common Paper standard forms). For uploaded_template resources, version, negotiations_allowed, sender_role, recipient_role, and include_terms are blank (null), and standard_version is omitted.

This endpoint creates a new agreement template in Common Paper. Choose the schema variant that matches the template type you want to create. If type is omitted, the template defaults to NDA. All parameters within a variant are optional and set defaults pre-filled when agreements are created from the template. See Template Parameters for field descriptions.

This endpoint returns the details of a specific agreement template within Common Paper by providing its uuid. Supports both Common Paper standard templates and uploaded PDF templates.

Uploaded PDF templates appear with type uploaded_template. These are PDFs uploaded in Common Paper (not Common Paper standard forms). For uploaded_template resources, version, negotiations_allowed, sender_role, recipient_role, and include_terms are blank (null), and standard_version is omitted.

This endpoint updates an existing agreement template. Choose the schema variant that matches the template's agreement type (from GET /v1/templates/{id}). Only the fields provided in the request body are changed — omitted fields retain their current values. The template type cannot be changed after creation.

Example: Rename a template and change governing law

Code
curl -X PATCH "https://api.commonpaper.com/v1/templates/TEMPLATE_UUID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated NDA",
    "governing_law_region": "California",
    "governing_law_country": "United States of America",
    "chosen_courts_region": "California",
    "chosen_courts_country": "United States of America"
  }'

Example: Update NDA term and purpose

Code
curl -X PATCH "https://api.commonpaper.com/v1/templates/TEMPLATE_UUID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "term": 2,
    "confidentiality_period": 3,
    "purpose": "Evaluating a potential acquisition."
  }'

Example: Update CSA order form subscription period

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

Example: Enable negotiations and set a default signer

Code
curl -X PATCH "https://api.commonpaper.com/v1/templates/TEMPLATE_UUID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "negotiations_allowed": true,
    "default_signer_email": "legal@example.com",
    "sender_last_to_sign": true
  }'

See Template Parameters for field descriptions.

This endpoint archives an agreement template within Common Paper. Archived templates are removed from the active template list but can be restored from the Common Paper UI.