> ## Documentation Index
> Fetch the complete documentation index at: https://docs.exode.biz/llms.txt
> Use this file to discover all available pages before exploring further.

# School students

> Export school students (course accesses) with progress, groups, curators and tariffs

**type:** `QUERY_EXPORT_TYPE_SCHOOL_STUDENT_FIND_MANY`

Exports the school's students through their course accesses: course progress, groups, curator, tariff and access status
(one student = one product access).

This is a report type for the [`query-export/generate`](/en/exode-api/school/query-export/generate) method: pass it
in the `type` field, and pass the filter and sorting in `variables`.

<Info>
  Students are exported from product accesses (`productAccessManageFindMany`): one student = one course access.
  That is why `variables` is the access filter and sorting (`FilterAccessProductInput` / `SortAccessProductInput`),
  the same structure as in the
  ["Access billing"](/en/exode-api/school/query-export/product-billing-access-find-many) report.
  An unknown field or an invalid value is not ignored: the export finishes with
  `status: Failed`.
</Info>

***

### Variables (`variables`)

<ParamField body="filter" type="object" required>
  Access filter parameters. Required: to export all records without filtering, pass an empty
  object `{}`.

  <Expandable title="filter properties">
    <ParamField body="userIds" type="integer[]">Filter by user IDs.</ParamField>
    <ParamField body="accessIds" type="integer[]">Filter by access IDs.</ParamField>
    <ParamField body="courseIds" type="integer[]">Filter by course IDs.</ParamField>
    <ParamField body="groupIds" type="integer[]">Filter by IDs of the groups the student belongs to.</ParamField>
    <ParamField body="launchIds" type="integer[]">Filter by launch (cohort) IDs.</ParamField>
    <ParamField body="active" type="boolean">Only active (`true`) or deactivated (`false`) accesses.</ParamField>
    <ParamField body="search" type="string">Text search (name, email, phone, domain), up to 50 characters.</ParamField>
    <ParamField body="currentLessonIds" type="integer[]">Filter by IDs of the students' current lessons.</ParamField>
    <ParamField body="participantCuratorIds" type="integer[]">Filter by curator IDs (seller manager IDs).</ParamField>
    <ParamField body="enrolledByUserIds" type="integer[]">Filter by IDs of the users who granted the access.</ParamField>

    <ParamField body="participantStatuses" type="string[]">
      Product participant status. An array of values: `InUse`, `Completed`.
    </ParamField>

    <ParamField body="progressPercentRange" type="object">
      Progress range (in percent). The `from` and `to` properties are numbers.
    </ParamField>

    <ParamField body="createdAtDateRange" type="object">
      Range of access grant dates. The `from` and `to` properties are ISO 8601 dates.
    </ParamField>

    <ParamField body="expireAtDateRange" type="object">
      Range of access expiration dates. The `from` and `to` properties are ISO 8601 dates.
    </ParamField>

    <ParamField body="product" type="object">
      Nested product filter (for example, `{ "productIds": [12] }`). The set of fields matches the `product`
      filter of the ["Product access list"](/en/exode-api/school/product-access/list) method. If a
      non-empty `product.productIds` is set, the "Last activity" and "Access status" columns are added to the report.
    </ParamField>

    <ParamField body="price" type="object">
      Nested tariff filter. The set of fields matches the `price` filter of the
      ["Product access list"](/en/exode-api/school/product-access/list) method.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="sort" type="object">
  Sorting parameters. Values: `ASC` (ascending) or `DESC` (descending).

  <Expandable title="sort properties">
    <ParamField body="id" type="string">Sort by ID. `ASC` | `DESC`.</ParamField>
    <ParamField body="createdAt" type="string">Sort by access grant date. `ASC` | `DESC`.</ParamField>
    <ParamField body="updatedAt" type="string">Sort by update date. `ASC` | `DESC`.</ParamField>
    <ParamField body="expireAt" type="string">Sort by access expiration date. `ASC` | `DESC`.</ParamField>
    <ParamField body="progressPercent" type="string">Sort by progress (%). `ASC` | `DESC`.</ParamField>
    <ParamField body="userLastOnlineAt" type="string">Sort by the student's last activity. `ASC` | `DESC`.</ParamField>
  </Expandable>
</ParamField>

### Report columns

**SchoolStudents** sheet: User ID, Full name, Login method, Course ID, Course name, Group ID, Group,
Curator, Current lesson, Progress (%), Completed lessons, Total lessons, Date added, Access expiration
date, Tariff ID, Tariff. With a non-empty `filter.product.productIds`, "Last activity" and "Access
status" are added. Corporate schools do not have the "Tariff ID" and "Tariff" columns.

In XLSX format only, if the export contains bundles, a **Course Progress** sheet is generated with a breakdown of progress
by the bundle's nested courses: User ID, Full name, Bundle ID, Bundle name, Course ID, Course name,
Progress (%), Completed lessons, Total lessons, Current lesson.

Column names are given as they appear without the `Ux-Language` header (in English); with the header, they are translated
into the specified language (see the [`generate`](/en/exode-api/school/query-export/generate) description for details).

<RequestExample>
  ```bash cURL theme={null}
  curl --location 'https://api.exode.biz/saas/v2/query-export/generate' \
    --header 'Seller-Id: {{ sellerId }}' \
    --header 'School-Id: {{ schoolId }}' \
    --header 'Content-Type: application/json' \
    --header 'Authorization: Bearer YOUR_TOKEN' \
    --data '{
      "type": "QUERY_EXPORT_TYPE_SCHOOL_STUDENT_FIND_MANY",
      "variables": {
        "filter": {
          "active": true
        },
        "sort": {
          "createdAt": "DESC"
        }
      }
    }'
  ```

  ```javascript Node.js theme={null}
  const axios = require('axios');

  const exportStudents = async () => {
    try {
      const response = await axios.post('https://api.exode.biz/saas/v2/query-export/generate', {
        type: 'QUERY_EXPORT_TYPE_SCHOOL_STUDENT_FIND_MANY',
        variables: {
          filter: {
            active: true
          },
          sort: {
            createdAt: 'DESC'
          }
        }
      }, {
        headers: {
          'Seller-Id': '{{ sellerId }}',
          'School-Id': '{{ schoolId }}',
          'Content-Type': 'application/json',
          'Authorization': 'Bearer YOUR_TOKEN'
        }
      });

      const { uuid } = response.data.payload;
      console.log('Execution UUID:', uuid);
    } catch (error) {
      console.error('Error:', error.response?.data || error.message);
    }
  };

  exportStudents();
  ```

  ```php PHP theme={null}
  <?php

  $url = 'https://api.exode.biz/saas/v2/query-export/generate';
  $data = [
    'type' => 'QUERY_EXPORT_TYPE_SCHOOL_STUDENT_FIND_MANY',
    'variables' => [
      'filter' => [
        'active' => true
      ],
      'sort' => [
        'createdAt' => 'DESC'
      ]
    ]
  ];

  $headers = [
    'Seller-Id: {{ sellerId }}',
    'School-Id: {{ schoolId }}',
    'Content-Type: application/json',
    'Authorization: Bearer YOUR_TOKEN'
  ];

  $ch = curl_init();
  curl_setopt($ch, CURLOPT_URL, $url);
  curl_setopt($ch, CURLOPT_POST, true);
  curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
  curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

  $response = curl_exec($ch);
  $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
  curl_close($ch);

  if ($httpCode === 200 || $httpCode === 201) {
    $result = json_decode($response, true);
    echo "Execution UUID: " . $result['payload']['uuid'] . "\n";
  } else {
    echo "Error: HTTP $httpCode\n";
    echo $response;
  }
  ?>
  ```

  ```python Python theme={null}
  import requests

  url = 'https://api.exode.biz/saas/v2/query-export/generate'

  data = {
    'type': 'QUERY_EXPORT_TYPE_SCHOOL_STUDENT_FIND_MANY',
    'variables': {
      'filter': {
        'active': True
      },
      'sort': {
        'createdAt': 'DESC'
      }
    }
  }

  headers = {
    'Seller-Id': '{{ sellerId }}',
    'School-Id': '{{ schoolId }}',
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_TOKEN'
  }

  try:
    response = requests.post(url, json=data, headers=headers)
    response.raise_for_status()

    result = response.json()
    print(f"Execution UUID: {result['payload']['uuid']}")

  except requests.exceptions.RequestException as e:
    print(f'Error: {e}')
  ```

  ```bsl 1С theme={null}
  Фильтр = Новый Структура;
  Фильтр.Вставить("active", Истина);

  Сортировка = Новый Структура;
  Сортировка.Вставить("createdAt", "DESC");

  Переменные = Новый Структура;
  Переменные.Вставить("filter", Фильтр);
  Переменные.Вставить("sort", Сортировка);

  Данные = Новый Структура;
  Данные.Вставить("type", "QUERY_EXPORT_TYPE_SCHOOL_STUDENT_FIND_MANY");
  Данные.Вставить("variables", Переменные);

  // Serialize body to JSON
  ЗаписьJSON = Новый ЗаписьJSON;
  ЗаписьJSON.УстановитьСтроку();
  ЗаписатьJSON(ЗаписьJSON, Данные);
  ТелоЗапроса = ЗаписьJSON.Закрыть();

  Соединение = Новый HTTPСоединение("api.exode.biz", 443, , , , 30, Новый OpenSSLSecureConnection);

  Запрос = Новый HTTPЗапрос("/saas/v2/query-export/generate");
  Запрос.Заголовки.Вставить("Seller-Id", "{{ sellerId }}");
  Запрос.Заголовки.Вставить("School-Id", "{{ schoolId }}");
  Запрос.Заголовки.Вставить("Content-Type", "application/json");
  Запрос.Заголовки.Вставить("Authorization", "Bearer YOUR_TOKEN");
  Запрос.УстановитьТелоИзСтроки(ТелоЗапроса);

  Ответ = Соединение.ВызватьHTTPМетод("POST", Запрос);

  Если Ответ.КодСостояния = 200 ИЛИ Ответ.КодСостояния = 201 Тогда
      ЧтениеJSON = Новый ЧтениеJSON;
      ЧтениеJSON.УстановитьСтроку(Ответ.ПолучитьТелоКакСтроку());
      Результат = ПрочитатьJSON(ЧтениеJSON);
      Сообщить("Export started");
  Иначе
      Сообщить("Error: HTTP " + Ответ.КодСостояния);
      Сообщить(Ответ.ПолучитьТелоКакСтроку());
  КонецЕсли;
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "code": 201,
    "payload": {
      "uuid": "ac4140c9-12d3-4c1f-a7aa-d12f16c7bbdd",
      "flow": "QueryExport",
      "status": "Processing",
      "isCompleted": false,
      "userId": 5562,
      "createdAt": "2025-01-18T12:44:55.812Z",
      "updatedAt": "2025-01-18T12:44:55.812Z"
    }
  }
  ```
</ResponseExample>

The method's response is a generation task with a `uuid`. Get the file via
[result retrieval](/en/exode-api/school/query-export/result).

## Permission requirements

<Check>
  Requires token authentication and one of the permissions: [**"School User Management"**](/en/exode-api/permissions) (`SchoolManageUsers`)
  or **"Course Student Management"** (`CourseStudentManage`). Without the permission, the generation request succeeds, but
  the export finishes with `status: Failed`.
</Check>

***

*Updated: 2026-09-25 14:33 UTC*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.