Sign in

v1

latestOpenAPI 3.0.12026-07-2464217456.8 KB
Users

Get user by Id

get/1.0/users/{userId}

Path parameters

userIdinteger required

The user's unique, system-generated identifier, which can be used to identify the user globally.

Query parameters

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.

Response

The requested action was successfully executed.

userIdinteger

The user's unique, system-generated identifier, which can be used to identify the user globally.

emailstring

The email identifier of the user.

firstNamestring

The first name of the user.

lastNamestring

The last name of the user.

type'TEAM_MEMBER' | 'PARTNER' | 'CUSTOMER' | 'EXTERNAL_PARTNER'

The type of the user.

status'INACTIVE' | 'INVITED' | 'ACTIVE' | 'PASSIVE'

The status of the user.

capacityInMinutesinteger

The capacity of user, should be multiples of 5, default value is capacity configured in profile.

profilePictureUrlstring

The URL of the user's profile picture.

createdAtinteger

The time when the user was created. The referenced time will be in epoch millis.

updatedAtinteger

The time when the user's information was updated. Any changes that's related to the user are captured and specified here in epoch millis.

Example response

{
  "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"
  }
}