Clerk API (unofficial showcase)
GET/role_sets

Get a list of role sets

Returns a list of role sets for the instance. Results can be paginated using the optional limit and offset query parameters. The role sets are ordered by descending creation date by default.

4 parameters
querystringoptional
Returns role sets with ID, name, or key that match the given query. Uses exact match for role set ID and partial match for name and key.
order_bystringoptional
Allows to return role sets in a particular order. At the moment, you can order the returned role sets by their `created_at`, `name`, or `key`. In order to specify the direction, you can use the `+/-` symbols prepended in the property to order by. For example, if you want role sets to be returned in descending order according to their `created_at` property, you can use `-created_at`. If you don't use `+` or `-`, then `+` is implied. Defaults to `-created_at`.
Default:-created_at
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
dataarray<object>required
total_countintegerrequired
Total number of role sets
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
401Authentication invalid
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
403Authorization invalid
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 403 is returned: Authorization invalid. A 422 is returned: Invalid request parameters.