Organizations

Endpointhttps://api.commonpaper.com

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

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

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

Code
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

Code
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

object · required

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

Update Organization › Responses

PATCH/v1/organizations/{id}

curl --request PATCH \
  --url https://api.commonpaper.com/v1/organizations/:id \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "organization": {
    "name": "Acme Corp",
    "description": "description",
    "street_address": "123 Main St",
    "city": "Philadelphia",
    "state": "PA",
    "zipcode": "19103",
    "country": "United States of America",
    "include_default_agreement_expiration": true,
    "include_default_agreement_expiration_days": 30,
    "include_default_automated_nudges": true,
    "default_days_between_nudges": 3,
    "allow_additional_courts": true,
    "include_notice_email_address": true,
    "notice_email_address": "legal@example.com",
    "include_notice_address": true,
    "billing_notifications_email": "billing@example.com"
  }
}
'

shell

Example Request Body

{
  "organization": {
    "name": "Acme Corp",
    "description": "description",
    "street_address": "123 Main St",
    "city": "Philadelphia",
    "state": "PA",
    "zipcode": "19103",
    "country": "United States of America",
    "include_default_agreement_expiration": true,
    "include_default_agreement_expiration_days": 30,
    "include_default_automated_nudges": true,
    "default_days_between_nudges": 3,
    "allow_additional_courts": true,
    "include_notice_email_address": true,
    "notice_email_address": "legal@example.com",
    "include_notice_address": true,
    "billing_notifications_email": "billing@example.com"
  }
}

json

Example Responses

{
  "data": {
    "id": "ORGANIZATION_UUID",
    "type": "organization",
    "attributes": {
      "name": "Acme Corp",
      "description": "An example organization.",
      "street_address": "123 Main St",
      "city": "Philadelphia",
      "state": "PA",
      "zipcode": "19103",
      "country": "United States of America",
      "onboarded": true,
      "include_default_agreement_expiration": true,
      "include_default_agreement_expiration_days": 30,
      "include_default_automated_nudges": true,
      "default_days_between_nudges": 3,
      "allow_additional_courts": false,
      "subsidiaries_enabled": false,
      "default_subsidiary_id": null,
      "billing_notifications_email": "billing@example.com",
      "ingestion_email_address": "acme@ingest.commonpaper.com",
      "include_notice_email_address": true,
      "notice_email_address": "legal@example.com",
      "include_notice_address": true,
      "created_at": "2021-09-01T21:23:24.838Z",
      "updated_at": "2026-05-12T19:00:00.000Z"
    }
  }
}

json

application/json

Agreement Statuses Attachments

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

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

Update Organization

PATCH

https://api.commonpaper.com

/v1/organizations/{id}

Example: Rename the organization and update the billing email

Code
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

Code
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

object · required

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