Hatz Learn Reporting

List Tenant Learners

get/academy/reporting/tenants/{tenant_id}/learners

Request

  • Base URL: https://ai.hatz.ai/v1
  • URL: https://ai.hatz.ai/v1/academy/reporting/tenants/{tenant_id}/learners
  • Auth: API key in header X-API-Key

Path parameters

tenant_idstring uuid required

Query parameters

searchstring nullable

Learner name or email search.

course_idstring uuid nullable

Restrict to one course.

status'not_enrolled' | 'not_started' | 'in_progress' | 'completed' | 'access_revoked' | 'retired' nullable

Restrict to one effective course status.

cursorstring nullable

Opaque cursor from the prior page; reuse with the same filters and sort.

limitinteger

Learners per page.

sort_direction'asc' | 'desc'

Case-insensitive learner-name order.

Response

Successful Response

next_cursorstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.