> ## 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.

# Список доступов к продуктам

> Получение списка доступов пользователей к продуктам (курсам) с фильтрацией и пагинацией

## Заголовки запроса

<ParamField header="Authorization" type="string" required>
  API токен сервисного пользователя в формате Bearer. Получите токен в панели администратора школы. Формат: `Bearer YOUR_TOKEN`.
</ParamField>

<ParamField header="Seller-Id" type="string" required>
  Уникальный идентификатор продавца в системе. Используется для разграничения доступа между разными продавцами.
</ParamField>

<ParamField header="School-Id" type="string" required>
  Уникальный идентификатор школы в системе. Определяет контекст выполнения операции.
</ParamField>

```
GET /saas/v2/product-access/list/raw
```

<Info>
  Возвращает доступы пользователей к продуктам школы. Все параметры фильтрации необязательны.
  Параметры-массивы передаются повторением параметра: `userIds=1&userIds=2`.
</Info>

## Параметры запроса

### Пагинация

<ParamField query="skip" type="integer" required={false}>
  Количество записей, которые нужно пропустить. По умолчанию `0`.
</ParamField>

<ParamField query="page" type="integer" required={false}>
  Номер страницы (альтернатива `skip`). Начинается с `1`.
</ParamField>

<ParamField query="take" type="integer" required={false}>
  Количество записей на странице. От `1` до `1000`. По умолчанию `100`.
</ParamField>

### Фильтрация

<ParamField query="accessIds" type="integer[]" required={false}>
  Фильтр по ID доступов.
</ParamField>

<ParamField query="userIds" type="integer[]" required={false}>
  Фильтр по ID пользователей.
</ParamField>

<ParamField query="active" type="boolean" required={false}>
  Только активные (`true`) или неактивные (`false`) доступы.
</ParamField>

<ParamField query="search" type="string" required={false}>
  Поиск по пользователю/продукту. Максимум 50 символов, пробелы по краям обрезаются.
</ParamField>

<ParamField query="launchIds" type="integer[]" required={false}>
  Фильтр по ID запусков (потоков).
</ParamField>

<ParamField query="currentLessonIds" type="integer[]" required={false}>
  Фильтр по ID текущего урока участника.
</ParamField>

<ParamField query="enrolledByUserIds" type="integer[]" required={false}>
  Фильтр по ID пользователей, выдавших доступ.
</ParamField>

<ParamField query="participantCuratorIds" type="integer[]" required={false}>
  Фильтр по ID кураторов (менеджеров продавца).
</ParamField>

<ParamField query="participantStatuses" type="enum[]" required={false}>
  Статус участника: `InUse`, `Completed`.
</ParamField>

<ParamField query="withParent" type="boolean" required={false}>
  Включать доступы, выданные как часть родительского доступа (бандла).
</ParamField>

<ParamField query="expireAtDateRange" type="object" required={false}>
  Диапазон даты истечения доступа.

  <Expandable title="Свойства expireAtDateRange">
    <ParamField query="from" type="string">Начало диапазона (ISO 8601).</ParamField>
    <ParamField query="to" type="string">Конец диапазона (ISO 8601).</ParamField>
  </Expandable>
</ParamField>

<ParamField query="createdAtDateRange" type="object" required={false}>
  Диапазон даты выдачи доступа.

  <Expandable title="Свойства createdAtDateRange">
    <ParamField query="from" type="string">Начало диапазона (ISO 8601).</ParamField>
    <ParamField query="to" type="string">Конец диапазона (ISO 8601).</ParamField>
  </Expandable>
</ParamField>

<ParamField query="progressPercentRange" type="object" required={false}>
  Диапазон процента прохождения. Поля `from` / `to` (число); хотя бы одно обязательно.
</ParamField>

### Фильтры биллинга (подписки/рассрочки)

<ParamField query="billingActive" type="boolean" required={false}>
  Только с активным (`true`) биллингом.
</ParamField>

<ParamField query="hasProductBillingTypes" type="enum[]" required={false}>
  Тип биллинга продукта: `Installment` (рассрочка), `Subscription` (подписка).
</ParamField>

<ParamField query="billingStatuses" type="enum[]" required={false}>
  Статус биллинга доступа: `Scheduled`, `Processing`, `Paid`, `Failed`, `WaitingEntryFee`,
  `CanceledByUser`, `CanceledByFailedAutoCharge`, `CanceledByReinitialization`,
  `CanceledByFailedManualCharge`, `CanceledByPreviousCancellation`.
</ParamField>

<ParamField query="billingIntervals" type="enum[]" required={false}>
  Интервал списания: `Week`, `Month`, `Year`.
</ParamField>

<ParamField query="billingInvoiceIds" type="integer[]" required={false}>
  Фильтр по ID счетов биллинга.
</ParamField>

<ParamField query="billingAmountRange" type="object" required={false}>
  Диапазон суммы биллинга. Поля `from` / `to` (число); хотя бы одно обязательно.
</ParamField>

<ParamField query="billingCurrentPaymentAtDateRange" type="object" required={false}>
  Диапазон даты текущего платежа биллинга. Поля `from` / `to` (ISO 8601).
</ParamField>

<ParamField query="billingNextPaymentAtDateRange" type="object" required={false}>
  Диапазон даты следующего платежа биллинга. Поля `from` / `to` (ISO 8601).
</ParamField>

### Вложенные фильтры

<ParamField query="product" type="object" required={false}>
  Фильтр по продукту.

  <Expandable title="Свойства product">
    <ParamField query="productIds" type="integer[]">ID продуктов.</ParamField>
    <ParamField query="sellerIds" type="integer[]">ID продавцов.</ParamField>
    <ParamField query="statuses" type="enum[]">Статусы: `Draft`, `OnCheck`, `Declined`, `ReadyToPublish`, `Published`.</ParamField>
    <ParamField query="currencies" type="enum[]">Валюты: `Free`, `Exes`, `Rub`, `Uzs`, `Kzt`, `Usd`, `Eur`.</ParamField>
    <ParamField query="showInCatalog" type="boolean">Показывается ли в каталоге.</ParamField>
    <ParamField query="isOnSale" type="boolean">В продаже ли продукт.</ParamField>
    <ParamField query="archived" type="boolean">Включать архивные.</ParamField>
    <ParamField query="search" type="string">Поиск по продукту (до 50 символов).</ParamField>
  </Expandable>
</ParamField>

<ParamField query="user" type="object" required={false}>
  Фильтр по пользователю.

  <Expandable title="Свойства user">
    <ParamField query="userIds" type="integer[]">ID пользователей.</ParamField>
    <ParamField query="extId" type="string">Внешний идентификатор (до 50 символов).</ParamField>
    <ParamField query="search" type="string">Поиск по пользователю (до 50 символов).</ParamField>
    <ParamField query="active" type="boolean">Активен.</ParamField>
    <ParamField query="activated" type="boolean">Подтвердил вход.</ParamField>
    <ParamField query="banned" type="boolean">Заблокирован.</ParamField>
    <ParamField query="archived" type="boolean">Архивирован.</ParamField>
    <ParamField query="domains" type="enum[]">Домены регистрации: `Ru`, `Uz`, `Kz`, `Biz`, `Global`.</ParamField>
    <ParamField query="products" type="enum[]">Продукты: `BizSchool`, `Marketplace`.</ParamField>
    <ParamField query="createdAtDateRange" type="object">Диапазон даты регистрации (`from`/`to`).</ParamField>
    <ParamField query="lastOnlineAtDateRange" type="object">Диапазон последней активности (`from`/`to`).</ParamField>
  </Expandable>
</ParamField>

## Поля ответа

<ResponseField name="payload" type="object">
  Постраничный список доступов (компактная проекция). Полная структура — `productAccess` в справочнике
  [`product`](/ru/exode-api/objects/entities/product).

  <Expandable title="Свойства payload">
    <ResponseField name="items" type="object[]">
      Массив доступов.

      <Expandable title="Свойства элемента">
        <ResponseField name="accessId" type="integer">ID доступа.</ResponseField>
        <ResponseField name="productId" type="integer">ID продукта.</ResponseField>
        <ResponseField name="courseId" type="integer | null">ID связанного курса.</ResponseField>
        <ResponseField name="active" type="boolean">Признак активности доступа.</ResponseField>
        <ResponseField name="expireAt" type="string | null">Дата истечения доступа (ISO 8601).</ResponseField>

        <ResponseField name="user" type="object">
          Пользователь: `id`, `extId`, `tgId`, `login`, `email`, `phone`, `fullName`.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="page" type="integer">Текущая страница.</ResponseField>
    <ResponseField name="count" type="integer">Общее количество записей.</ResponseField>
    <ResponseField name="pages" type="integer">Общее количество страниц.</ResponseField>
    <ResponseField name="isFirst" type="boolean">Признак первой страницы.</ResponseField>
    <ResponseField name="isLast" type="boolean">Признак последней страницы.</ResponseField>
    <ResponseField name="next" type="object">Параметры следующей страницы (`skip`, `take`, `page`).</ResponseField>
    <ResponseField name="prev" type="object">Параметры предыдущей страницы (`skip`, `take`, `page`).</ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl --location 'https://api.exode.biz/saas/v2/product-access/list/raw?take=20&active=true' \
    --header 'Seller-Id: {{ sellerId }}' \
    --header 'School-Id: {{ schoolId }}' \
    --header 'Authorization: Bearer YOUR_TOKEN'
  ```

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

  const listAccess = async () => {
    const { data } = await axios.get('https://api.exode.biz/saas/v2/product-access/list/raw', {
      params: { take: 20, active: true },
      headers: {
        'Seller-Id': '{{ sellerId }}',
        'School-Id': '{{ schoolId }}',
        'Authorization': 'Bearer YOUR_TOKEN',
      },
    });

    console.log(data.payload.items);
  };

  listAccess();
  ```

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

  $url = 'https://api.exode.biz/saas/v2/product-access/list/raw?take=20&active=true';
  $headers = [
    'Seller-Id: {{ sellerId }}',
    'School-Id: {{ schoolId }}',
    'Authorization: Bearer YOUR_TOKEN'
  ];

  $ch = curl_init();
  curl_setopt($ch, CURLOPT_URL, $url);
  curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

  echo curl_exec($ch);
  curl_close($ch);
  ?>
  ```

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

  url = 'https://api.exode.biz/saas/v2/product-access/list/raw'
  headers = {
    'Seller-Id': '{{ sellerId }}',
    'School-Id': '{{ schoolId }}',
    'Authorization': 'Bearer YOUR_TOKEN'
  }

  response = requests.get(url, params={ 'take': 20, 'active': 'true' }, headers=headers)
  print(response.json())
  ```

  ```bsl 1С theme={null}
  Соединение = Новый HTTPСоединение("api.exode.biz", 443, , , , 30, Новый OpenSSLSecureConnection);

  Запрос = Новый HTTPЗапрос("/saas/v2/product-access/list/raw?take=20&active=true");
  Запрос.Заголовки.Вставить("Seller-Id", "{{ sellerId }}");
  Запрос.Заголовки.Вставить("School-Id", "{{ schoolId }}");
  Запрос.Заголовки.Вставить("Authorization", "Bearer YOUR_TOKEN");

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

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

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "code": 200,
    "payload": {
      "page": 1,
      "count": 1,
      "pages": 1,
      "isFirst": true,
      "isLast": true,
      "items": [
        {
          "accessId": 4001,
          "productId": 200,
          "courseId": 10,
          "active": true,
          "expireAt": "2025-12-31T23:59:59Z",
          "user": {
            "id": 123,
            "extId": "crm_12345",
            "tgId": null,
            "login": "user@example.com",
            "email": "user@example.com",
            "phone": "+9876543210",
            "fullName": "John Doe"
          }
        }
      ],
      "next": {
        "skip": 20,
        "take": 20,
        "page": 2
      },
      "prev": {
        "skip": 0,
        "take": 20,
        "page": 1
      }
    }
  }
  ```
</ResponseExample>

## Требования к правам доступа

<Check>
  Требуется аутентификация по токену и одно из прав: управление пользователями школы (`SchoolManageUsers`)
  или управление студентами курса (`CourseStudentManage`).
</Check>