Users API
Base URL
https://api.uslimato.com/v1
Required scope: users:read
List Users
GET /users
Returns all users in your organization.
Query Parameters:
| Parameter | Type | Description |
|---|---|---|
q | string | Search by display name or email |
Example:
curl "https://api.uslimato.com/v1/users?q=jane" \
-H "Authorization: Bearer usl_live_..."
Response:
{
"data": [
{
"id": "clx...",
"email": "[email protected]",
"display_name": "Jane Doe",
"role": "technician",
"is_active": true,
"last_login_at": "2024-11-20T09:15:00Z",
"created_at": "2024-01-10T08:00:00Z"
}
]
}
Get User
GET /users/:id
Returns a single user by their ID.
Response:
{
"data": {
"id": "clx...",
"email": "[email protected]",
"display_name": "Jane Doe",
"role": "technician",
"is_active": true,
"last_login_at": "2024-11-20T09:15:00Z",
"created_at": "2024-01-10T08:00:00Z"
}
}
User Roles
| Value | Description |
|---|---|
viewer | Read-only access |
helpdesk | View assets and create process instances |
technician | Create and edit assets, manage processes |
admin | Full access including user and settings management |
Notes
- The Users API is read-only. User provisioning is managed through HGE ID and the tenant admin interface.
- Only users belonging to your organization are returned — tenant isolation is enforced at the API level.
- Inactive users (
is_active: false) are included in the list response.