Для разработчиков

Список дополнительных полей

GET/custom_properties

Схема дополнительных полей пространства: идентификатор, название и тип каждого. Такие поля доступны только для сотрудников и напоминаний, наборы у них независимые, а нужный выбирает параметр entity_type. Значения приходят в самой сущности — в карточке сотрудника или в напоминании. Идентификаторы отсюда нужны, чтобы эти значения задавать.

Поля типов «Файл» и «Множественный выбор» через API недоступны и в выдачу не попадают. Базовые поля карточки — имя, телефон, почта, отдел, теги — тоже: это не дополнительные поля.

Набор полей задаёт администратор пространства, он же их переименовывает и удаляет. Поэтому список стоит перечитывать перед работой: обращение к полю, которого уже нет, возвращает ошибку.

Параметры строки запроса

entity_type
string
*
Тип сущности
Возможные значения
Пример:User

Ответ

200OK
The request has succeeded.
data[]
array of objects
*
id
integer, (int32)
*
Идентификатор поля
Пример:1678
name
string
*
Название поля
Пример:Город
Длина:
<= 32 символов
data_type
string
*
Тип поля
Возможные значения
Пример:string
Список дополнительных полей
pachca custom-properties list \  --entity-type=User \  --json \  --token YOUR_ACCESS_TOKEN
Ответ 200
{  "data": [    {      "id": 1678,      "name": "Город",      "data_type": "string"    }  ]}