3.0.0
Search…
⌃K
Links

Organization Invitations

Backend API endpoints to invite users to an organization and manage invitations

Overview

Organization invitations related requests which allow you to invite new users to an organization and manage invitations.

Available requests

  • POST /v1/organizations/:id/invitations
  • GET /v1/organizations/:id/invitations/pending
  • POST /v1/organizations/:organization_id/invitations/:invitation_id/revoke

Example organization invitation schema

{
"object": "organization_invitation",
"id": "orginv_21Ufcy98STcA11s3QckIwtwHIES",
"email_address": "[email protected]",
"organization_id": "org_A1Ufcy88STc111s3QckIwtw956e",
"public_metadata": {},
"role": "basic_member",
"status": "pending",
"created_at": 1638000669544,
"updated_at": 1638000669544
}
post
https://api.clerk.dev
/v1/organizations/:id/invitations
Create and send an organization invitation
get
https://api.clerk.dev
/v1/organizations/:id/invitations/pending
Get a list of pending organization invitations
post
https://api.clerk.dev
/v1/organizations/:organization_id/invitations/:invitation_id/revoke
Revoke a pending organization invitation