Clients

This object represents a client created by a user. Clients are unauthenticated objects that are used to track the current sign in, sign up, and an array of sessions.

Available requests

  • GET/v1/clients/:id

  • GET/v1/clients

  • POST/v1/clients/verify

Example client schema

{
"object": "client",
"id": "client_1q8u5xxKGAaflDktdY1IXxvK36S",
"session_ids": [
"sess_1q8u7QQhKOGRitdFGreHB00443j"
],
"sign_in_attempt_id": null,
"sign_up_attempt_id": null,
"last_active_session_id": "sess_1q8u7QQhKOGRitdFGreHB00443j",
"created_at": 1616473358,
"updated_at": 1616473358
}

get
Retrieve a client

https://api.clerk.dev/v1/clients/:id
Retrieve the details of a client.
Request
Response
Request
Headers
Authorization
required
string
Bearer [YOUR_API_KEY]
Response
200: OK
// see example schema
{
"object": "client",
"id": "client_1q8u5xxKGAaflDktdY1IXxvK36S"
...
}

get
List all clients

https://api.clerk.dev/v1/clients
List all clients.
Request
Response
Request
Headers
Authorization
required
string
Bearer [YOUR_API_KEY]
Response
200: OK
// see example schema
[
{
"object": "client",
"id": "client_1q8u5xxKGAaflDktdY1IXxvK36S"
...
},
{
"object": "client",
"id": "client_1q8u5xxKGAaflDktdY1IXxvK36S"
...
}
]

post
Verify a client

https://api.clerk.dev/v1/clients/verify
Verify the validity of the supplied token.
Request
Response
Request
Headers
Authorization
required
string
Bearer [YOUR_API_KEY]
Form Data Parameters
token
required
string
The JWT that is sent via the `__session` cookie from your frontend.
Response
200: OK
// see example schema
{
"object": "client",
"id": "client_1q8u5xxKGAaflDktdY1IXxvK36S"
...
}