REST API endpoints for Organization Invitations

List pending invitations

GET /orgs/{orgId}/invitations

List all pending invitations for an organization.

Authentication

Authentication is required.

Requires MEMBER_CREATE permission in the organization.

Learn more about authentication

Path Parameters

orgIdstringRequired

The slug or ID of the organization.

Response Body Content-Type: application/json

This API endpoint returns standard API response format. The following fields are fields of the data object. Learn more

arrayRequired

The array of pending invitations.

idstringRequired

The unique identifier of the user.

namestringRequired

The display name of the user.

usernamestringRequired

The username of the user.

member_rolestringRequired

The role of the user in the organization.

permissionsarrayRequired

The permissions that the user will have in the organization.

acceptedbooleanRequired

Always false for invitations in this endpoint.

Create an invitation

POST /orgs/{orgId}/invitations

Invite a user to join an organization.

Authentication

Authentication is required.

Authenticated user must be the owner ora member with MEMBER_CREATE permission in the organization.

Learn more about authentication

Path Parameters

orgIdstringRequired

The slug or ID of the organization.

Request Body Content-Type: application/json

inviteestringRequired

The username or user ID of the user to invite.

rolestring

The role of the user in the organization. Defaults to empty string.

permissionsarray

The permissions that the user will have in the organization. Defaults to empty array.

Accept an invitation

PATCH /orgs/{orgId}/invitations/{userId}

Accept a pending invitation. Only the invited user can accept their own invitation.

Authentication

Authentication is required.

Must be the invited user.

Learn more about authentication

Path Parameters

orgIdstringRequired

The slug or ID of the organization.

userIdstringRequired

The username or ID of the invited user. Must match the authenticated user.

Cancel or reject an invitation

DELETE /orgs/{orgId}/invitations/{userId}

Cancel a pending invitation (by authorized member) or reject an invitation (by invitee).

Authentication

Authentication is required.

Must be the invited user or a member with MEMBER_CREATE permission.

Learn more about authentication

Path Parameters

orgIdstringRequired

The slug or ID of the organization.

userIdstringRequired

The username or ID of the invited user.