--- title: "Get all users" method: GET path: "/1.0/users" tags: ["Users"] --- # Get all users `GET /1.0/users` ## Query parameters - `pageSize` number - `pageToken` string - `includeFields` string[] - `includeAllFields` boolean - `sortBy` 'email' | 'firstName' | 'lastName' | 'type' | 'status' | 'capacityInMinutes' - `sortOrder` 'ASC' | 'DESC' - `match` 'all' | 'any' - `firstName.eq` string - `firstName.cn` string - `firstName.nc` string - `lastName.eq` string - `lastName.cn` string - `lastName.nc` string - `email.eq` string - `email.cn` string - `email.nc` string - `status.eq` string[] - `status.oneOf` string[] - `status.noneOf` string[] - `type.eq` string[] - `type.oneOf` string[] - `roleId.eq` string - `roleId.oneOf` string - `roleId.noneOf` string - `permissionId.eq` string - `permissionId.oneOf` string - `permissionId.noneOf` string - `capacityInMinutes.eq` number - `capacityInMinutes.gt` number - `capacityInMinutes.ge` number - `capacityInMinutes.lt` number - `capacityInMinutes.le` number - `createdAt.gt` integer - `createdAt.eq` integer - `createdAt.lt` integer - `createdAt.ge` integer - `createdAt.le` integer - `updatedAt.gt` integer - `updatedAt.eq` integer - `updatedAt.lt` integer - `updatedAt.ge` integer - `updatedAt.le` integer ## Response `200` The requested action was successfully executed. - ExampleAPIResponseUsers - `data` UsersPublicResponseForExample[] — Reflects all the default and custom fields and their values for the object searched, in an array format. If the includeFields param is utilised in the request body, it will return a customised response. - `userId` integer — The user's unique, system-generated identifier, which can be used to identify the user globally. - `email` string — The email identifier of the user. - `firstName` string — The first name of the user. - `lastName` string — 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. - `role` RoleUsersPublicAPIResponse — The role of the user. - `roleId` integer — The role's unique, system-generated identifier, which can be used to identify the role globally. - `roleName` string — The name of the role. - `company` UsersCompanyPublicAPIResponse — The company of the user. - `companyId` integer — The company's unique, system-generated identifier, which can be used to identify the company globally. - `companyName` string — The name of the company of the user. - `permission` PermissionUsersPublicAPIResponse — The Permission of the user. - `permissionId` integer — The unique system-generated identifier for permission, which can be used to identify the permission globally. - `permissionName` string — The name of the permission. - `fields` FieldUsersPublicAPIResponse[] — Custom user fields can be created and their values set during user creation. These values can also be added or edited later. The field value can be a string, number, or array, and must align with the field type. Refer [e xamples](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how each `field_type` is associated with user. - `fieldId` integer — The custom user field’s unique, system-generated identifier, which can be used to identify the role globally. - `fieldLabel` string — The fieldLabel is the name of the custom user field. - `fieldValue` string — The fieldValue is the value provided while creation or updating the user information. The fieldValue can be a string, an integer, or an number array and it will match the type of the field. Refer [examples](https://developer.rocketlane.com/v1.0/docs/custom-fields#examples-of-requests-and-responses-for-assigning-custom-field-values) to know how each `field_type` is associated with user. - `fieldValueLabel` string — The `fieldValueLabel` is the value provided while creation or updating in a String format. - `capacityInMinutes` integer — The capacity of user, should be multiples of 5, default value is capacity configured in profile. - `holidayCalendar` UsersHolidayCalendarPublicAPIResponse — The Holiday calendar of the user. - `calenderId` integer — The unique system-generated identifier for calendar, which can be used to identify the permission globally. - `calenderName` string — The name of the calendar. - `profilePictureUrl` string — The URL of the user's profile picture. - `createdAt` integer — The time when the user was created. The referenced time will be in epoch millis. - `createdBy` UsersCreatedByResponse — The team member who updated the information of the user. - `emailId` string — The team members email identifier. - `userId` integer — The unique identifier for the user. - `firstName` string — The first name of the user. - `lastName` string — The last name of the user. - `updatedAt` integer — 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. - `updatedBy` UsersCreatedByResponse — The team member who updated the information of the user. - `emailId` string — The team members email identifier. - `userId` integer — The unique identifier for the user. - `firstName` string — The first name of the user. - `lastName` string — The last name of the user. - `pagination` ExamplePaginationUsers — Responses that return multiple objects will be paginated. The pagination params define how pages are structured and how to traverse through pages. - `pageSize` integer — Denotes the page size mentioned in the current request (limit). It defaults to 100 if left blank. - `hasMore` boolean — Tells us if there is more content. - `totalRecordCount` integer — Denotes the total resources matching the filters. - `nextPage` string — Denotes an API URL, which can be conveniently called to perform the subsequent search call to get to the next page. - `nextPageToken` string — Denotes a unique token that points to the next page of resources. To get results from subsequent pages, you can use the nextPageToken available in the response under pagination. This token is valid for 15 minutes. ## Other responses - `400` — This 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. - `401` — You 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. --- [API](https://skmtc.net/rocketlane/apis/rocketlane-api.md) · [All operations](https://skmtc.net/rocketlane/apis/rocketlane-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rocketlane/rocketlane-api/revisions/1e8ba619e741/schema)