• 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

Reviews

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

Endpoints for creating, listing, and retrieving contract reviews for the current organization.

Retrieve a review

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

Shows one review for the current organization (by id). Includes nested redline_evaluations, summary_positions, and flag_violations when applicable—the paginated GET /v1/reviews index omits those for each item.

Retrieve a review › path Parameters

  • idstring · uuid · required

    Review id

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

A single review

  • dataobject · required
GET /v1/reviews/{id}

Retrieve all reviews

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

Lists reviews for the current organization with pagination (page[number]). The default page size is 30 reviews per page.

Each list item includes core review fields and review_type only. redline_evaluations, summary_positions (per-topic summaries), and flag_violations are not included here; they appear on GET /v1/reviews/{id} (and on the dedicated nested collection endpoints where applicable).

Retrieve all reviews › query Parameters

  • page[number]integer · min: 1

    Page number for the review list (defaults to 1 when omitted). Each page returns up to 30 reviews by default.

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

A paginated list of reviews for the organization (data, meta.pagination, and links are siblings).

  • dataobject[] · required
  • metaobject · required
  • linksobject · required
GET /v1/reviews

Create a review

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

Start a new review in one of two ways: point at an import you already uploaded with a small application/json body (imported_file_id, optional playbook_id, optional review_type), or upload the contract directly with multipart/form-data using a file part (playbook_id and review_type optional there too). review_type must be RedlineReview or SummaryReview when you send it. Don't send imported_file_id on multipart—that path is only for new files. A 201 response uses the same JSON:API review resource as GET /v1/reviews/{id} (full attributes, including nested evaluations or summary data when present); the create call itself is just flat JSON or multipart, not a JSON:API request document.

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

  • imported_file_idstring · uuid · required
  • playbook_idstring · uuid
  • review_typestring · enum

    Optional; when omitted the service chooses the review mode.

    Enum values:
    RedlineReview
    SummaryReview
  • filestring · binary · required

    Document upload; part name must be file.

  • playbook_idstring · uuid
  • review_typestring · enum

    Optional; when omitted the service chooses the review mode.

    Enum values:
    RedlineReview
    SummaryReview

Create a review › Responses

Review created; returns the new review resource

  • dataobject · required
POST /v1/reviews

List redline evaluations for a review

GET
https://api.gerri.commonpaper.com
/v1/reviews/{review_id}/redline_evaluations

Returns every redline evaluation for the given review, scoped to the current organization. This applies to redline reviews (review_type: RedlineReview); the list matches the redline_evaluations array on the review resource from GET /v1/reviews/{id}.

List redline evaluations for a review › path Parameters

  • review_idstring · uuid · required

    Review id (must be a redline review to contain evaluations)

List redline evaluations for a review › 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 redline evaluations for a review › Responses

Evaluations for the review (may be an empty array while processing or if none apply)

  • dataobject[] · required

    Redline evaluations for the review (same objects as attributes.redline_evaluations on a RedlineReview resource).

GET /v1/reviews/{review_id}/redline_evaluations

Retrieve a single redline evaluation

GET
https://api.gerri.commonpaper.com
/v1/reviews/{review_id}/redline_evaluations/{evaluation_id}

Returns one redline evaluation by id under the given review, scoped to the current organization. The payload matches a single element of redline_evaluations on GET /v1/reviews/{id}. When a counterproposal exists, attributes.counterproposal is included as a JSON:API-style object with nested data (type counterproposal, id, attributes including directive, suggested_counterproposal_text, created_at, updated_at, and status). Nested attributes.status is always completed or in_progress. When there is no counterproposal, the counterproposal key is omitted from attributes (never null).

Retrieve a single redline evaluation › path Parameters

  • review_idstring · uuid · required

    Parent review id

  • evaluation_idstring · uuid · required

    Redline evaluation id

Retrieve a single redline evaluation › 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 single redline evaluation › Responses

The requested redline evaluation

  • dataobject · required
GET /v1/reviews/{review_id}/redline_evaluations/{evaluation_id}

Update a redline evaluation

PATCH
https://api.gerri.commonpaper.com
/v1/reviews/{review_id}/redline_evaluations/{evaluation_id}

Updates how a single redline evaluation is classified. Send a required evaluation object (discriminated by type) and an optional top-level comment. Simple outcomes are accept, reject, manual, and needs_review (each is only type). counterpropose adds a required counterproposal: either an object { directive } (instruction text) or { new_text } (replacement copy)—exactly one of those two shapes. Applies only to the evaluation identified by evaluation_id under the given review.

Update a redline evaluation › path Parameters

  • review_idstring · uuid · required

    Parent review id

  • evaluation_idstring · uuid · required

    Redline evaluation id

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

  • evaluationrequired

    Outcome and payload for this redline evaluation. Discriminated by type; see oneOf variants below.

  • commentstring

    Optional comment accompanying the evaluation update.

Update a redline evaluation › Responses

Updated redline evaluation (same JSON:API data shape as GET). When a counterproposal exists, attributes.counterproposal is a nested JSON:API document { "data": { "id", "type": "counterproposal", "attributes": { … } } }; nested attributes.status is completed or in_progress. Otherwise the counterproposal key is omitted (see GET examples).

  • dataobject · required
PATCH /v1/reviews/{review_id}/redline_evaluations/{evaluation_id}

List flag violations for a review

GET
https://api.gerri.commonpaper.com
/v1/reviews/{review_id}/flag_violations

Returns every summary-review flag violation for the given review, scoped to the current organization. This applies to summary reviews (review_type: SummaryReview); the list matches the flag_violations array on the review resource from GET /v1/reviews/{id}.

List flag violations for a review › path Parameters

  • review_idstring · uuid · required

    Review id (must be a summary review to contain flag violations)

List flag violations for a review › 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 flag violations for a review › Responses

Flag violations for the review (may be an empty array if none were detected)

  • dataobject[] · required

    Flag violations for the review (same objects as attributes.flag_violations on a SummaryReview resource).

GET /v1/reviews/{review_id}/flag_violations

Retrieve a single flag violation

GET
https://api.gerri.commonpaper.com
/v1/reviews/{review_id}/flag_violations/{flag_violation_id}

Returns one flag violation by id under the given review, scoped to the current organization. The payload matches a single element of flag_violations on GET /v1/reviews/{id}.

Retrieve a single flag violation › path Parameters

  • review_idstring · uuid · required

    Parent review id

  • flag_violation_idstring · uuid · required

    Flag violation id

Retrieve a single flag violation › 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 single flag violation › Responses

The requested flag violation

  • dataobject · required
GET /v1/reviews/{review_id}/flag_violations/{flag_violation_id}

Update a flag violation

PATCH
https://api.gerri.commonpaper.com
/v1/reviews/{review_id}/flag_violations/{flag_violation_id}

Records a user decision for a single flag violation: either exception_approved (the exception is accepted) or issue_confirmed (the issue stands). Applies only to the violation identified by flag_violation_id under the given review.

Update a flag violation › path Parameters

  • review_idstring · uuid · required

    Parent review id

  • flag_violation_idstring · uuid · required

    Flag violation id

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

  • decisionstring · enum · required

    User decision for this flag violation.

    Enum values:
    exception_approved
    issue_confirmed

Update a flag violation › Responses

Updated flag violation

  • dataobject · required
PATCH /v1/reviews/{review_id}/flag_violations/{flag_violation_id}

Download review bundle (ZIP)

GET
https://api.gerri.commonpaper.com
/v1/reviews/{review_id}/downloads

Downloads a .zip archive containing the original contract, processed (redlined) document, and audit trail for a RedlineReview.

SummaryReview is not supported — this endpoint returns 422 for summary reviews. Use GET /v1/reviews/{review_id}/downloads/original instead.

Example:

Code
 
GET /v1/reviews/{review_id}/downloads

Download review bundle (ZIP) › path Parameters

  • review_idstring · uuid · required

    Review id

Download review bundle (ZIP) › 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.

Download review bundle (ZIP) › Responses

string · binary
GET /v1/reviews/{review_id}/downloads

Download review audit document

GET
https://api.gerri.commonpaper.com
/v1/reviews/{review_id}/downloads/audit

Downloads the audit document for a RedlineReview.

SummaryReview is not supported — returns 422. Use GET /v1/reviews/{review_id}/downloads/original for summary reviews.

Example:

Code
 
GET /v1/reviews/{review_id}/downloads/audit

Download review audit document › path Parameters

  • review_idstring · uuid · required

    Review id

Download review audit document › 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.

Download review audit document › Responses

string · binary
GET /v1/reviews/{review_id}/downloads/audit

Download processed (redlined) contract

GET
https://api.gerri.commonpaper.com
/v1/reviews/{review_id}/downloads/processed

Downloads the processed (redlined) contract for a RedlineReview.

SummaryReview is not supported — returns 422. Use GET /v1/reviews/{review_id}/downloads/original for summary reviews.

Example:

Code
 
GET /v1/reviews/{review_id}/downloads/processed

Download processed (redlined) contract › path Parameters

  • review_idstring · uuid · required

    Review id

Download processed (redlined) contract › 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.

Download processed (redlined) contract › Responses

string · binary
GET /v1/reviews/{review_id}/downloads/processed

Download original uploaded contract

GET
https://api.gerri.commonpaper.com
/v1/reviews/{review_id}/downloads/original

Downloads the original uploaded contract (.docx or .pdf, depending on the upload). Supported for both RedlineReview and SummaryReview — this is the only download path available for summary reviews.

Example:

Code
 
GET /v1/reviews/{review_id}/downloads/original

Download original uploaded contract › path Parameters

  • review_idstring · uuid · required

    Review id

Download original uploaded contract › 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.

Download original uploaded contract › Responses

string · binary
GET /v1/reviews/{review_id}/downloads/original
Playbooks