Retrieve a list of users

Description: Retrieve a list of all users in a company or subset of a company.

SecuritybearerAuth

Request

query Parameters

groupId	Array of strings <uuid> User role groups to search against.
roleId	Array of integers <int32> User roles to search against.
status	Array of strings User Lytx statuses to search against.
loginEnabled	boolean The setting that allows for login.
limit	integer <int32> Default: 10000 Number of records to return.
offset	integer <int32> Default: 0 Record to start with.
order	string Sort direction.
includeSubGroups	boolean If true, all subgroups under the specified group(s) are included.
searchText	string <= 100 characters Search parameter for first+last name, username, and employeeId.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/users

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"data": [{"userId": "4af860ae-2e53-4d8b-a48e-606b862effed",
"allowSafetyEventDownload": false,
"allowVideoSearchDownload": false,
"cellPhoneCountry": "US",
"cellPhoneNumber": "+1234567890",
"createdDate": "2025-06-20T11:25:07.860471-07:00",
"email": "email@email.com",
"employeeId": "j.smith",
"firstName": "John",
"groupRoles": [{"groupId": "28a6d1a3-92c8-4eca-b8b3-d5d0e2d308d0",
"roleId": 4
}
],
"lastLoginDate": "2025-06-24T11:25:07.860473-07:00",
"lastName": "Smith",
"loginEnabled": true,
"primaryGroupId": "28a6d1a3-92c8-4eca-b8b3-d5d0e2d308d0",
"status": "Active",
"updatedDate": "2025-06-27T11:25:07.860474-07:00",
"username": "j.smith"
},
{"userId": "923db788-a460-40f6-976f-05550abe59c5",
"allowVideoSearchDownload": true,
"createdDate": "0001-01-01T00:00:00",
"email": "email@email.com",
"employeeId": "j.doe",
"firstName": "Jane",
"groupRoles": [{"groupId": "28a6d1a3-92c8-4eca-b8b3-d5d0e2d308d0",
"groupName": "West Coast Group",
"roleId": 4
}
],
"lastName": "Doe",
"loginEnabled": true,
"primaryGroupId": "28a6d1a3-92c8-4eca-b8b3-d5d0e2d308d0",
"status": "Active",
"updatedDate": "0001-01-01T00:00:00",
"username": "j.doe"
}
],
"metadata": {"count": 2,
"limit": 10,
"offset": 0
}
}