What is the Get Custom Field Information API?

The Get Custom Field Information API allows you to retrieve enabled member information field definitions in the current business, including field identifiers, names, types, and dropdown options.

This API supports Public Mode and Integration Mode.

Note:

This API only returns field definitions and configurations, not individual members' field values. To retrieve member information, use the Member Information Query API.

API Version History

API Version	Update Date	Description
v6	October 28, 2026	Initial version.

API Calling

The API retrieves enabled member information field definitions in the current business.

Request URL: https://api.jodoo.com/api/v6/corp/user/field/list

Request Rate: 30 times/second

Request Method: POST

Request Body Format: JSON

Request Parameters

Parameter	Required	Type	Description
locale	No	String	Language used for member information field names, such as `zh_cn` (Simplified Chinese), `zh_tw` (Traditional Chinese), or `en_us` (English). If omitted or unsupported, the server's default language is used.

Sample Request

{     "locale": "en_us" }

If no language needs to be specified, you can submit {}.

Responses

The API returns member information field definitions.

Response Parameters:

Parameter	Type	Description
fields	Object[]	List of member information fields. Returns `[]` if no matching fields are found.
fields[].widget_name	String	Field identifier used as the key in `ext` for member APIs.
fields[].name	String	Field name.
fields[].type	String	Field type, such as `text`, `number`, or `datetime`.
fields[].source	String	Field source: `preset` for preset fields or `custom` for custom fields.
fields[].no_repeat	Boolean	Whether duplicate values are not allowed. Returned only for single-line text fields.
fields[].items	Object[]	Dropdown options. Returned only for single-select and multi-select dropdown fields.
fields[].items[].text	String	Option text used when adding or updating member information.
fields[].items[].value	String	Option value, the same as `text`.
fields[].items[].selected	Boolean	Whether the option is selected by default. Omitted if not configured.

Sample Response

{     "fields": [         {             "widget_name": "_widget_0300000000013",             "name": "Employee ID",             "type": "text",             "source": "preset",             "no_repeat": true         },         {             "widget_name": "_widget_1800000000001",             "name": "Employment Type",             "type": "combo",             "source": "custom",             "items": [                 {                     "text": "Full-time",                     "value": "Full-time",                     "selected": true                 },                 {                     "text": "Part-time",                     "value": "Part-time",                     "selected": false                 }             ]         },         {             "widget_name": "_widget_1800000000002",             "name": "Hire Date",             "type": "datetime",             "source": "custom"         }     ] }

The example is for reference only. Actual fields depend on the business configuration.

Sample Error Response

If the API Key is not authorized to call this API, the following response is returned:

{     "code": 17054,     "msg": "Not among the authorized APIs.",     "meta": {         "apiId": "corp.user_field.list"     } }

Reading and Writing Custom Member Information Fields

The v6 member APIs support reading and writing custom member information fields. For details, see:

When adding, updating, or importing members, ext uses field identifiers as keys, and each field follows the { "value": value } format. When reading member information, field identifiers map directly to their values.

Type	Value to Write	Returned Value
text	Text, up to 50 characters	Text
number	A finite number or a numeric string that can be converted to a number	Number
datetime	A valid date string, datetime string, or millisecond timestamp, with an optional timezone	UTC ISO 8601 string
combo	Option `text`	Option text
combocheck	Array of option `text` values	Array of option texts
user	Member `username`	Object containing `username` and `status`
usergroup	Array of member `username` values	Array of member reference objects
dept	Integer department ID (`dept_no`)	Object containing `dept_no` and `status`
deptgroup	Array of integer department IDs	Array of department reference objects

Get Member Custom Field Information API