3.0.0
Search
K
Links

Organization invitations requests

Frontend API endpoints to invite users to an organization and manage the invitations

Available requests

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

The organization invitation object

{
"object": "organization_invitation",
"id": "orginv_21Ufcy98STcA11s3QckIwtwHIES",
"email_address": "[email protected]",
"organization_id": "org_1o4qfak5AdI2qlXSXENGL05iei6",
"public_metadata": {},
"role": "basic_member",
"status": "pending",
"created_at": 1638000669544,
"updated_at": 1638000669544
}
post
https://clerk.example.com
/v1/organizations/:organization_id/invitations
Create an organization invitation
post
https://clerk.example.com
/v1/organizations/:organization_id/invitations/:invitation_id/revoke
Revoke a pending organization invitation
get
https://clerk.example.com
/v1/organizations/:organization_id/invitations/pending
Retrieve a list of pending invitations for an organization