Endpoints for listing, creating, and retrieving user invitations for the current organization.
List 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.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Invitations for the organization (may be an empty array)
dataobject[] · required
Create an invitation
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.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
emailstring · email · requiredAddress to invite; must not already belong to a member of the organization.
namestringOptional display name when a new user record is created for this email.
Responses
Invitation created; returns the new invitation resource
dataobject · required
Retrieve an invitation
Shows one invitation for the current organization (by id).
path Parameters
invitation_idstring · uuid · requiredInvitation id
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
A single invitation
dataobject · required