GET/clientsDeprecated

List all clients

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.

3 parameters
paginatedbooleanoptional
Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.
limitintegeroptional
Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
Default:10
offsetintegeroptional
Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
Default:0

5 status codes
200Success
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:client
idstringrequired
String representing the identifier of the session.
session_idsarray<string>required
sessionsarray<object>required
sign_in_idstringrequired
sign_up_idstringrequired
last_active_session_idstringrequired
Last active session_id.
last_authentication_strategystringrequired
The authentication strategy that was last used to authenticate the user on this client.
updated_atintegerrequired
Unix timestamp of last update.
created_atintegerrequired
Unix timestamp of creation.
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Authentication invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
410The endpoint is considered deprecated and is pending removal.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 401 is returned: Authentication invalid. A 410 is returned: The endpoint is considered deprecated and is pending removal. A 422 is returned: Invalid request parameters.