Skip to main content
POST
Add Org Members

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgSlug
string
required

Body

application/json
users
object[]
required

Members to add. Each entry carries its own role and groups.

skipExisting
boolean

When true, members already in the org are silently skipped instead of triggering a 409. Useful for idempotent bulk imports / round-tripping a CSV export. Returns only the actually created memberships.

sendInvite
boolean

When false, suppresses the automatic OrgInvite email for unknown emails. Defaults to true. Useful for bulk imports where email notifications are not desired.

Response

Members added

orgSlug
string
required
userId
string
required
status
enum<string>
required
Available options:
active,
invited,
suspended
id
string
roleSlug
string
invitedBy
string
invitedAt
string
inviteEmail
string
inviteToken
string
joinedAt
string
joinedVia
enum<string>
Available options:
direct,
invite-code,
invite-email,
auto-join,
join-rule
groups
string[]

Org group slugs the user belongs to. Only populated on listOrgMembers when includeGroups=true.

pendingGroups
string[]

Group slugs to add the user to once they accept their invite. Set at import time for pending/invited members; cleared and applied as real group memberships when the invite is claimed.

createdBy
string
updatedBy
string
createdAt
string
updatedAt
string