# Get Custom Field By specifying a custom field GUID, get its detailed information. **Notice**：Obtaining a custom field requires read permission for the custom field. ## Request Facts |   ---|--- HTTP URL | https://open.feishu.cn/open-apis/task/v2/custom_fields/:custom_field_guid HTTP Method | GET Rate Limit | [100 per minute](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN) Supported app types | Custom App、Store App Required scopes
**To use this API, you must have at least 1 of the listed scopes.**
Enable any scope from the list | View custom field(task:custom_field:read)
View, create, and update custom field(task:custom_field:write) Required field scopes | **Notice**：The response body of the API contains the following sensitive fields, and they will be returned only after corresponding scopes are added. If you do not need the fields, it is not recommended that you request the scopes.
Obtain user ID(contact:user.employee_id:readonly) ### Request header Parameter | Type | Required | Description ---|---|---|--- Authorization | string | Yes | `tenant_access_token`
or
`user_access_token`
**Value format**: "Bearer `access_token`"
**Example value**: "Bearer u-7f1bcd13fc57d46bac21793a18e560"
[How to choose and get access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) ### Path parameters Parameter | Type | Description ---|---|--- custom_field_guid | string | custom field GUID, which can be created by[Create Custom Field](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/create), or queried by[List Custom Field](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/custom_field/list).
**Example value**: "5ffbe0ca-6600-41e0-a634-2b38cbcf13b8" ### Query parameters Parameter | Type | Required | Description ---|---|---|--- user_id_type | string | No | User ID categories
**Example value**: open_id
**Optional values are**:
- open_id：Identifies a user to an app. The same user has different Open IDs in different apps. [How to get Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：Identifies a user to a tenant that acts as a developer. A user has the same Union ID in apps developed by the same developer, and has different Union IDs in apps developed by different developers. A developer can use Union ID to link the same user's identities in multiple apps.[How to get Union ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：Identifies a user to a tenant. The same user has different User IDs in different tenants. In one single tenant, a user has the same User ID in all apps （including store apps）. User ID is usually used to communicate user data between different apps. [How to get User ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
**Default value**: `open_id`
**When the value is `user_id`, the following field scopes are required**:
Obtain user ID(contact:user.employee_id:readonly) ## Response ### Response body Parameter | Type | Description ---|---|--- code | int | Error codes, fail if not zero msg | string | Error descriptions data | \- | \- custom_field | custom_field | Get custom field data guid | string | GUID for custom fields name | string | Custom field name type | string | custom field type number_setting | number_setting | number field setting format | string | number display format
**Optional values are**:
- normal：regular number format
- percentage：percentage format
- cny：RMB format
- usd：USD format
- custom：custom symbol format custom_symbol | string | Custom Symbol custom_symbol_position | string | Customize the display position of symbols.
**Optional values are**:
- left：Custom symbols are placed to the left of the numbers
- right：Custom symbols are placed to the right of the number separator | string | separator format in the integer part
**Optional values are**:
- none：no separator
- thousand：thousand separator decimal_count | int | The number of decimal places. If the entered number value has more decimal places than this setting, the extra digits will be rounded and discarded. If 'format' is "percentage", it means the number of decimal places after becoming a percentage. member_setting | member_setting | member field setting multi | boolean | Whether to support multiple selection datetime_setting | datetime_setting | datetime field setting format | string | datetime display format single_select_setting | select_setting | single select field setting options | option\[\] | single select option guid | string | option GUID. name | string | Option name, cannot be empty, maximum 50 characters color_index | int | The color index value of the option, which can be a number from 0 to 54. If not filled in, one will be randomly selected. is_hidden | boolean | Whether the option is hidden. The hidden option is not visible in the app UI, and the field value can no longer be set to this option through openapi. multi_select_setting | select_setting | multi select setting options | option\[\] | multi select options guid | string | Option GUID. name | string | Option name, cannot be empty, maximum 50 characters color_index | int | The color index value of the option, which can be a number from 0 to 54. If not filled in, one will be randomly selected. is_hidden | boolean | Whether the option is hidden. The hidden option is not visible in the interface, and the field value can no longer be set to this option through openapi. creator | member | creator id | string | Indicates the id of member type | string | member type role | string | member role name | string | Member name created_at | string | custom field create timestamp (ms) updated_at | string | custom field update timestamp (ms) text_setting | text_setting | text field setting (currently text_setting has no settable items) ### Response body example ```json { "code": 0, "msg": "Success", "data": { "custom_field": { "guid": "34d4b29f-3d58-4bc5-b752-6be80fb687c8", "name": "priority", "type": "number", "number_setting": { "format": "normal", "custom_symbol": "custom symbol character", "custom_symbol_position": "left", "separator": "thousand", "decimal_count": 2 }, "member_setting": { "multi": true }, "datetime_setting": { "format": "yyyy/mm/dd" }, "single_select_setting": { "options": [ { "guid": "4216f79b-3fda-4dc6-a0c4-a16022e47152", "name": "high", "color_index": 1, "is_hidden": false } ] }, "multi_select_setting": { "options": [ { "guid": "4216f79b-3fda-4dc6-a0c4-a16022e47152", "name": "high-quality", "color_index": 1, "is_hidden": false } ] }, "creator": { "id": "ou_ 2cefb2f014f8d0c6c2d2eb7bafb0e54f", "type": "user", "role": "creator", "name": "张明德（明德）" }, "created_at": "1688196600000", "updated_at": "1688196600000", "text_setting": {} } } } ``` ### Error code HTTP status code | Error code | Description | Troubleshooting suggestions ---|---|---|--- 400 | 1470400 | The request parameter is incorrect, such as the input custom_field_guid is not valid. | Check the returned msg to determine the specific error reasons. 403 | 1470403 | Missing permission to read custom field. | Confirm that the calling identity has permission to read custom fields. 404 | 1470404 | The custom field to view does not exist. | Verify that the custom field you want to view exists. 500 | 1470500 | Server error. | Try retrying the call. If it continues to fail, please contact support for feedback.