# perlearner_orgs_learners_retrieve

Enhanced API endpoint for listing learners with comprehensive filtering.

This endpoint provides a paginated list of learners with detailed metrics
and supports advanced filtering options. It uses DM token authentication
and respects department-based access controls.

Query Parameters:
    page (int): Page number for pagination
    length (int): Number of items per page
    search (str): Filter by username, email, or full name
    program (str): Filter by program
    location (str): Filter by location
    is_enrolled (bool): Filter for users with enrollments
    platform (str): Filter by platform
    start_date (date): Filter by join date (start range)
    end_date (date): Filter by join date (end range)

Returns:
    A paginated list of learners with comprehensive metrics including:
    - Course enrollments and completions
    - Time spent on platform
    - Pathway progress
    - Certificate and skill information
    - Location data

Access Control:
    - Platform admins can see all learners
    - Department admins can only see learners in their departments

Endpoint: GET /api/perlearner/orgs/{org}/learners
Version: 3.59.0-ai-plus
Security: PlatformApiKeyAuthentication

## Query parameters:

  - `department_id` (integer)
    When  is passed, it allows to filter data for only user content groups for the specified department

  - `end_date` (string)
    Learner date_joined end date. ISO 8601

  - `format` (string)
    Format

*  - json
    Enum: "json"

  - `include_main_platform` (boolean)
    Include main platform data

  - `is_enrolled` (boolean,null)
    Filter for users who have at least an enrollment

  - `length` (integer)
    Size of data to return

  - `location` (string)
    Location search string

  - `page` (integer)
    Page offset

  - `platform` (string)
    Platform search string

  - `program` (string)
    Program search string

  - `search` (string)
    Search string for learner. email, username or full name

  - `start_date` (string)
    Learner date_joined start date. ISO 8601

## Path parameters:

  - `org` (string, required)

## Response 200 fields (application/json):

  - `data` (array)

  - `data.username` (string, required)

  - `data.user_id` (integer, required)

  - `data.name` (string, required)

  - `data.email` (string, required)

  - `data.courses_enrolled` (integer, required)

  - `data.courses_completed` (integer, required)

  - `data.time_spent` (string, required)

  - `data.pathways_assigned` (integer, required)

  - `data.pathways_completed` (integer, required)

  - `data.certificates_earned` (integer, required)

  - `data.assessments_passed` (integer, required)

  - `data.skills_earned` (integer, required)

  - `data.skills_points` (integer, required)

  - `data.last_login` (string, required)

  - `data.location` (string, required)

  - `pagination` (object, required)

  - `pagination.totalItems` (integer, required)
    Total records

  - `pagination.currentPage` (integer, required)
    Current Page

  - `pagination.perPage` (integer, required)
    Size of data returned per page

  - `pagination.totalPages` (integer, required)
    Amount of pages