Clerk docs

Clients

The Client object tracks sessions, as well as the state of any sign in and sign up attempts, for a given device.

https://clerk.com/docs/reference/clerkjs/client

List all clients

Returns a list of all clients. The clients are returned sorted by creation date, with the newest clients appearing first.

SecuritybearerAuth
Request
query Parameters
limit
number [ 1 .. 500 ]
Default: 10

Applies a limit to the number of results returned. Can be used for paginating the results together with offset. Must be an integer greater than zero and less than 500. By default, if not supplied, a limit of 10 is used.

offset
number >= 0
Default: 0

Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

Responses
200

Success

400

Request was not successful

401

Authentication invalid

422

Invalid request parameters

get/clients
Response samples
application/json
[
  • {
    }
]

Verify a client

Verifies the client in the provided token

SecuritybearerAuth
Request
Request Body schema: application/json

Parameters.

token
string

A JWT Token that represents the active client.

Responses
200

Success

400

Request was not successful

401

Authentication invalid

404

Resource not found

post/clients/verify
Request samples
application/json
{
  • "token": "string"
}
Response samples
application/json
{
  • "object": "client",
  • "id": "string",
  • "session_ids": [
    ],
  • "sessions": [
    ],
  • "sign_in_attempt_id": "string",
  • "sign_up_attempt_id": "string",
  • "sign_in_id": "string",
  • "sign_up_id": "string",
  • "last_active_session_id": "string",
  • "updated_at": 0,
  • "created_at": 0
}

Get a client

Returns the details of a client.

SecuritybearerAuth
Request
path Parameters
client_id
required
string

Client ID.

Responses
200

Success

400

Request was not successful

401

Authentication invalid

404

Resource not found

get/clients/{client_id}
Response samples
application/json
{
  • "object": "client",
  • "id": "string",
  • "session_ids": [
    ],
  • "sessions": [
    ],
  • "sign_in_attempt_id": "string",
  • "sign_up_attempt_id": "string",
  • "sign_in_id": "string",
  • "sign_up_id": "string",
  • "last_active_session_id": "string",
  • "updated_at": 0,
  • "created_at": 0
}

Get the last active session of a client

Returns the details of the last active session of a client.

SecuritybearerAuth
Request
path Parameters
client_id
required
string

Client ID.

Responses
200

Success

400

Request was not successful

401

Authentication invalid

404

Resource not found

get/clients/{client_id}/last_active_session
Response samples
application/json
{
  • "object": "session",
  • "id": "string",
  • "user_id": "string",
  • "client_id": "string",
  • "actor": { },
  • "status": "active",
  • "last_active_organization_id": "string",
  • "last_active_at": 0,
  • "expire_at": 0,
  • "abandon_at": 0,
  • "updated_at": 0,
  • "created_at": 0
}
➔ Next to Email Addresses