Введение

В данной статье будет рассказано, как можно создавать и обновлять пользователей через DealApp API. Все методы, описанные ниже требуют авторизацию через пользователя с настроенными правами по обновлению пользователей. О том, как производить авторизацию, можно прочитать в статье

Доступ через API

Методы API

Пользователи (users)

GET /api/v1/users

Возвращает список пользователей, зарегистрированных в организации.

Фильтры

Фильтры для списка пользователей

Вместе с фильтрами есть возможность передавать параметр search, который будет фильтровать пользователей по частичному имени или email.

Пример Запроса

curl -X GET -H @headers.txt '<https://api.prod1.dealapp.io/api/v1/users?filters[active]=true&search=petr>' | jq

Пример Ответа

{
  "data": [
    {
      "id": "2a6f96ae-c7e5-4a8f-9d56-e60fa30a40a7",
      "type": "users",
      "attributes": {
        "email": "[email protected]",
        "name": "Петр Петров ",
        "first-name": null,
        "last-name": "Петр Петров",
        "phone-number": null,
        "accepted-invitation": false,
        "integration-uid": "petr.petrov",
        "avatar-url": null,
        "active": true,
        "collisions-on-create": {},
        "invitation-sent": false,
        "last-active-at": null,
        "prefered-locale": "ru"
      },
      "relationships": {
        "role": {
          "data": {
            "id": "40aa6855-d789-4368-ba4a-a2166047f079",
            "type": "roles"
          }
        },
        "unit": {
          "data": {
            "id": "82d98a85-df2b-431c-bd6c-6307d27e89ae",
            "type": "units"
          }
        },
        "level": {
          "data": null
        },
        "origin-integration": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "page": 1,
    "total-pages": 1,
    "total-count": 1
  }
}

Так же можно добавить в запрос параметр include=unit,role, чтобы вместе с ответом получить вложенную информацию об отделе и роле пользователя. Пример ответа со вложением:

get-users-example.json

POST /api/v1/users

Создание пользователя с предоставленными данными.