GET api/2.0/crm/{entityType}/customfield/definitions

Для этой функции требуется аутентификация.

Описание

Возвращает список описаний для всех существующих пользовательских полей.

Параметры

Название	Описание	Тип	Пример
entityType sent in url	Тип сущности Допустимые значения: contact, person, company, opportunity, case	строковый	текст

Пример

GET api/2.0/crm/some+text/customfield/definitions
Host: yourportal.r7-office.ru
Content-Type: application/json
Accept: application/json

Возвращает
Список настраиваемых полей

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

application/json

{
  "status": 0,
  "response": [
    {
      "relativeItemsCount": 0,
      "entityId": 14523423,
      "label": "Birthdate",
      "fieldValue": "2022-10-08T15:03:33.1475255Z",
      "fieldType": 5,
      "position": 10,
      "mask": "",
      "id": 0
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <relativeItemsCount>0</relativeItemsCount>
    <entityId>14523423</entityId>
    <label>Birthdate</label>
    <fieldValue>2022-10-08T15:03:33.1475255Z</fieldValue>
    <fieldType>5</fieldType>
    <position>10</position>
    <mask></mask>
    <id>0</id>
  </response>
</result>