List users
Users of the portal with department, roles and status, from the Users report.
GET https://cotlet.dev/api/v1/absorb-lms/users
read
Returns users the way the Users report (User Administration) shows them. Only Active users appear unless you pass status inactive, as in Absorb's default view. Search by name, username or email, and narrow by department. user_id goes into list_user_enrollments, enroll_users, message_users and set_user_status. You see only the users your Admin role allows.
Parameters
| Name | Type | Description |
|---|---|---|
| query string | string | Part of a name, username or email. |
| department string | string | Department name as shown in the profile. |
| status enum | enum | active (default) or inactive. |
| limit integer | integer | Rows to return. |
Request
curl https://cotlet.dev/api/v1/absorb-lms/users \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("absorb-lms", "list_users")const result = await cotlet.call('absorb-lms', 'list_users');cotlet call absorb-lms list_usersExample response
{
"users": [
{
"user_id": "4f1c2a7e-8b3d-4c1a-9e55-0a6d3b7c1201",
"name": "Dana Reyes",
"username": "dreyes",
"email": "dana.reyes@example.com",
"department": "Warehouse",
"roles": [
"Learner"
],
"status": "Active"
},
{
"user_id": "9b7e5d10-2c44-4f0b-8a31-6e2f9c4d7702",
"name": "Omar Haddad",
"username": "ohaddad",
"email": "omar.haddad@example.com",
"department": "Warehouse",
"roles": [
"Learner"
],
"status": "Active"
}
]
}