3.0.0
Organization Invitations
Backend API endpoints to invite users to an organization and manage invitations
Organizations is a premium feature. Please get in touch if you would like us to enable it for your account. You can contact us at [email protected].
Overview
Organization invitations related requests which allow you to invite new users to an organization and manage invitations.
Available requests
POST /v1/organizations/:id/invitationsGET /v1/organizations/:id/invitations/pendingPOST /v1/organizations/:organization_id/invitations/:invitation_id/revoke
Example organization invitation schema
1
{
2
"object": "organization_invitation",
3
"id": "orginv_21Ufcy98STcA11s3QckIwtwHIES",
4
"email_address": "[email protected]",
5
"role": "basic_member",
6
"organization_id": "org_A1Ufcy88STc111s3QckIwtw956e",
7
"status": "pending",
8
"created_at": 1638000669544,
9
"updated_at": 1638000669544
10
}
Copied!
post
https://api.clerk.dev
/v1/organizations/:id/invitation
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
Last modified 1mo ago