Get all users

get

https://api.rocketlane.com/api/1.0/users

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pageSize

number

≥ 0

This parameter sets the maximum number of responses to be displayed per page. If the page size is insufficient to accommodate the whole number of responses obtained, the pagination object will include a link to the next page as well as the next page token. If left blank, it defaults to 100.

pageToken

string

Use this parameter to specify the pageToken of a page to which you want to navigate. This pageToken can be obtained from a previous request which specified a limit and will only be active for 15 minutes after it is created.

includeFields

array of strings

This query parameter allows you to specify which fields should be returned in the response body by selecting from the drop down. To get the relevant fields, use comma separated values. If the field is left blank, the default properties are returned.

includeFields

includeAllFields

boolean

This query parameter allows you to specify if all the fields should be returned in the response body. If the field is left blank, the default properties are returned.

sortBy

string

enum

You can use the sortBy param to sort the responses by the given field.

Allowed:

sortOrder

string

enum

The sortOrder param can be used to specify the sorting order, which can be Ascending (ASC) or Descending (DESC). Descending is the default option.

Allowed:

match

string

enum

You can use the match param to specify if we need to filter the entries using either AND(all) / OR(any). Defaults to AND.

Allowed:

firstName.eq

string

You can use this param to specify some user first name and the responses will contain exact matches of users that match the given first name.

firstName.cn

string

You can use this param to specify some user first name and the responses will contain matches of users that match the given first name.

firstName.nc

string

You can use this param to specify some user first name and the responses will not contain matches of users that match the given first name.

lastName.eq

string

You can use this param to specify some user last name and the responses will contain exact matches of users that match the given last ame.

lastName.cn

string

You can use this param to specify some user last name and the responses will contain matches of users that match the given last name.

lastName.nc

string

You can use this param to specify some user last name and the responses will not contain matches of users that match the given last name.

email.eq

string

You can use this param to specify some user email id and the responses will contain exact matches of users that match the given email id.

email.cn

string

You can use this param to specify some user email id and the responses will contain matches of users that match the given email id.

email.nc

string

You can use this param to specify some user email id and the responses will not contain matches of users that match the given email id.

status.eq

array of strings

length ≤ 1

You can use this param to provide a user status and the responses will contain exact matches of users that match the given status.

status.eq

status.oneOf

array of strings

length ≤ 3

You can use this param to provide user statuses separated by commas and the responses will contain matches of users that match one of the given user status.

status.oneOf

status.noneOf

array of strings

length ≤ 3

You can use this param to provide user statuses separated by commas and the responses will contain matches of users that match the none of the given set of user statuses.

status.noneOf

type.eq

array of strings

length ≤ 1

You can use this param to provide a user type and the responses will contain exact matches of users that match the given type.

type.eq

type.oneOf

array of strings

length ≤ 3

You can use this param to provide user types separated by commas and the responses will contain matches of users that match the none of the given set of user types.

type.oneOf

roleId.eq

string

You can use this param to provide a role id and the responses will contain exact matches of users that match the given role id.

roleId.oneOf

string

You can use this param to provide role ids separated by commas and the responses will contain matches of users that match one of the given role id.

roleId.noneOf

string

You can use this param to provide role id separated by commas and the responses will contain matches of users that match the none of the given set of role id.

permissionId.eq

string

You can use this param to provide a permission id and the responses will contain exact matches of users that match the given permission id.

permissionId.oneOf

string

You can use this param to provide permission ids separated by commas and the responses will contain matches of users that match one of the given set of permission id.

permissionId.noneOf

string

You can use this param to provide permission ids separated by commas and the responses will contain matches of users that match the none of the given set of permission id.

capacityInMinutes.eq

number

You can use this param to specify some value as capacity and the responses will contain exact matches of users that match the given value.

capacityInMinutes.gt

number

You can use this param to specify some value as capacity and the responses will contain exact matches of capacity greater than that of the given value.

capacityInMinutes.ge

number

You can use this param to specify some value as capacity and the responses will contain exact matches of capacity greater than or equal to that of the given value.

capacityInMinutes.lt

number

You can use this param to specify some value as capacity and the responses will contain exact matches of capacity lesser than that of the given value.

capacityInMinutes.le

number

You can use this param to specify some value as capacity and the responses will contain exact matches of capacity lesser than or equal to that of the given value.

createdAt.gt

int64

You can use this param to provide an epoch milli value and the responses will contain users whose date are greater than the given users created date.

createdAt.eq

int64

You can use this param to provide an epoch milli value and the responses will contain exact matches of users that match the given users created date.

createdAt.lt

int64

You can use this param to provide an epoch milli value and the responses will contain users whose date are less than the given users created date.

createdAt.ge

int64

You can use this param to provide an epoch milli value and the responses will contain users whose date are greater than or equal to the given users created date.

createdAt.le

int64

You can use this param to provide an epoch milli value and the responses will contain users whose date are less than or equal to the given users created date.

updatedAt.gt

int64

You can use this param to provide an epoch milli value and the responses will contain users whose date are greater than the given users updated date.

updatedAt.eq

int64

You can use this param to provide an epoch milli value and the responses will contain exact matches of users that match the given users updated date.

updatedAt.lt

int64

You can use this param to provide an epoch milli value and the responses will contain users whose date are less than the given users updated date.

updatedAt.ge

int64

You can use this param to provide an epoch milli value and the responses will contain users whose date are greater than or equal to the given users updated date.

updatedAt.le

int64

You can use this param to provide an epoch milli value and the responses will contain users whose date are less than or equal to the given users updated date.

Responses

200The requested action was successfully executed.

400This error typically happens when the request payload contains an error. If you want to make sure that the request's parameters are named correctly and are the right data types, you can examine the request's syntax.

401You see this error when trying to access this resource without being authenticated. Check the API request header to make sure it is not empty and has a valid api-key that you acquired from the Rocketlane API Settings tab.