getUserCustomFields

Возвращает значения дополнительных ("кастомных") полей, которые есть у пользователя.

N.B. Метод не привязан к конкретному пользователю, и возвращает именно информацию о дополнительных пользовательских полях, заведённых в системе ГетКурса

import { getUserCustomFields } from '@getcourse/sdk'

async function getUserCustomFields(ctx: app.Ctx): Promise<UserCustomFields[]> {
  const result = await gcApiStrictCall<UserCustomFields[]>(ctx, 'user', {
    action: 'getCustomFields',
    actionParams: {},
  })
  return result
}

interface UserCustomFields {
  id: number
  title: string
  type: 'string' | 'numeric' | 'text' | 'checkbox' | 'select' | 'multi_select' | 'date' | 'file'
  units: string | null
  values: Record<string, string> | []
}

Описание объекта UserCustomFields

Параметр	Тип	Описание
id	number	Идентификатор поля
title	string	Название поля
type	string	Тип поля
units	string или null	Единица измерения. Может быть пустым
values	object	Список доступных значений для полей select и multi_select

Идентификатор поля необходим при установке пользователю значений дополнительных полей. См. setUserCustomFields

Примеры

Вернуть список доступных дополнтельных пользовательских полей

import { getUserCustomFields } from '@getcourse/sdk'

let customFields = await getUserCustomFields(ctx)

Для получения значения дополнительных полей конкретного пользователя можно воспользоваться методом getGcUserData