cac8702ed2aa
Get learners
Get many learners.
The query parameter filters are applied as AND conditions across different filters. If multiple filters are used, the response will include only the learners that satisfy all the filters.
Within a single filter, multiple values are applied as OR conditions.
Query parameters
Use this parameter to filter learners by id.
[ "abc123def4" ]
Use this parameter to filter learners by status. By default, all statuses are returned.
[ "ACTIVE" ]
Use this parameter to filter learners by exact email match within the tenant.
Use this parameter to filter learners by exact name match.
Use this parameter to limit the number of entities returned.
Use this parameter to paginate through entities. The cursor is the id of the last entity you want to start from.
To get the first page, omit this parameter.
To get the next page, use the id of the last entity from the previous response. Continue paginating while hasMore is true in the response.
Example workflow:
- GET /v1/{endpoint} → returns data + hasMore: true, last entity id: "xyz789end"
- GET /v1/{endpoint}?cursor=xyz789end → returns next page
Response
Success
Example response
{
"data": [
{
"id": "abc123def4",
"name": "First Last",
"status": "ACTIVE",
"email": "first.last@{your-domain}.com",
"country": "USA",
"state": "NY",
"isManager": true,
"managerLearnerId": "abc123def4",
"department": "Engineering",
"workerType": "Full Time",
"customCategory": "Brooklyn",
"language": "en",
"trainingUrl": "https://{ethena-domain}/learning?key={uuid}"
}
]
}