Search users

get

https://platform.roserocket.com/api/v1/users

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

uuid

ID of the User

org_role_id

uuid

Role ID to filter by

location_id

uuid

Location/Customer ID to filter by

org_role_default_system_role

string

Default role name to filter by

in_role_ids

array of uuids

List of Role ID's to filter by

in_role_ids

in_default_system_roles

array of strings

List of Default system roles to filter by

in_default_system_roles

in_users_ids

array of uuids

List of User IDs to filter by

in_users_ids

exclude_customer

boolean

Value to represent whether or not customer users should be excluded. Remove value from parameters if false

exclude_partner_carrier_users

boolean

Value to represent whether or not partner carrier users should be excluded. Remove value from parameters if false

active_only

boolean

Value to represent whether or not only active users should be included in result set. Remove value from parameters if false

offset

integer

≥ 0

Defaults to 0

Pagination offset

limit

integer

0 to 50

Defaults to 20

Pagination limit

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

applsication/json

200successful operation

400Bad request