List learners
Learners of your academy with email and Panorama; search by name or email.
GET https://cotlet.dev/api/v1/thought-industries/learners
read
Reads the Users > Learners list. Returns each learner's learner_id, name, email and Panorama. Pass learner_id or the email to get_learner, enroll_learner and set_content_status. Use cursor to read the next page. Reading changes nothing.
Parameters
| Name | Type | Description |
|---|---|---|
| query string | string | Part of a learner name or email. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/thought-industries/learners \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("thought-industries", "list_learners")const result = await cotlet.call('thought-industries', 'list_learners');cotlet call thought-industries list_learnersExample response
{
"learners": [
{
"learner_id": "3f9a2b18-7c4d-4e2a-9b1f-0c5d6e7f8a90",
"name": "Priya Nair",
"email": "priya.nair@example.com",
"panorama": "Retail"
},
{
"learner_id": "5e1d7c2a-9b8f-4e3d-8c0a-1b2c3d4e5f60",
"name": "Tom Becker",
"email": "tom.becker@example.com",
"panorama": "Retail"
}
],
"next_cursor": null
}