API Docs

Get User Custom Fields

Get User Custom Fields

Retrieves the custom fields of a specified user.

This API can be used to create UI that displays user information, based on the target user's information. When retrieving the logged-in user's custom fields, private custom fields can also be retrieved.

Function

kintone.user.getCustomFields(code)

Parameters

Parameter Type Required Description
code String The login name. If ignored, the logged-in user's information will be retrieved.

Returns

A Promise object.
When the Promise object is fulfilled, an array of objects containing the following elements can be retrieved:

Property Type Value & Description
code String Field code
name String Field name
type String Field type
  • SINGLE_LINE_TEXT: text
  • USER_SELECT: user selection
value String/Object The saved values
The type of data depends on the type
  • For SINGLE_LINE_TEXT: Single-line text
  • For USER_SELECT: object
value.code String User code
Exists only if type is USER_SELECT
value.name String User name
Exists only if type is USER_SELECT
visibility String Visibility settings
  • PUBLIC: Public
  • PRIVATE: Private

Available Pages

However, it cannot be used on the following pages:

  • Search results
  • Marketplace
  • Plug-in settings page

Notes

This API retrieves data from the server at runtime. The retrieved data is cached until a screen transition occurs.
If there are more than 50 data retrievals from the server per minute per user, the returned Promise object will be rejected.