REST API endpoints for Organization Invitations
List pending invitations
Section titled “List pending invitations”/orgs/{orgId}/invitations List all pending invitations for an organization.
Authentication is required.
Requires MEMBER_CREATE permission in the organization.
orgId string Required The slug or ID of the organization.
This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more
The array of pending invitations.
id string Required The unique identifier of the user.
name string Required The display name of the user.
username string Required The username of the user.
member_role string Required The role of the user in the organization.
permissions array Required The permissions that the user will have in the organization.
accepted boolean Required Always false for invitations in this endpoint.
Create an invitation
Section titled “Create an invitation”/orgs/{orgId}/invitations Invite a user to join an organization.
Authentication is required.
Authenticated user must be the owner ora member with MEMBER_CREATE permission in the organization.
orgId string Required The slug or ID of the organization.
invitee string Required The username or user ID of the user to invite.
role string The role of the user in the organization. Defaults to empty string.
permissions array The permissions that the user will have in the organization. Defaults to empty array.
Accept an invitation
Section titled “Accept an invitation”/orgs/{orgId}/invitations/{userId} Accept a pending invitation. Only the invited user can accept their own invitation.
orgId string Required The slug or ID of the organization.
userId string Required The username or ID of the invited user. Must match the authenticated user.
Cancel or reject an invitation
Section titled “Cancel or reject an invitation”/orgs/{orgId}/invitations/{userId} Cancel a pending invitation (by authorized member) or reject an invitation (by invitee).
Authentication is required.
Must be the invited user or a member with MEMBER_CREATE permission.
orgId string Required The slug or ID of the organization.
userId string Required The username or ID of the invited user.