Invite users to your organization and view the status of outstanding invitations
List 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
Note: the -g flag turns off curl's URL globbing so the square brackets in filter[status_eq] are passed through verbatim.
query Parameters
filter[status_eq]Filter invitations by status.
filter[access_eq]Filter invitations by access level.
filter[source_email_eq]Filter invitations by the inviter's email.
page[number]Page number to retrieve. Defaults to 1.
page[size]Number of records per page. Defaults to 30.
Headers
AuthorizationThe 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
OK
Create Invitation
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
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.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Create Invitation › Responses
Created
Get Invitation
Returns a single invitation belonging to your organization. Returns 404 if the invitation belongs to a different organization.
path Parameters
idThe UUID of the invitation.
Headers
AuthorizationThe 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
OK