База знань LMS Collaborator

Головна/Технічні вимоги/Робота з API/API - Список користувачів

API – Список користувачів

  • Для отримання списку користувачів потрібно надіслати GET запит на URI/api/v2/users/list.
  • Запит повинен містити заголовки Content-Type: application/json;charset=UTF-8 та X-Cbr-Authorization: Bearer API_TOKEN.

Приклад запиту:

curl 'https://your-domain.davintoo.com/api/v2/users/list' -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8'

Запит підтримує фільтрацію по наступним полям:

  • fullname - (ПІБ або емейл або логін)
  • position - Посада
  • department - Підрозділ
  • city - Місто
  • tags - Мітки користувача

Приклад запиту з пошуком по емейлу:

curl 'https://your-domain.davintoo.com/api/v2/users/list?filter[fullname][email protected] -H 'X-Cbr-Authorization: Bearer API_TOKEN' -H 'Content-Type: application/json;charset=UTF-8'


Відповідь

  • В разі успішного запиту (HTTP код відповіді - 200), буде повернено результат у форматі JSON виду:
    data - масив результатів
    "pager":{"current":1,"count":16,"total":155,"countPerPage":10} - об'єкт пагінації (інформація про кількість сторінок, поточну сторінку, к-сті результатів)

  • В разі помилки (HTTP код відповіді - 400) повертає JSON об'єкт з інформацією про помилку

Залишились питання?
Наша служба технічної підтримки завжди рада допомогти!
Напишіть нам на [email protected] або телефонуйте по номеру +380672170440. Якщо Ви зареєстровані на нашому Helpdesk - надішліть заявку за допомогою кнопки нижче.
Створити заявку