A user represents an individual team member in LENS. User data can be used to identify who created activities, comments, assignments, and other actions throughout LENS.
Request
GET {LENS_URL}/api/v2/users
Headers
Include your PAT in the Authorization header of your request.
Header | Description |
| Your Personal Access Token |
Query Parameters
Parameter | Description | Required |
| Comma-separated list of entity group names. | No |
Response
Field | Description | Required |
| The user’s unique ID. | Yes |
| The user’s login identifier, often used for SSO integrations. | No |
| The user’s full name. | Yes |
Example Request
GET https://example.safeandreliable.care/api/v2/users?groupNames=west-er
Example Response
{
"data": [
{
"_id": "Swd3cQRNpZCF4LzuX",
"profile": {
"nameID": "mleonard",
"fullname": "Michelle Leonard"
}
},
{
"_id": "DbDdNvwitg7vvNHR3",
"profile": {
"nameID": "fallen",
"fullname": "Frank Allen"
}
}
],
"metadata": {
"endpoint": "users",
"count": 2,
"filters": {
"groupNames": [
"west-er"
]
}
}
}
Looking for more support?
We’re here to help — email us at LENSsupport@safeandreliablecare.com or click the Help button on your LENS board.