Users

---

Class responsible for users list related endpoints.

List users

Get a list of users.

const response = await geocore.Users.find({
  groupIds: ["groupId"],
  name: "name",
  username: "username",
  email: "email",
  serialNumber: "serialNumber",
  accessLevels: ["user"],
  lastLoginRange: {
    start: "2025-01-01",
    end: "2025-01-01",
  }
  createdRange: {
    start: "2025-01-01",
    end: "2025-01-01",
  }
  updatedRange: {
    start: "2025-01-01",
    end: "2025-01-01",
  }
  lastLocation: {
    north: 1,
    south: 2,
    west: 3,
    east: 4,
  };
  page: 1,
  limit: 10,
});

Parameters

name	type	data type	description
groupIds	optional	array<string>	Search by group IDs
username	optional	string	Search by username
name	optional	string	Search by full name
email	optional	string	Search by email
serialNumber	optional	string	Search by serialNumber
accessLevels	optional	array<string>	Search by user access level
lastLoginRange[start]	optional	date	Search by lastLoginTime timestamp
lastLoginRange[end]	optional	date	Search by lastLoginTime timestamp
createdRange[start]	optional	date	Search by createdAt timestamp
createdRange[end]	optional	date	Search by createdAt timestamp
updatedRange[start]	optional	date	Search by modifiedAt timestamp
updatedRange[end]	optional	date	Search by modifiedAt timestamp
lastLocation[north]	required	number	Longitude of north west point
lastLocation[south]	required	number	Latitude of north west point
lastLocation[west]	required	number	Longitude of north east point
lastLocation[east]	required	number	Latitude of north east point
page	optional	number	Page ordinal number
limit	optional	number	Number of records per page

Response note

The final result depends on logged in user's access level

• Users can find other users in the same subgroups.
• Group admins can find users in their subgroups.
• Company admins can find users in their company groups.
• Super admins can find any users.