• 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

Invitations

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

Endpoints for listing, creating, and retrieving user invitations for the current organization.


List invitations

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

Lists invitations for the current organization, newest first. Each item includes the invitee email and name, who invited them (invited_by_email), and membership-related timestamps.

List invitations › 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 invitations › Responses

Invitations for the organization (may be an empty array)

  • dataobject[] · required
GET /v1/invitations

Create an invitation

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

Invites a user to the current organization by email. If no user exists with that email, one is created (using optional name). The invitee is added as an organization member and receives an invitation email. email is required and must be a valid address; the email must not already belong to a member of the organization.

Create an invitation › 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 an invitation › Request Body

  • emailstring · email · required

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

  • namestring

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

Create an invitation › Responses

Invitation created; returns the new invitation resource

  • dataobject · required
POST /v1/invitations

Retrieve an invitation

GET
https://api.gerri.commonpaper.com
/v1/invitations/{invitation_id}

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

Retrieve an invitation › path Parameters

  • invitation_idstring · uuid · required

    Invitation id

Retrieve an invitation › 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 an invitation › Responses

A single invitation

  • dataobject · required
GET /v1/invitations/{invitation_id}

Playbook RulesOrganization