Home
Search…
3.0.0
Welcome to Clerk API Reference
Clerk's Guides and Docs
Questions? We're here for you.
Upgrading to v3
Component Reference
Introduction
Sign-in
Sign-up
User Profile
<UserButton />
<SignedIn>
<SignedOut>
<SignInWithMetamaskButton/>
Customization
Control components
API Reference
ClerkJS
Clerk React
Clerk Expo
Backend API
Introduction
SDKs
Allowlist Identifiers
Clients
Invitations
Emails
Organizations
Organization invitations
Redirect URLs
Sessions
Sign In Tokens
SMS Messages
Users
Beta Features
Frontend API
Social Login
Import users
Export users and data
Webhooks
Learning Center
Security
Build Frontend First
Powered By
GitBook
Invitations
Learn how to handle invitations via the backend API
Overview
This resource provides the necessary methods to create, revoke and list your invitations. For more information on how invitations work, refer to our
Invitations
guide.
Available requests
POST
/v1/invitations
GET
/v1/invitations
POST
/v1/invitations/:id/revoke
Example invitation schema
1
{
2
"object"
:
"invitation"
,
3
"id"
:
"inv_21Ufcy98STcA11s3QckIwtwHIES"
,
4
"email_address"
:
"
[email protected]
"
,
5
"revoked"
:
true
6
"created_at"
:
1638000669544
,
7
"updated_at"
:
1638000669544
,
8
}
Copied!
post
https://api.clerk.dev
/v1/invitations
Create an invitation
get
https://api.clerk.dev
/v1/invitations
List all invitations
post
https://api.clerk.dev
/v1/invitations/:id/revoke
Revokes an invitation
Previous
Clients
Next
Emails
Last modified
1mo ago
Copy link
Contents
Overview
Available requests
Example invitation schema
post
Create an invitation
get
List all invitations
post
Revokes an invitation