Invitations

Invite users to your organization and view the status of outstanding invitations

List Invitations

GET

https://api.commonpaper.com

/v1/invitations

Returns the list of invitations belonging to your organization. Useful for reconciling invitation state without waiting on accept/decline webhooks.

Example: List all pending invitations

Code
curl -g "https://api.commonpaper.com/v1/invitations?filter[status_eq]=pending" \
  -H "Authorization: Bearer YOUR_API_KEY"

Note: the -g flag turns off curl's URL globbing so the square brackets in filter[status_eq] are passed through verbatim.

List Invitations › query Parameters

filter[status_eq]

string · enum

Filter invitations by status.

Enum values:

pending

accepted

declined

filter[access_eq]

string · enum

Filter invitations by access level.

Enum values:

admin

standard

filter[source_email_eq]

string

Filter invitations by the inviter's email.

page[number]

integer

Page number to retrieve. Defaults to 1.

Default: 1

page[size]

integer

Number of records per page. Defaults to 30.

Default: 30

List Invitations › Headers

Authorization

string · 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

Create Invitation

POST

https://api.commonpaper.com

/v1/invitations

Invites a user to your Common Paper organization by email. Mirrors the in-app invitation flow: the invitee is registered with Auth0 (creating a User if needed), a pending Invitation is saved, and a membership invite email is queued.

Example: Invite a teammate as a standard user

Code
curl -X POST "https://api.commonpaper.com/v1/invitations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "invitation": {
      "email": "newperson@example.com",
      "access": "standard",
      "inviter_email": "admin@example.com"
    }
  }'

Returns 422 if email is missing, if inviter_email does not belong to an existing member of this organization, or if the invitee is already a member.

Create Invitation › Headers

Authorization

string · 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 Invitation › Request Body

invitation-create-schema

object · required

The invitation to create.

Create Invitation › Responses

Created

POST/v1/invitations

curl https://api.commonpaper.com/v1/invitations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "invitation": {
    "email": "newperson@example.com",
    "inviter_email": "admin@example.com",
    "access": "standard"
  }
}'

Example Request Body

{
  "invitation": {
    "email": "newperson@example.com",
    "inviter_email": "admin@example.com",
    "access": "standard"
  }
}

json

Example Responses

{
  "data": {
    "id": "INVITATION_UUID",
    "type": "invitation",
    "attributes": {
      "email": "newperson@example.com",
      "access": "standard",
      "status": "pending",
      "source_email": "admin@example.com",
      "organization_id": "ORGANIZATION_UUID",
      "user_id": "USER_UUID",
      "created_at": "2026-05-12T18:00:00.000Z",
      "updated_at": "2026-05-12T18:00:00.000Z"
    }
  }
}

json

application/json

Get Invitation

GET

https://api.commonpaper.com

/v1/invitations/{id}

Returns a single invitation belonging to your organization. Returns 404 if the invitation belongs to a different organization.

Get Invitation › path Parameters

id

string · uuid · required

The UUID of the invitation.

Get Invitation › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Invitation › Responses

Users Agreement Types