• 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

Playbooks

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

Endpoints for listing and retrieving playbooks for the current organization.

Retrieve all playbooks

GET
https://api.gerri.commonpaper.com
/v1/playbooks

Lists all playbooks for the current organization.

Retrieve all playbooks › 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 all playbooks › Responses

A list of playbooks for the organization

  • dataobject[] · required
GET /v1/playbooks

Create a playbook

POST
https://api.gerri.commonpaper.com
/v1/playbooks

Creates a new playbook for the current organization. name is required; description is optional.

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

  • namestring · required

    Name for the new playbook.

  • descriptionstring

    Optional description for the new playbook.

Create a playbook › Responses

Playbook created; returns the new playbook resource

  • dataobject · required
POST /v1/playbooks

Retrieve a playbook

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

Shows one playbook for the current organization (by id).

Retrieve a playbook › path Parameters

  • playbook_idstring · uuid · required

    Playbook id

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

A single playbook

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

Archive a playbook

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

Archives one playbook for the current organization (by id).

Archive a playbook › path Parameters

  • playbook_idstring · uuid · required

    Playbook id

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

Archive a playbook › Responses

Playbook archived; no content returned

No data returned
DELETE /v1/playbooks/{playbook_id}

Update a playbook

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

Updates the name and/or description of a single playbook. Send only the fields you want to change.

Update a playbook › path Parameters

  • playbook_idstring · uuid · required

    Playbook id

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

  • namestring

    New name for the playbook.

  • descriptionstring

    New description for the playbook.

Update a playbook › Responses

Updated playbook

  • dataobject · required
PATCH /v1/playbooks/{playbook_id}
ReviewsPlaybook Rules