List users
Users of the portal with name, email, user type and status; search by name or email, filter by group.
GET https://cotlet.dev/api/v1/learnupon/users
read
Returns users of the portal you are signed in to, a page at a time; pass next_cursor back as cursor for the next page. query matches a name or an email address. status pending returns invited people who have not accepted yet, and deletion_pending returns accounts in the 30 days after deletion; leave it out for active users. user_id is the id the other tools take.
Parameters
| Name | Type | Description |
|---|---|---|
| query string | string | Name or email address to search for. |
| group_id string | string | Only users in this group. |
| status enum | enum | pending or deletion_pending. Leave out for active users. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/learnupon/users \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("learnupon", "list_users")const result = await cotlet.call('learnupon', 'list_users');cotlet call learnupon list_usersExample response
{
"users": [
{
"user_id": "51872",
"name": "Maria Nowak",
"email": "maria.nowak@example.com",
"user_type": "learner",
"login_enabled": true
},
{
"user_id": "51890",
"name": "Tom Reyes",
"email": "tom.reyes@example.com",
"user_type": "learner",
"login_enabled": true
}
],
"next_cursor": null
}