• Documentation
  • API Reference
Information
Reviews
    Retrieve a reviewgetRetrieve all reviewsgetCreate a reviewpostList redline evaluations for a reviewgetRetrieve a single redline evaluationgetUpdate a redline evaluationpatchList flag violations for a reviewgetRetrieve a single flag violationgetUpdate a flag violationpatchDownload review bundle (ZIP)getDownload review audit documentgetDownload processed (redlined) contractgetDownload original uploaded contractget
Imported Files
    List imported filesget
Playbooks
    Retrieve all playbooksgetCreate a playbookpostRetrieve a playbookgetArchive a playbookdeleteUpdate a playbookpatch
Playbook Rules
    List playbook rulesgetCreate a playbook rulepostRetrieve a playbook rulegetDelete a playbook ruledeleteUpdate a playbook rulepatch
Invitations
    List invitationsgetCreate an invitationpostRetrieve an invitationget
Organization
    List organizationsgetRetrieve organizationgetUpdate organizationpatch
MCP
    MCP Serverpost
Schemas
powered by Zuplo
Gerri API
Gerri API

Playbook Rules

Endpoints for managing rules within a playbook.

List playbook rules

GET
https://api.gerri.commonpaper.com
/v1/organizations/{organization_id}/playbooks/{playbook_id}/playbook_rules

Returns all rules for the given playbook, scoped to the current organization.

List playbook rules › path Parameters

organization_id
​string · uuid · required

Organization id

playbook_id
​string · uuid · required

Parent playbook id

List playbook rules › 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 playbook rules › Responses

A list of playbook rules

PlaybookRulesListResponse
​PlaybookRule[] · required
GET/v1/organizations/{organization_id}/playbooks/{playbook_id}/playbook_rules
curl https://api.gerri.commonpaper.com/v1/organizations/:organization_id/playbooks/:playbook_id/playbook_rules \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": [ { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "type": "playbook_rule", "attributes": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Limitation of Liability", "description": "Liability must be capped at the total fees paid in the prior 12 months.", "actions": "Flag any clause that removes or exceeds the liability cap.", "playbook_id": "e19796c2-26c7-413f-bb8b-4f141a539db9", "created_at": "2026-04-09T13:53:17.095Z", "updated_at": "2026-04-09T13:53:17.095Z" } }, { "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "type": "playbook_rule", "attributes": { "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "name": "Auto-Renewal Notice", "description": "Contracts with auto-renewal must include a defined opt-out notice period.", "actions": "Reject any auto-renewal clause that lacks a notice period of at least 15 days.", "playbook_id": "e19796c2-26c7-413f-bb8b-4f141a539db9", "created_at": "2026-04-09T13:54:00.000Z", "updated_at": "2026-04-09T13:54:00.000Z" } } ] }
json
application/json

Create a playbook rule

POST
https://api.gerri.commonpaper.com
/v1/organizations/{organization_id}/playbooks/{playbook_id}/playbook_rules

Creates a new rule under the given playbook. name and actions are required; description is optional.

Create a playbook rule › path Parameters

organization_id
​string · uuid · required

Organization id

playbook_id
​string · uuid · required

Parent playbook id

Create a playbook rule › 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.

Create a playbook rule › Request Body

CreatePlaybookRuleBody
name
​string · required

Name for the rule.

actions
​string · required

Actions to take when this rule is triggered.

description
​string

Optional description for the rule.

Create a playbook rule › Responses

Playbook rule created; returns the new rule resource

PlaybookRuleResponse
​PlaybookRule · required
POST/v1/organizations/{organization_id}/playbooks/{playbook_id}/playbook_rules
curl https://api.gerri.commonpaper.com/v1/organizations/:organization_id/playbooks/:playbook_id/playbook_rules \ --request POST \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "name": "Limitation of Liability", "actions": "Flag any clause that removes or exceeds the liability cap." }'
Example Request Body
{ "name": "Limitation of Liability", "actions": "Flag any clause that removes or exceeds the liability cap." }
json
application/json
Example Responses
{ "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "type": "playbook_rule", "attributes": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Limitation of Liability", "description": "Liability must be capped at the total fees paid in the prior 12 months.", "actions": "Flag any clause that removes or exceeds the liability cap.", "playbook_id": "e19796c2-26c7-413f-bb8b-4f141a539db9", "created_at": "2026-04-09T13:53:17.095Z", "updated_at": "2026-04-09T13:53:17.095Z" } } }
json
application/json

Retrieve a playbook rule

GET
https://api.gerri.commonpaper.com
/v1/organizations/{organization_id}/playbooks/{playbook_id}/playbook_rules/{rule_id}

Returns one rule by id under the given playbook, scoped to the current organization.

Retrieve a playbook rule › path Parameters

organization_id
​string · uuid · required

Organization id

playbook_id
​string · uuid · required

Parent playbook id

rule_id
​string · uuid · required

Playbook rule id

Retrieve a playbook rule › 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.

Retrieve a playbook rule › Responses

A single playbook rule

PlaybookRuleResponse
​PlaybookRule · required
GET/v1/organizations/{organization_id}/playbooks/{playbook_id}/playbook_rules/{rule_id}
curl https://api.gerri.commonpaper.com/v1/organizations/:organization_id/playbooks/:playbook_id/playbook_rules/:rule_id \ --header 'Authorization: Bearer <token>'
Example Responses
{ "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "type": "playbook_rule", "attributes": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Limitation of Liability", "description": "Liability must be capped at the total fees paid in the prior 12 months.", "actions": "Flag any clause that removes or exceeds the liability cap.", "playbook_id": "e19796c2-26c7-413f-bb8b-4f141a539db9", "created_at": "2026-04-09T13:53:17.095Z", "updated_at": "2026-04-09T13:53:17.095Z" } } }
json
application/json

Delete a playbook rule

DELETE
https://api.gerri.commonpaper.com
/v1/organizations/{organization_id}/playbooks/{playbook_id}/playbook_rules/{rule_id}

Permanently deletes one rule by id under the given playbook.

Delete a playbook rule › path Parameters

organization_id
​string · uuid · required

Organization id

playbook_id
​string · uuid · required

Parent playbook id

rule_id
​string · uuid · required

Playbook rule id

Delete a playbook rule › 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.

Delete a playbook rule › Responses

Playbook rule deleted; no content returned

No data returned
DELETE/v1/organizations/{organization_id}/playbooks/{playbook_id}/playbook_rules/{rule_id}
curl https://api.gerri.commonpaper.com/v1/organizations/:organization_id/playbooks/:playbook_id/playbook_rules/:rule_id \ --request DELETE \ --header 'Authorization: Bearer <token>'
Example Responses
No example specified for this content type

Update a playbook rule

PATCH
https://api.gerri.commonpaper.com
/v1/organizations/{organization_id}/playbooks/{playbook_id}/playbook_rules/{rule_id}

Updates one or more fields on a single playbook rule. Send only the fields you want to change.

Update a playbook rule › path Parameters

organization_id
​string · uuid · required

Organization id

playbook_id
​string · uuid · required

Parent playbook id

rule_id
​string · uuid · required

Playbook rule id

Update a playbook rule › 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 a playbook rule › Request Body

PatchPlaybookRuleBody
name
​string

Updated name for the rule.

description
​string

Updated description for the rule.

actions
​string

Updated actions for the rule.

Update a playbook rule › Responses

Updated playbook rule

PlaybookRuleResponse
​PlaybookRule · required
PATCH/v1/organizations/{organization_id}/playbooks/{playbook_id}/playbook_rules/{rule_id}
curl https://api.gerri.commonpaper.com/v1/organizations/:organization_id/playbooks/:playbook_id/playbook_rules/:rule_id \ --request PATCH \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' \ --data '{ "name": "Updated Rule Name" }'
Example Request Body
{ "name": "Updated Rule Name" }
json
application/json
Example Responses
{ "data": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "type": "playbook_rule", "attributes": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Updated Rule Name", "description": "Updated description.", "actions": "Reject any clause that removes the liability cap.", "playbook_id": "e19796c2-26c7-413f-bb8b-4f141a539db9", "created_at": "2026-04-09T13:53:17.095Z", "updated_at": "2026-04-30T15:00:00.000Z" } } }
json
application/json
PlaybooksInvitations