Skip to main content
POST
Invite Organization Member

Authorizations

Authorization
string
header
required

API key or session token (Bearer)

Body

application/json
email
string
required

The email address of the user to invite

role
required

The role(s) to assign to the user. It can be admin, member, owner. Eg: "member"

organizationId
string

The organization ID to invite the user to

resend
boolean

Resend the invitation email, if the user is already invited. Eg: true

teamId
projectAccess
enum<string>

"all" (the default) gives access to every project. "selected" limits the new member to projectIds once they accept.

Available options:
all,
selected
projectIds
string[]

Projects the new member can access when projectAccess is "selected". They must belong to the workspace, and an inviter whose own access is limited can only choose projects they can access.

Response

Success

id
string
required
email
string
required
role
string
required
organizationId
string
required
inviterId
string
required
status
string
required
expiresAt
string
required
createdAt
string
required
projectAccess
enum<string>
required

"all" gives access to every project once accepted; "selected" limits the member to projectIds.

Available options:
all,
selected
projectIds
string[]
required

Projects the invitation grants when projectAccess is "selected". Only projects the viewer can access are listed.