• Documentation
  • API Reference
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
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
    Retrieve organizationgetUpdate organizationpatch
Other endpoints
    MCP Serverpost
Schemas
powered by Zudoku
Gerri API

Playbook Rules

Endpoint:https://api.gerri.commonpaper.com

Endpoints for managing rules within a playbook.

List playbook rules

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

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

List playbook rules › path Parameters

  • playbook_idstring · uuid · required

    Parent playbook id

List playbook rules › Headers

  • Authorizationstring · 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

  • dataobject[] · required
GET /v1/playbooks/{playbook_id}/playbook_rules

Create a playbook rule

POST
https://api.gerri.commonpaper.com
/v1/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

  • playbook_idstring · uuid · required

    Parent playbook id

Create a playbook rule › Headers

  • Authorizationstring · 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

  • namestring · required

    Name for the rule.

  • actionsstring · required

    Actions to take when this rule is triggered.

  • descriptionstring

    Optional description for the rule.

Create a playbook rule › Responses

Playbook rule created; returns the new rule resource

  • dataobject · required
POST /v1/playbooks/{playbook_id}/playbook_rules

Retrieve a playbook rule

GET
https://api.gerri.commonpaper.com
/v1/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

  • playbook_idstring · uuid · required

    Parent playbook id

  • rule_idstring · uuid · required

    Playbook rule id

Retrieve a playbook rule › Headers

  • Authorizationstring · 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

  • dataobject · required
GET /v1/playbooks/{playbook_id}/playbook_rules/{rule_id}

Delete a playbook rule

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

Permanently deletes one rule by id under the given playbook.

Delete a playbook rule › path Parameters

  • playbook_idstring · uuid · required

    Parent playbook id

  • rule_idstring · uuid · required

    Playbook rule id

Delete a playbook rule › Headers

  • Authorizationstring · 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/playbooks/{playbook_id}/playbook_rules/{rule_id}

Update a playbook rule

PATCH
https://api.gerri.commonpaper.com
/v1/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

  • playbook_idstring · uuid · required

    Parent playbook id

  • rule_idstring · uuid · required

    Playbook rule id

Update a playbook rule › Headers

  • Authorizationstring · 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

  • namestring

    Updated name for the rule.

  • descriptionstring

    Updated description for the rule.

  • actionsstring

    Updated actions for the rule.

Update a playbook rule › Responses

Updated playbook rule

  • dataobject · required
PATCH /v1/playbooks/{playbook_id}/playbook_rules/{rule_id}
PlaybooksInvitations