HomeGuidesAPI Reference
API Reference
Go to Regate

Retrieve all users

get
https://api.regate.io/v1/users

Retrieve a list of users. Only users associated with the holding of the user making the request will be displayed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean

When true, will only retrieve users, which can be assigned as default managers to other users. When false, only those users that cannot be assigned as default managers will be returned.

filter
object

An object that defines the filters to use to retrieve only the items you require. Each field you add will be an additional filter to apply to the request. The filter key needs to be an attribute name (e.g. label), followed by an underscore and an operator name (e.g. eq for "equals"). For example, if you want to see all items with label my_label, the proper syntax will be ?filter[label_eq]=my_label. For detailed information, please see the Filtering section in our Guides.

integer
Defaults to 1

Results are paginated. Set the value to the page you want to retieve.

integer
≤ 1000
Defaults to 10

Results are paginated. This parameter indicates how many results per page will be returned.

Responses

Updated 7 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.regate_api.v1.json

Updated 7 months ago