Service Desk

Задача

Создадим клиента (юр.лицо), заполнив поля.

POST https://apigw.intradesk.ru/settings/api/v3/clients/LegalEntities?ApiKey=65247DBDE14C45A6A275DC1FC0

Решение

Тело запроса:

Пример тела запроса на создание клиента


{
    "name": "Инженерия+",
    "description": "Разработка и сопровождение",
    "email": "inj@company.com",
    "web": "http://www.main.inj.org",
    "address": "ул. Фрунзе 4а",
    "phoneNumbersList": [
        {
            "phoneNumber": "+78001234568",
            "phoneExt": "12",
            "default": true
        }
    ],
    "domains": [],
    "taxpayerNumber": null,
    "contactPersonFirstName": "Василий",
    "contactPersonEmail": "k1@test.com",
    "contactPersonLastName": "Гунько",
    "contactPersonMiddleName": null,
    "contactPersonPhoneNumbersList": [
        {
            "phoneNumber": "+78001234567",
            "phoneExt": "000",
            "default": true
        }
    ],
    "timeZoneCode": "Europe/Moscow",
    "fieldIdValues": [
        {
            "id": 1595,
            "value": "two"
        }
    ],
    "userGroupTags": [
        {
            "id": 400581
        }
    ],
    "managerId": 915120
}

Ответ сервера:

Идентификатор созданного клиента (статус-код 200)

Полная документация к методу в формате swagger (Settings API)

Другие возможные параметры

POST https://apigw.intradesk.ru/settings/api/v3/clients/LegalEntities?ApiKey=65247DBDE14C45A6A275DC1FC0

Тело запроса:


{
//обязательные поля
 "name" //строка, название клиента
 "contactPersonFirstName" 	//строка, имя контактного лица
//необязательные поля
 "description" //строка, описание клиента
 "email" //строка, email клиента
 "web" //строка, web-сайт клиента
 "address" //строка, адрес клиента
 "phoneNumbersList" //массив, телефонные номера  
 "domains" //массив строк, домены клиента
 "taxpayerNumber" //строка, номер налогоплательщика (ИНН)
 "contactPersonEmail" //строка, email контактного лица
 "contactPersonLastName" //строка, фамилия контактного лица
 "contactPersonMiddleName" //строка, отчество контактного лица
 "contactPersonPhoneNumbersList" //массив, телефоны контактного лица
 "timeZoneCode" // строка, часовой пояс (IANA)
 "fieldIdValues" //массив, значения дополнительных полей
 "userGroupTags" //массив, теги клиента
 "managerId" // число, идентификатор пользователя-менеджера
}

Создание клиента (физ.лицо)

Задача

Создадим клиента (физ.лицо), заполнив поля.

POST https://apigw.intradesk.ru/settings/api/v3/clients/PhysicalPersons?ApiKey=65247DBDE14C45A6A275DC1FC0

Решение

Тело запроса:

Пример тела запроса на создание клиента


{
    "description": "Разработка и сопровождение",
    "address": "ул. Фрунзе 4а",
    "contactPersonFirstName": "Василий",
    "contactPersonEmail": "inj@company.com",
    "contactPersonLastName": "Гунько",
    "contactPersonMiddleName": "",
    "contactPersonRoleId": 263947,
    "contactPersonPhoneNumbersList": [
        {
            "phoneNumber": "+78001234567", //номер телефона
            "phoneExt": "123", //добавочный номер
            "default": true //признак того, что это основной номер пользователя
        }
    ],
    "timeZoneCode": "Europe/Moscow",
    "fieldIdValues": [
        {
            "id": 1595,
            "value": "two"
        }
    ],
    "userGroupTags": [
        {
            "id": 400581
        }
    ],
    "managerId": 915120
}

Ответ сервера:

Идентификатор созданного клиента (статус-код 200)

Полная документация к методу в формате swagger (Settings API)

Другие возможные параметры

POST https://apigw.intradesk.ru/settings/api/v3/clients/PhysicalPersons?ApiKey=65247DBDE14C45A6A275DC1FC0

Тело запроса:



{
//обязательные поля
 "contactPersonFirstName" //строка, имя клиента
//необязательные поля
 "description" //строка, описание клиента
 "contactPersonEmail" //строка, email клиента
 "address" //строка, адрес клиента
 "contactPersonLastName" //строка, фамилия клиента
 "contactPersonMiddleName" //строка, отчество клиента
 "contactPersonPhoneNumbersList" //массив, телефоны клиента
 "contactPersonRoleId" //число, идентификатор роли
 "timeZoneCode" // строка, часовой пояс (IANA)
 "fieldIdValues" //массив, значения дополнительных полей
 "userGroupTags" //массив, теги клиента
 "managerId" // число, идентификатор пользователя-менеджера
}

Создание пользователя юр.лица

Задача

Создадим пользователя, заполнив поля и прикрепим его к клиенту(юр.лицу).

Решение

POST https://apigw.intradesk.ru/settings/api/v3/clients/LegalEntities/Users?ApiKey=65247DBDE14C45A6A275DC1FC0

Тело запроса:


{
  "firstName": "Петр",	
  "lastName": "Тракторенко",
  "email": "tpn@company.com",	
  "password": "111111",
  "roleId": 145633,
  "fieldIdValues": [ 
    {
      "id": 705,
      "value": "два"
    }
  ],
  "middleName": "Николаевич",	
  "phoneNumbers": [
    {
      "phoneNumber": "+78001234677",
      "phoneExt": null,	
      "default": true	
    }
  ],
  "userGroups": [	
    {
      "id": 182907,	
      "isDefault": true	
    }
  ],
  "isArchived": false,	
  "fotoImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD…",
  "additionalEmails": [	
    "npt@company.com"
  ],  
  "isNewFoto": true,
  "timeZoneCode": "Europe/Moscow",
  "userTags": [	
    {
      "id": 279504
    }
  ]
}

Ответ сервера:

Идентификатор созданного клиента (статус-код 200)

Полная документация к методу в формате swagger (Settings API)

Другие возможные параметры

POST https://apigw.intradesk.ru/settings/api/v3/clients/LegalEntities/Users?ApiKey=65247DBDE14C45A6A275DC1FC0

Тело запроса:


{
	//обязательные поля
  "firstName", 	//строка, имя пользователя
  "userGroups": [	//массив объектов,  компании, к которым прикреплен пользователь
    {
      "id",	//число, идентификатор клиента
      "isDefault"	//признак, является ли клиент основным
    }
  ]
 	//необязательные поля
  "lastName",		//строка, фамилия пользователя
  "email",	// строка, эл.почта пользователя
  "password",	// строка, пароль
  "roleId",	//число, идентификатор роли пользователя
  "fieldIdValues": [	 //значения доп.полей
    {
      "id"	//число, идентификатор поля
      "value"	//разные типы, значения полей
    }
  ],
  "middleName",	// строка, отчество пользователя
  "phoneNumbers": [	//массив объектов, тел. номера
    {
      "phoneNumber",	// строка, номер телефона
      "phoneExt",	// строка, добавочный номер
      "default"	//признак, является ли номер основным
    }
  ],
  "isArchived"	//признак, удален ли пользователь(заархивирован)
  "fotoImage",	// строка, фото пользователя.
  "additionalEmails": [],  	//массив строк, дополнительные эл.почты  
  "isNewFoto"	//признак, что фото новое и нужно обновить
  "timeZoneCode",	// строка, часовой пояс
  "userTags": [	//массив объектов, тегов
    {
      "id"	//число, идентификатор тега
    }
  ]
}

Обновление клиента (физ. лицо)

Задача

Обновить клиента "Петра Иванова" с id равным 288596.

PATCH https://apigw.intradesk.ru/settings/api/v3/clients/PhysicalPersons?ApiKey=65247DBDE14C45A6A275DC1FC0

Решение

Тело запроса:


{
    "id": 288596,
    "contactPersonFirstName": "Петр",
    "contactPersonLastName": "Иванов",
    "contactPersonMiddleName": "",
    "contactPersonEmail": "my@company.ru",
    "description": "",
    "contactPersonPhoneNumbersList": [
        {
            "phoneNumber": "+78001234567", //номер телефона
            "phoneExt": "000", //добавочный номер
            "default": true //признак того, что это основной номер пользователя
        }
    ],	
    "address": "Ленина 30б",
    "timeZoneCode": "Europe/Moscow",
    "fieldIdValues": [
        {
            "id": 1595, //идентификатор доп.поля
            "value": "three" //значение доп.поля
        }
    ],
    "contactPersonFieldIdValues": [
        {
            "id": 1048, //идентификатор доп.поля клиента(пользователя)
            "value": "три" //значение доп.поля клиента(пользователя)
        }
    ],
    "contactPersonRoleId": 263942,
    "contactPersonAdditionalEmails": [
        "sale.my@company.ru"
    ],
    "userGroupTags": [
        {
            "id": 400577
        }
    ],
    "managerId": 915107,
    "contactPersonUserTags": [
        {
            "id": 400581
        }
    ],
    "contactPersonIsNewFoto": true,
    "contactPersonFotoImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAMCAgICAgMCAgID"
}

Ответ сервера:

Видим, что статус-код 200, isSuccess = true. Значит изменения применились успешно.

Полная документация к методу в формате swagger (Settings API)

Другие возможные параметры

PATCH https://apigw.intradesk.ru/settings/api/v3/clients/PhysicalPersons?ApiKey=65247DBDE14C45A6A275DC1FC0

Тело запроса:

Обязательные поля:
"id" - идентификатора клиента для изменения.
"contactPersonFirstName" - имя клиента.
"contactPersonLastName" - фамилия клиента.
"managerId" - идентификатор пользователя-менеджера. Если не передать - значение будет обнулено.


{
    "id" // число, идентификатор клиента
    "contactPersonFirstName"	//строка, имя клиента
    "contactPersonLastName"	//строка, фамилия клиента
    "contactPersonMiddleName" //строка, отчество клиента
    "contactPersonEmail" //строка, email клиента
    "description" //строка, описание клиента
    "contactPersonPhoneNumbersList" //массив, телефонные номера  
    "address" //строка, адрес клиента
    "timeZoneCode" // строка, часовой пояс (IANA)
    "fieldIdValues" //массив, значения дополнительных полей физ.лица
    "contactPersonFieldIdValues" //массив, значения дополнительных полей клиента(пользователя)
    "contactPersonRoleId" // число, идентификатор роли клиента(пользователя)
    "contactPersonAdditionalEmails" //массив строк, значения дополнительных эл.почт клиента(пользователя)
    "userGroupTags"	//массив, теги клиента
    "managerId" // число, идентификатор пользователя-менеджера,
    "contactPersonUserTags" //массив, теги клиента(пользователя)
    "contactPersonIsNewFoto" //признак того, что фото пользователя обновлено
    "contactPersonFotoImage" //строка, фото пользователя
}

Обновление клиента (юр. лицо)

Задача

Обновить клиента "Моя Компания" с id равным 288590.

PATCH https://apigw.intradesk.ru/settings/api/v3/clients/LegalEntities?ApiKey=65247DBDE14C45A6A275DC1FC0

Решение

Тело запроса:


{
    "id": 288590,
    "name": "Моя Компания",
    "description": "",
    "email": "my@company.ru",
    "web": "http://my.company.ru",
    "address": "Ленина 30б",
    "phoneNumbersList": [
        {
            "phoneNumber": "+78001234567", //номер телефона
            "phoneExt": "000", //добавочный номер
            "default": true //признак того, что это основной номер клиента
        }
    ],	
    "domains": [
        "maintech"
    ],
    "taxpayerNumber": "123456",
    "timeZoneCode": "Europe/Moscow",
    "fieldIdValues": [
        {
            "id": 1595,  //идентификатор доп.поля
            "value": "one" //значение доп.поля
        }
    ],
    "userGroupTags": [
        {
            "id": 400577
        }
    ],
    "contactPersonId": 915115,
    "managerId": 915120
}

Ответ сервера:

Видим, что статус-код 200, isSuccess = true. Значит изменения применились успешно.

Полная документация к методу в формате swagger (Settings API)

Другие возможные параметры

PATCH https://apigw.intradesk.ru/settings/api/v3/clients/LegalEntities?ApiKey=65247DBDE14C45A6A275DC1FC0

Тело запроса:

Обязательные поля:
"id" - идентификатора клиента для изменения.
"managerId" - идентификатор пользователя-менеджера. Если не передать - значение будет обнулено.


{
    "id" // число, идентификатор клиента
    "name" //строка, название клиента
    "description" //строка, описание клиента
    "email" //строка, email клиента
    "web" //строка, web-сайт клиента
    "address" //строка, адрес клиента
    "phoneNumbersList" //массив, телефонные номера  
    "domains" //массив строк, домены клиента
    "taxpayerNumber" //строка, номер налогоплательщика (ИНН)
    "timeZoneCode" // строка, часовой пояс (IANA)
    "fieldIdValues" //массив, значения дополнительных полей
    "userGroupTags"	//массив, теги клиента (идентификатор и название)
    "contactPersonId" // число, идентификатор контактного пользователя
    "managerId" // число, идентификатор пользователя-менеджера
}

Обновление пользователя клиента (юр. лица)

Задача

Изменим пользователя Петрова Аркадия с id=13 и ролью roleid=13, привязанного к клиенту(юр.лицу) с id=353

Решение

PATCH https://apigw.intradesk.ru/settings/api/v3/clients/LegalEntities/Users?ApiKey=65247DBDE14C45A6A275DC1FC0

Тело запроса:


{
  "id": 13,
  "firstName": "Аркадия",	
  "lastName": "Петрова",
  "middleName": "Степановна",
  "email": "iv@mycompany.org",
  "userGroups": [
    {
      "isDefault": true,	
      "id": 353	
    }
  ],
  "phoneNumbers": [
    {
         "phoneNumber": "+78001234567",
         "default": true,
         "phoneExt": null,
    }
  ],
  "isArchived": false,	
  "fotoImage":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAIAAAACUFjqAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAYSURBVChTYzx8+DADbsAEpXGAkSnNwAAAzUQCXbuxMToAAAAASUVORK5CYII=",
  "timeZoneCode": "Europe/Moscow",
  "additionalEmails": [
    "iv@mail.ru"
  ],
  "roleId": 145633,
  "fieldIdValues": [
    {
      "id": 705,	
      "value": "два"
    }
  ],
  "isNewFoto": false, 
  "userTags": [
    {
      "id": 279504
    }
  ]
}

Ответ сервера:

Сервер пришлет id изменяемого клиента и статус-код 200. Значит изменения применились успешно.

Полная документация к методу в формате swagger (Settings API)

Другие возможные параметры

PATCH https://apigw.intradesk.ru/settings/api/v3/clients/LegalEntities/Users?ApiKey=65247DBDE14C45A6A275DC1FC0

Тело запроса:

Обязательно указание поля "id" - идентификатора пользователя клиента для изменения.


{
  "id", //число, идентификатор клиента
  "firstName", //строка, имя клиента
  "lastName", //строка, фамилия клиента
  "middleName", //строка, отчество клиента
  "email",	//строка, электронная почта клиента
  "userGroups": [ //массив объектов, идентификаторы групп
    {
      "isDefault", //признак, является ли компания основной
      "id"	//число, идентификатор компании
    }
  ],
  "phoneNumbers": [ //массив, телефонные номера
    {
       "phoneNumber", //строка, номер телефона
       "default", //признак того, что это основной номер пользователя
       "phoneExt",	//строка, добавочный номер
    }
  ],
  "isArchived", //признак, удален ли клиент (заархивирован)
  "fotoImage", //строка, фото клиента. Чтобы обновилось, необходимо также передать флаг "isNewLogo"
  "timeZoneCode", //строка, часовой пояс
  "additionalEmails", //массив строк,  дополнительные эл.почты  
  "roleId", //число, идентификатор роли
  "fieldIdValues": [ //массив объектов, значения для доп.полей
    {
      "id", //число, идентификатор доп.поля
      "value", //различные типы, значение доп.поля
    }
  ],
  "isNewFoto",	//признак, фото клиента обновлено. 
  "userTags": [	//массив объектов, идентификаторы тегов
    {
      "id" //число, идентификатор тега
    }
  ]
}

Получение клиента

Задача

Получим клиента, у которого id равен 288591

GET https://apigw.intradesk.ru/settings/odata/v2/Clients?$filter=(id eq 288591)&ApiKey=61329BA1030E49468DFB672AF6

Решение

Ответ сервера:

Получим данные о запрашиваемом клиенте

Полная документация к методу в формате swagger (Settings API)

Другие возможные параметры

GET https://apigw.intradesk.ru/settings/odata/v2/Clients?ApiKey=65247DBDE14C45A6A275DC1FC0

Для получения информации о клиенте по его идентификатору, необходимо воспользоваться запросом на получение списка клиентов, с указанием фильтра (параметр $filter) по идентификатору.
Подробнее о запросе см. в статье «Получение списка клиентов»

Получение клиента по номеру телефона

Задача

Выполним запрос для получения клиентов, телефон которых равен '8001234567'.

GET https://apigw.intradesk.ru/settings/odata/v2/Clients?$filter=(contains(searchField, '8001234567'))&ApiKey=61329BA1030E49468DFB672AF6

Решение

Ответ сервера:

Получим данные о всех клиентов, у которых номер телефона подошел под запрашиваемую строку (в данном случай один клиент)

Полная документация к методу в формате swagger (Settings API)

Другие возможные параметры

GET https://apigw.intradesk.ru/settings/odata/v2/Clients?$filter=(contains(searchField, '8001234567'))&ApiKey=61329BA1030E49468DFB672AF6

Для получения информации о пользователе клиенте по его телефону, необходимо воспользоваться запросом на получение списка пользователей клиентов, с указанием фильтра (параметр $filter).
В результате может быть больше 1-ого клиента - чем больше цифр номера, тем точнее результат.
Подробнее о запросе см. в статье «Получение списка клиентов (пользователей)»

Получение списка клиентов

Задача

Получим первую запись (одну), отсортировав по имени, по убыванию, отфильтровав только не архивные (не удаленные) записи.

Решение

GET https://apigw.intradesk.ru/settings/odata/v2/Clients?ApiKey=61329BA1030E49468DFB672AF6&$skip=0&$top=1&$orderby= name desc&$filter=(isarchived eq false)

Ответ сервера:


{
    "@odata.count": 2,	//кол-во совпадений (игнорируя skip и top)
    "value": [       
        {
            "id": 288590, //идентификатор клиента
            "clientType": 10, //тип клиента. 10 - юр.лицо, 20 - физ.лицо
            "name": "Моя Компания", //название клиента
            "contactPersonId": 915115, //идентификатор контактного лица
            "contactPerson": { //данные контактного лица
                "id": 915115, //идентификатор контактного лица
                "name": null, //полное имя контактного лица
                "lastName": "Иванов", //фамилия контактного лица
                "firstName": "Петр", //имя контактного лица
                "middleName": "", //отчество контактного лица
                "roles": null, //роли контактного лица
                "additionalEmails": [], //список доп. электронных почт контактного лица
                "phoneNumbersList": [], //список телефонов контактного лица
                "email": "c12@intra5.ru", //эл.почта контактного лица
                "emailConfirmed": false, //признак, подтверждена ли эл.почта контактного лица
                "userClientFieldValues": null, //значения доп.полей контактного лица
                "fields": null //значения доп.полей контактного лица
            },
            "taxpayerNumber": "123456",  // ИНН
            "description": "", // описание
            "address": "Ленина 30б", //адрес
            "email": "my@company.ru", //эл.почта
            "web": "http://my.company.ru", //web-сайт
            "domains": [ //список доменов
                "maintech"
            ],
            "isArchived": false, //признак, удален ли(заархивирован) клиент
            "groupTags": [ //массив тэгов клиента
                {
                    "userGroupId": 288590, //идентификатор клиента
                    "tagId": 400577, //идентификатор тэга
                    "tag": {
                        "isArchived": false,  //признак, удален ли(заархивирован) тэг
                        "id": 400577, //идентификатор тэга
                        "name": "Информирование" //название тэга
                    }
                }
            ],
            "phoneNumbersList": [ //массив телефонов клиента
                {
                    "phoneNumber": "+78001234567", //номер телефона
                    "default": true, //признак того, что это основной номер пользователя
                    "phoneExt": "000", //добавочный номер
                    "phoneInternational": "+7 800 123-45-67" //номер телефона в международном формате
                }
            ],
            "timeZoneCode": "Europe/Moscow", //часовой пояс(IANA)
            "userGroupFieldValues": [ //массив доп.полей клиента
                {
                    "userGroupFieldId": 1595, //идентификатор доп.поля
                    "value": "one" //значение доп.поля
                }
            ],
            "fields": { //массив доп.полей клиента (алиас поля / значение)
                "addfield_vypadaiushchaia_dopka_kompanii_v_5keSingleSelect": "one"
            },
            "updatedAt": "2022-02-03T09:08:36.3691610Z", //дата последнего обновления информации о клиенте
            "updatedBy": "customer_34969", //автор последнего обновления информации о клиенте
            "managerId": 915120, //идентификатор менеджера
            "manager": { //данные менеджера
                "id": 915120, //идентификатор менеджера
                "updatedAt": "0001-01-01T00:00:00.0000000Z", //дата последнего обновления информации о менеджере
                "name": "Петр Семенов ", //полное имя менеджера
                "sortOrder": null, //порядок сортировки менеджера среди пользователей
                "description": null, //описание менеджера
                "isArchived": null, //признак, удален ли(заархивирован) менеджер
                "searchString": null //значение для умного поиска для менеджера
            }
        }
    ]
}

Полная документация к методу в формате swagger (Settings API)

Другие возможные параметры

GET https://apigw.intradesk.ru/settings/odata/Clients?ApiKey=65247DBDE14C45A6A275DC1FC0

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

$skip - количество клиентов, которое нужно пропустить, используется для постраничного листания клиентов
$top - количество клиентов, которое нужно вернуть, используется для постраничного листания клиентов
$orderby - название поля для сортировки в списке
$filter - используется для фильтрации списка клиентов. “$filter=(isArchived eq false)" для вывода всех не удаленных записей (не архивных)
$count - true - будет подсчитано количество клиентов, удовлетворяющих запросу

Фильтрация списка
Аналог строки поиска (поиск совпадения строки в полях название, описание, телефоны, email, дополнительная информация, веб адрес)
$filter=(contains(searchField, 'строка поиска'))

Теги
содержит любое из: $filter=((tags/any(s: s/tagId eq {tagid}))

Телефоны
- заданы - $filter=(PhoneNumbers/any())
- не заданы- $filter=(not PhoneNumbers/any())

Название
- содержит строку- $filter=(contains(name, 'строка поиска'))

Описание
- cодержит строку- $filter=(contains(description, 'строка поиска'))

Удалена
- да - $filter=(isArchived eq true)
- нет - $filter=(isArchived eq false)

Получение списка пользователей клиентов

Задача

Получим самую первую запись, отсортировав по убыванию по id, отфильтровав только не архивные (не удаленные) записи

GET https://apigw.intradesk.ru/settings/odata/ClientUsers?ApiKey=65247DBDE14C45A6A275DC1FC0$skip=0&$top=1&$orderby id desc&$filter=(isarchived eq false)

Решение

Ответ сервера:


{
    "@odata.count": 10,	//кол-во совпадений (игнорируя top и skip)
    "value": [	//массив данных по каждому попавшему в выборку клиенту
        {
            "id": 603176,	//идентификатор клиента
            "updatedAt": "2021-08-13T15:05:10.5768800Z",	//дата последнего обновления
            "name": "Гунько Василий Петрович", //ФИО клиента (составляется из 3х полей: имя, фамилия и отчество)
            "firstName": "Василий",	//имя клиента
            "lastName": "Гунько ",	//фамилия клиента
            "middleName": "Петрович",	//отчество клиента
            "email": "inj5@company.com",	//электронная почта клиента
            "userName": "inj5@company.com", 	//имя клиента для входа в систему
            "password": null,	//пароль. Скрыт системой, просмотр не доступен
            "type": 20,	//тип. 20 – клиент, 10 - сотрудник
            "clientType": 20,  //тип клиента. 20 – физ.лицо, 10 - юр.лицо
            "roles": [	//роли
                {
                    "roleId": 145635
                }
            ],
            "groups": [	//компании, в которых числится клиент
                {
                    "id": 432527,
                    "userGroupId": 182911,
                    "userId": 603176,
                    "userGroup": {
                        "id": 182911,
                        "name": "Инженерия"
                    },
                    "isDefault": true
                }
            ],
            "userTags": [	//теги, прикрепленные к клиенту
                {
                    "userId": 603176,
                    "tagId": 279504,
                    "tag": {
                        "id": 279504,
                        "name": "Информирование"
                    }
                }
            ],
            "sortDirection": 0,	//направление сортировки
            "isArchived": false,		//признак, не удален ли клиент (заархивирован)
            "phoneNumbers": [		//телефонные номера
                {
                    "phoneNumber": "+78001234567",	//номер телефона
            	"default": true,	//признак того, что это основной номер пользователя
            	"phoneExt": null,	//добавочный номер
           	"phoneInternational": "+7 800 123-45-67"	//номер телефона в международном формате
                }
            ],
            "workingScheduleId": null,	//идентификатор рабочего расписания
            "userClientFieldValues": [		//значения доп.полей
                {
                    "userFieldId": 705,
                    "value": "три"
                }
            ],
            "fields": {	//значения доп.полей
                "addfield_rejimSingleSelect": "три"
            },
            "fotoImage": null,	//строка, фотография клиента
            "activeTaskNumber": null,	//идентификатор текущей заявки
            "updatedBy": "customer_19359",	//автор последних изменений
            "timeZoneCode": "Europe/Moscow",	//часовой пояс
            "emailConfirmed": false,	//признак, подтверждена ли эл.почта
            "additionalEmails": []	//список дополнительных эл.почт
        }
    ]
}

Полная документация к методу в формате swagger (Settings API)

Другие возможные параметры

GET https://apigw.intradesk.ru/settings/odata/ClientUsers?ApiKey=65247DBDE14C45A6A275DC1FC0

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

$skip - количество пользователей клиентов, которое нужно пропустить, используется для постраничного листания клиентов
$top - количество пользователей клиентов, которое нужно вернуть, используется для постраничного листания клиентов
$orderby - название поля для сортировки в списке
$filter - используется для фильтрации списка пользователей клиентов. “$filter=(isArchived eq false)" для вывода всех не удаленных записей (не архивных)
$count - true - будет подсчитано количество пользователей клиентов, удовлетворяющих запросу

Фильтрация списка
Аналог строки поиска (поиск совпадения строки в полях ФИО, телефоны, email, дополнительных полях типа текст и строка)
$filter=(contains(searchField, 'строка поиска'))

Поиск по почте
Указываем интересующий нас e-mail или его часть в фильтре: $filter=(contains(searchField, 'user@mail.com'))

Теги
содержит любое из: $filter=((tags/any(s: s/tagId eq {tagid}))

Телефоны
- заданы - $filter=(PhoneNumberList/any())
- не заданы- $filter=(not PhoneNumberList/any())

Роль
содержит любое из: $filter=((roles/any(s: s/roleId eq {roleId})))

Удален
- да- $filter=(isArchived eq true)
- нет - $filter=(isArchived eq false)

Тип клиента
- юр.лица - $filter=(cast(clientType , Edm.String) eq '10')
- физ.лица - $filter=(cast(clientType , Edm.String) eq '20')

Несколько условий можно объединять. Например, найти записи, в которых содержится подстрока "мой текст" и клиенты которых являются юр.лицами
$filter=(contains(searchField, 'мой текст')) and (cast(clientType , Edm.String) eq '10')

Удаление (архивирование) клиента

Задача

Удалим клиентов с идентификаторами 785 и 901.

Решение

DELETE https://apigw.intradesk.ru/settings/api/v3/clients/LegalEntities?ApiKey=65247DBDE14C45A6A275DC1FC0

Тело запроса:


{
  "ids":[785, 901]
}

Ответ сервера:


{
    "isSuccess": true,
    "message": null,
    "errorType": null
}

Полная документация к методу в формате swagger (Settings API)

Другие возможные параметры

DELETE https://apigw.intradesk.ru/settings/api/v3/clients/LegalEntities?ApiKey=65247DBDE14C45A6A275DC1FC0

Тело запроса:


{
  "ids":[{companyid1}, {companyid2}, ..., {companyidN}]
}

"ids" - массив идентификаторов клиентов

Удаление (архивирование) пользователей клиентов (юр.лиц)

Задача

Удалим пользователей-клиентов с идентификаторами 785 и 901.

DELETE https://apigw.intradesk.ru/settings/api/v3/clients/LegalEntities/Users?ApiKey=65247DBDE14C45A6A275DC...

Решение

Тело запроса:


{
  "ids":[785, 901]
}

Ответ сервера:


{
    "isSuccess": true,
    "message": null,
    "errorType": null
}

Полная документация к методу в формате swagger (Settings API)

Другие возможные параметры

DELETE https://apigw.intradesk.ru/settings/api/v4/clients/LegalEntities/Users?ApiKey=65247DBDE14C45A6A275DC1FC0

Тело запроса:


{
  "ids":[{userid1}, {userid2}, ..., {useridN}]
}

"ids" - массив идентификаторов пользователей-клиентов

Восстановление (разархивирование) пользователей клиентов

Задача

Восстановим пользователя клиента с идентификатором 1234

Решение

Для физ.лиц:
PUT https://apigw.intradesk.ru/settings/api/v3/clients/PhysicalPersons/RestoreUser/00000?ApiKey=65247DBDE14C45A6A275DC

Для юр.лиц:
PUT https://apigw.intradesk.ru/settings/api/v3/clients/LegalEntities/Users/Restore/00000?ApiKey=65247DBDE14C45A6A275DC

Ответ сервера:


{
    "isSuccess": true,
    "message": null,
    "errorType": null
}

Полная документация к методу в формате swagger (Settings API)

Другие возможные параметры

Для физ.лиц:
PUT https://apigw.intradesk.ru/settings/api/v3/clients/PhysicalPersons/RestoreUser/1234?ApiKey=65247DBDE14C45A6A275DC1FC1

Для юр.лиц:
PUT https://apigw.intradesk.ru/settings/api/v3/clients/LegalEntities/Users/Restore/1234?ApiKey=65247DBDE14C45A6A275DC

вместо 1234 указать нужный идентификатор пользователя