Invite a teammate by email
Creates a pending invitation for the given email and sends a magic-link email so the invitee can join the organization. The response is { success, invitation }; outside production it also includes magicLinkUrl for testing (it is omitted in production, where the link is delivered by email only). Requires a Nevermined API key. Requires organization admin privileges. Requires the organization to be on the Premium tier or higher.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Organization ID
"org-abc123"
Body
Email address of the person to invite
254"colleague@example.com"
Display name of the invitee. Used to greet them in the email.
120"Jane Doe"
Role to assign in the organization
Admin, Member "Member"
Response
Invitation created
"oi-550e8400-e29b-41d4-a716-446655440000"
"colleague@example.com"
Admin, Member pending, accepted, revoked, expired "Jane Doe"
Related topics
Workspaces & MembersOrganizations & WorkspacesAPI error codesOrganizationsProgrammatic & Agentic Access