Gerri API

The Gerri API is a REST API for managing contract reviews for your organization—powered by Gerri from Common Paper. Responses follow a JSON shape (data, meta, links where applicable), and operations are scoped to the current organization for the caller.

Use this portal to explore request and response schemas, examples, and every operation we publish.

What you can do

• Reviews — List reviews with pagination (GET /v1/reviews, default page size 30), fetch a full review by id (GET /v1/reviews/{id}), and create a review with either JSON (imported_file_id, optional playbook_id, optional review_type) or multipart/form-data with a file part (POST /v1/reviews).
• Review types — RedlineReview (tracked changes and redline evaluations) and SummaryReview (topic summaries and flag violations). The list endpoint returns core fields only; GET /v1/reviews/{id} includes nested redline_evaluations, summary_positions, and flag_violations when they apply.
• Nested resources — List and update redline evaluations and flag violations under a review, or use the dedicated collection endpoints where you need them.
• Playbooks & rules — List and manage playbooks and playbook rules for your organization (/v1/playbooks, nested rule routes).
• Downloads — Fetch original, processed, or audit artifacts for a review where supported (see each operation for review-type constraints).

Support

Questions or issues? Email support@commonpaper.com or visit Common Paper support.