Sign in

v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB
Users

Get all users

get/1.0/users

Query parameters

pageSizenumber
Example:100

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.

pageTokenstring
Example:59c12a42-dd10-11ed-afa1-0242ac120002

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.

includeFieldsstring[]

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.

includeAllFieldsboolean
Example:true

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'email' | 'firstName' | 'lastName' | 'type' | 'status' | 'capacityInMinutes'

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

sortOrder'ASC' | 'DESC'

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

match'all' | 'any'

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

firstName.eqstring
Example:John

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.cnstring
Example:John

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.ncstring
Example:John

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.eqstring
Example:Doe

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.cnstring
Example:Doe

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.ncstring
Example:Doe

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.eqstring
Example:johndoe@rocketlane.com

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.cnstring
Example:johndoe@rocketlane.com

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.ncstring
Example:johndoe@rocketlane.com

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.eqstring[]

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.oneOfstring[]

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.noneOfstring[]

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.

type.eqstring[]

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.oneOfstring[]

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.

roleId.eqstring

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.oneOfstring
Example:1,2,3

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.noneOfstring
Example:1,2,3

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.eqstring

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.oneOfstring
Example:1,2,3

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.noneOfstring
Example:1,2,3

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.eqnumber
Example:2400

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.gtnumber
Example:2400

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.genumber
Example:2400

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.ltnumber
Example:2400

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.lenumber
Example:2400

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.gtinteger
Example:1625164800000

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.eqinteger
Example:1625164800000

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.ltinteger
Example:1625164800000

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.geinteger
Example:1625164800000

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.leinteger
Example:1625164800000

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.gtinteger
Example:1625164800000

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.eqinteger
Example:1625164800000

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.ltinteger
Example:1625164800000

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.geinteger
Example:1625164800000

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.leinteger
Example:1625164800000

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.

Response

The requested action was successfully executed.

Example response

{
  "data": [
    {
      "userId": 201,
      "email": "johndoe@rocketlane.com",
      "firstName": "John",
      "lastName": "Doe",
      "type": "TEAM_MEMBER",
      "status": "ACTIVE",
      "role": {
        "roleId": 136,
        "roleName": "Customer Success"
      },
      "company": {
        "companyId": 116,
        "companyName": "Modert"
      },
      "permission": {
        "permissionId": 933,
        "permissionName": "Account Admin"
      },
      "fields": [
        {
          "fieldId": 201,
          "fieldLabel": "MRR",
          "fieldValue": "1000",
          "fieldValueLabel": "1000"
        }
      ],
      "capacityInMinutes": 2400,
      "holidayCalendar": {
        "calenderId": 93,
        "calenderName": "India Holiday Calendar"
      },
      "profilePictureUrl": "https://s3.amazonaws.com/rocketlane-profile-pic-public/_default/ftue/John.jpg",
      "createdAt": 1681319726000,
      "createdBy": {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      },
      "updatedAt": 1681319726000,
      "updatedBy": {
        "emailId": "john.doe@rocketlane.com",
        "userId": 201,
        "firstName": "John",
        "lastName": "Doe"
      }
    }
  ],
  "pagination": {
    "pageSize": 100,
    "hasMore": true,
    "totalRecordCount": 10398,
    "nextPage": "https://api.rocketlane.com/api/1.0/users?includeFields=capacityInMinutes&status.eq=ACTIVE&sortBy=status&sortOrder=desc&pageToken=e4a3dd8e-e338-11ed-b5ea-0242ac120002&limit=100",
    "nextPageToken": "e4a3dd8e-e338-11ed-b5ea-0242ac120002"
  }
}