Clerk API (unofficial showcase)
GET/organization_roles

Get a list of organization roles

This request returns the list of organization roles for the instance. Results can be paginated using the optional limit and offset query parameters. The organization roles are ordered by descending creation date. Most recent roles will be returned first.

4 parameters
querystringoptional
Returns organization roles with ID, name, or key that match the given query. Uses exact match for organization role ID and partial match for name and key.
order_bystringoptional
Allows to return organization roles in a particular order. At the moment, you can order the returned organization roles 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 organization roles 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 roles
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.