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 clientsDeprecated

Returns a list of all clients. The clients are returned sorted by creation date, with the newest clients appearing first. Warning: the endpoint is being deprecated and will be removed in future versions.

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`.
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

410

The endpoint is considered deprecated and is pending removal.

422

Invalid request parameters

get/clients

Response samples

application/json

[{"object": "client",
"id": "string",
"session_ids": ["string"
],
"sessions": [{"object": "session",
"id": "string",
"user_id": "string",
"client_id": "string",
"actor": { },
"status": "active",
"last_active_organization_id": "string",
"last_active_at": 0,
"latest_activity": {"object": "string",
"id": "string",
"device_type": "string",
"is_mobile": true,
"browser_name": "string",
"browser_version": "string",
"ip_address": "string",
"city": "string",
"country": "string"
},
"expire_at": 0,
"abandon_at": 0,
"updated_at": 0,
"created_at": 0
}
],
"sign_in_id": "string",
"sign_up_id": "string",
"last_active_session_id": "string",
"updated_at": 0,
"created_at": 0
}
]

Verify a client

Verifies the client in the provided token

SecuritybearerAuth

Request

Request Body schema: application/json

Parameters.

token

string

A JWT 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

Payload

application/json

{"token": "string"
}

Response samples

application/json

{"object": "client",
"id": "string",
"session_ids": ["string"
],
"sessions": [{"object": "session",
"id": "string",
"user_id": "string",
"client_id": "string",
"actor": { },
"status": "active",
"last_active_organization_id": "string",
"last_active_at": 0,
"latest_activity": {"object": "string",
"id": "string",
"device_type": "string",
"is_mobile": true,
"browser_name": "string",
"browser_version": "string",
"ip_address": "string",
"city": "string",
"country": "string"
},
"expire_at": 0,
"abandon_at": 0,
"updated_at": 0,
"created_at": 0
}
],
"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": ["string"
],
"sessions": [{"object": "session",
"id": "string",
"user_id": "string",
"client_id": "string",
"actor": { },
"status": "active",
"last_active_organization_id": "string",
"last_active_at": 0,
"latest_activity": {"object": "string",
"id": "string",
"device_type": "string",
"is_mobile": true,
"browser_name": "string",
"browser_version": "string",
"ip_address": "string",
"city": "string",
"country": "string"
},
"expire_at": 0,
"abandon_at": 0,
"updated_at": 0,
"created_at": 0
}
],
"sign_in_id": "string",
"sign_up_id": "string",
"last_active_session_id": "string",
"updated_at": 0,
"created_at": 0
}

➔ Next to Domains