• 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

Schemas

CreateReviewJsonBody

imported_file_id
​string · uuid · minLength: 1 · pattern: ^[0-9a-fA-F]{8}-[0-9… · required
playbook_id
​string · uuid · minLength: 1 · pattern: ^[0-9a-fA-F]{8}-[0-9…
review_type
​string · enum

Optional; when omitted the service chooses the review mode.

Enum values:
RedlineReview
SummaryReview

CreateReviewMultipartBody

file
​string · binary · required

Document upload; part name must be file.

playbook_id
​string · uuid · minLength: 1 · pattern: ^[0-9a-fA-F]{8}-[0-9…
review_type
​string · enum

Optional; when omitted the service chooses the review mode.

Enum values:
RedlineReview
SummaryReview

RedlineEvaluation

id
​string · uuid · required
commentary
​string · required
created_at
​string · date-time · required
evaluation
​string · required

Outcome for this redline (e.g. accept, needs_review)

redline_id
​string · uuid · required
redline_review_id
​string · uuid · required
relevant_rule_topics
​string[] · required
updated_at
​string · date-time · required
rejection_comment
​string | null

ReviewDownloadAuditUnsupportedMessage

message
​string · required

ReviewDownloadProcessedUnsupportedMessage

message
​string · required

ReviewDownloadZipUnsupportedError

error
​string · required

TopicbookRuleMetadata

id
​string · uuid · required
name
​string · required
questions
​string · required

Rule topic questions used to guide the summary position.

SummaryPosition

id
​string · uuid · required
created_at
​string · date-time · required
detailed_explanation
​string · required
document_references
​string[] · required
summary
​string · required
summary_review_id
​string · uuid · required
​TopicbookRuleMetadata · required
updated_at
​string · date-time · required

SummaryReviewFlagViolation

id
​string · uuid · required
decision
​string · enum · required

Recorded outcome for this flag violation.

Enum values:
exception_approved
issue_confirmed
created_at
​string · date-time · required
document_references
​string[] · required
reasoning
​string · required
remedy_suggested
​string · required
reviewer
​string · email · required

Email of the reviewer who recorded the decision.

rule
​string · required

Playbook rule text or summary that was evaluated.

summary_review_flag_id
​string · uuid · required
summary_review_id
​string · uuid · required
updated_at
​string · date-time · required

RedlineReviewAttributes

review_type
​string · const · required

Redline (diff) review with per-redline evaluations.

Const value: RedlineReview
​RedlineEvaluation[] · required

SummaryReviewAttributes

review_type
​string · const · required

Summary review with topic positions and optional flag violations.

Const value: SummaryReview
​SummaryPosition[] · required
​SummaryReviewFlagViolation[]

Optional playbook flag issues detected for this summary review.

RedlineReviewListAttributes

review_type
​string · const · required

Redline (diff) review. redline_evaluations are omitted on GET /v1/organizations/{organization_id}/reviews; use GET /v1/organizations/{organization_id}/reviews/{id}.

Const value: RedlineReview

SummaryReviewListAttributes

review_type
​string · const · required

Summary review. summary_positions and flag_violations are omitted on GET /v1/organizations/{organization_id}/reviews; use GET /v1/organizations/{organization_id}/reviews/{id}.

Const value: SummaryReview

ReviewAttributesList

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · review_type="RedlineReview"
type = object · review_type="SummaryReview"
Properties for Variant 1:
RedlineReviewListAttributes
review_type
​string · const · required

Redline (diff) review. redline_evaluations are omitted on GET /v1/organizations/{organization_id}/reviews; use GET /v1/organizations/{organization_id}/reviews/{id}.

Const value: RedlineReview

ReviewAttributes

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object · review_type="RedlineReview" · requires: redline_evaluations
type = object · review_type="SummaryReview" · requires: summary_positions
Properties for Variant 1:
RedlineReviewAttributes
review_type
​string · const · required

Redline (diff) review with per-redline evaluations.

Const value: RedlineReview
​RedlineEvaluation[] · required

ReviewResource

id
​string · uuid · required
type
​string · enum · required
Enum values:
review
​object · required

ReviewResourceList

id
​string · uuid · required
type
​string · enum · required
Enum values:
review
​object · required

ReviewResponse

​ReviewResource · required

ReviewsPagination

current
​integer · min: 1 · required

Current page number.

last
​integer · min: 1 · required

Last page number.

records
​integer · min: 0 · required

Total number of reviews across all pages.

next
​integer | null

Next page number, or null when the current page is the last page.

ReviewsListMeta

​ReviewsPagination · required

ReviewsListLinks

self
​string · uri · required

Collection URL without pagination query parameters.

current
​string · uri · required

URL for the current page (includes page[number]).

last
​string · uri · required

URL for the last page.

next
​string | null · uri

URL for the next page, or null when there is no next page.

ReviewsListResponse

​ReviewResourceList[] · required
​ReviewsListMeta · required
​ReviewsListLinks · required

RedlineEvaluationsListResponse

​RedlineEvaluation[] · required

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

RedlineEvaluationResponse

​RedlineEvaluation · required

CounterproposalResourceDataAttributes

Attributes on the nested **`counterproposal.data`** resource returned with a redline evaluation.
directive
​string | null · required

Instruction-style input from the client counterpropose request, or null.

suggested_counterproposal_text
​string | null · required

Gerri-generated suggested counterproposal text, or null.

created_at
​string · date-time · required
updated_at
​string · date-time · required
status
​string · enum · required

Processing state of the counterproposal.

Enum values:
completed
in_progress

PatchRedlineEvaluationAcceptAction

type
​string · const · required

Accept this redline evaluation.

Const value: accept

PatchRedlineEvaluationRejectAction

type
​string · const · required

Reject this redline evaluation.

Const value: reject

PatchRedlineEvaluationManualAction

type
​string · const · required

Mark outcome as manual handling.

Const value: manual

PatchRedlineEvaluationNeedsReviewAction

type
​string · const · required

Flag this evaluation as needing further review.

Const value: needs_review

PatchRedlineEvaluationCounterproposeAction

type
​string · const · required

Submit a counterproposal for this redline.

Const value: counterpropose
​required

Exactly one shape: an object with required string directive (instructional text), or an object with required string new_text (replacement copy). additionalProperties is false on each branch—do not send both keys.

PatchRedlineEvaluationBody

​required

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

comment
​string

Optional comment accompanying the evaluation update.

FlagViolationsListResponse

​SummaryReviewFlagViolation[] · required

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

FlagViolationResponse

​SummaryReviewFlagViolation · required

PatchFlagViolationBody

decision
​string · enum · required

User decision for this flag violation.

Enum values:
exception_approved
issue_confirmed

OrganizationResource

id
​string · uuid · required

Organization id (same as attributes id).

type
​string · enum · required
Enum values:
organization
​object · required

OrganizationResponse

​OrganizationResource · required

OrganizationsListResponse

​OrganizationResource[] · required

PatchOrganizationBody

name
​string · minLength: 1

New name for the organization. Omit this field to leave the name unchanged; if sent, the value must be a non-empty string.

default_reviewer_id
​string · uuid · minLength: 1 · pattern: ^[0-9a-fA-F]{8}-[0-9…

User id of the new default reviewer; must be an available reviewer for the organization. Omit this field to leave the reviewer unchanged; if sent, the value must be a canonical UUID string (8-4-4-4-12 hex digits).

PlaybookResource

id
​string · uuid · required
type
​string · enum · required
Enum values:
playbook
​object · required

PlaybooksListResponse

​PlaybookResource[] · required

PlaybookResponse

​PlaybookResource · required

PatchPlaybookBody

name
​string

New name for the playbook.

description
​string

New description for the playbook.

CreatePlaybookBody

name
​string · required

Name for the new playbook.

description
​string

Optional description for the new playbook.

PlaybookRule

id
​string · uuid · required
type
​string · enum · required
Enum values:
playbook_rule
​object · required

PlaybookRuleResponse

​PlaybookRule · required

PlaybookRulesListResponse

​PlaybookRule[] · required

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.

PatchPlaybookRuleBody

name
​string

Updated name for the rule.

description
​string

Updated description for the rule.

actions
​string

Updated actions for the rule.

ApiErrorResponse

error
​string · required

Human-readable error message.

ImportedFileResource

id
​string · uuid · required
type
​string · enum · required
Enum values:
imported_file
​object · required

ImportedFilesListResponse

​ImportedFileResource[] · required

InvitationResource

id
​string · uuid · required
type
​string · enum · required
Enum values:
invitation
​object · required

InvitationsListResponse

​InvitationResource[] · required

InvitationResponse

​InvitationResource · required

CreateInvitationBody

email
​string · email · required

Address to invite; must not already belong to a member of the organization.

name
​string

Optional display name when a new user record is created for this email.

On this page
  • CreateReviewJsonBody
  • CreateReviewMultipartBody
  • RedlineEvaluation
  • ReviewDownloadAuditUnsupportedMessage
  • ReviewDownloadProcessedUnsupportedMessage
  • ReviewDownloadZipUnsupportedError
  • TopicbookRuleMetadata
  • SummaryPosition
  • SummaryReviewFlagViolation
  • RedlineReviewAttributes
  • SummaryReviewAttributes
  • RedlineReviewListAttributes
  • SummaryReviewListAttributes
  • ReviewAttributesList
  • ReviewAttributes
  • ReviewResource
  • ReviewResourceList
  • ReviewResponse
  • ReviewsPagination
  • ReviewsListMeta
  • ReviewsListLinks
  • ReviewsListResponse
  • RedlineEvaluationsListResponse
  • RedlineEvaluationResponse
  • CounterproposalResourceDataAttributes
  • PatchRedlineEvaluationAcceptAction
  • PatchRedlineEvaluationRejectAction
  • PatchRedlineEvaluationManualAction
  • PatchRedlineEvaluationNeedsReviewAction
  • PatchRedlineEvaluationCounterproposeAction
  • PatchRedlineEvaluationBody
  • FlagViolationsListResponse
  • FlagViolationResponse
  • PatchFlagViolationBody
  • OrganizationResource
  • OrganizationResponse
  • OrganizationsListResponse
  • PatchOrganizationBody
  • PlaybookResource
  • PlaybooksListResponse
  • PlaybookResponse
  • PatchPlaybookBody
  • CreatePlaybookBody
  • PlaybookRule
  • PlaybookRuleResponse
  • PlaybookRulesListResponse
  • CreatePlaybookRuleBody
  • PatchPlaybookRuleBody
  • ApiErrorResponse
  • ImportedFileResource
  • ImportedFilesListResponse
  • InvitationResource
  • InvitationsListResponse
  • InvitationResponse
  • CreateInvitationBody