CommonPaper API Docs
API Documentation
API Documentation

Organizations

View and manage your Common Paper organization

List Organizations

GET
https://api.commonpaper.com
/v1/organizations

This endpoint returns a list of organizations accessible to the authenticated user within Common Paper.

List Organizations › query Parameters

page[number]
​integer

Page number to retrieve. Defaults to 1.

Default: 1
page[size]
​integer

Number of records per page. Defaults to 30.

Default: 30

List Organizations › Headers

Authorization
​string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List Organizations › Responses

OK

Get Organization

GET
https://api.commonpaper.com
/v1/organizations/{id}

This endpoint returns the details of a specific organization within Common Paper by providing its UUID.

Get Organization › path Parameters

id
​string · uuid · required

The UUID of the resource.

Get Organization › Headers

Authorization
​string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Organization › Responses

OK

Update Organization

PATCH
https://api.commonpaper.com
/v1/organizations/{id}

This endpoint updates attributes on your Common Paper organization. The id in the URL must match the organization identified by your API key; otherwise the response is 404. Only the fields you provide in the request body are changed.

Example: Rename the organization and update the billing email

TerminalCode
curl -X PATCH "https://api.commonpaper.com/v1/organizations/ORGANIZATION_UUID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "organization": {
      "name": "Acme Corp",
      "city": "Philadelphia",
      "state": "PA",
      "billing_notifications_email": "billing@example.com"
    }
  }'

Example: Enable a default agreement expiration

TerminalCode
curl -X PATCH "https://api.commonpaper.com/v1/organizations/ORGANIZATION_UUID" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "organization": {
      "include_default_agreement_expiration": true,
      "include_default_agreement_expiration_days": 30
    }
  }'

Update Organization › path Parameters

id
​string · uuid · required

The UUID of the organization to update. Must match the organization that owns the API key.

Update Organization › Headers

Authorization
​string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Update Organization › Request Body

organization-update-schema
​object · required

The organization attributes to update. Only the fields you provide are changed; omitted fields keep their current values.

Update Organization › Responses

OK

Agreement StatusesAttachments