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
Frontend API
Introduction
Client requests
Overview
Client
Sign ups
Sign ins
Sessions
Organization requests
User requests
Social Login
Import users
Export users and data
Webhooks
Learning Center
Security
Build Frontend First
Powered By
GitBook
Client
The
Client
object contains the current state of the
Sign in
,
Sign up
,
and Session(s)
objects.
Available requests
PUT
/v1/client
GET
/v1/client
DEL
/v1/client
Example client object schema
1
{
2
"object"
:
"client"
,
3
"id"
:
"client_1sV3b42PUQh1kX7wi26opkRXR4x"
,
4
"sessions"
:
[],
5
"sign_in_attempt"
:
null
,
6
"sign_up_attempt"
:
null
,
7
"last_active_session_id"
:
null
,
8
"created_at"
:
1620943997
,
9
"updated_at"
:
1620943997
10
}
Copied!
put
https://clerk.example.com
/v1/client
Create or replace the current client
get
https://clerk.example.com
/v1/client
Retrieve the current client
delete
https://clerk.example.com
/v1/client
Delete the current client
Previous
Overview
Next
Sign ups
Last modified
1mo ago
Copy link
Contents
Available requests
Example client object schema
put
Create or replace the current client
get
Retrieve the current client
delete
Delete the current client