Actions168
- Bot Actions
- Call & Meeting Actions
- Channel Actions
- Add Bot to Channel
- Add Channel Members
- Approve Channel
- Archive Channel
- Change Channel Member Role
- Change Channel Permission
- Create Channel
- Delete Channel
- Get Channel
- Get Channel Members
- Join Channel
- Leave Channel
- List Channels
- Reject Channel
- Remove Bot From Channel
- Remove Channel Members
- Remove Single Channel Member
- Unarchive Channel
- Update Channel
- Chat Actions
- Cliq Database Actions
- Custom Domain Actions
- Custom Email Actions
- Department Actions
- Designation Actions
- Event Actions
- File Actions
- Maintenance (Bulk Export) Actions
- Message Actions
- Message Component Builder Actions
- OAuth Helper Actions
- Reaction Actions
- Reminder Actions
- Remote Work Actions
- Role Actions
- Team Actions
- Thread Actions
- User Actions
- User Field Actions
- User Status Actions
- Widget Map Ticker Actions
User Field → Retrieve a Particular User Field
AI-generatedSummary
Retrieve a user field schema definition from Zoho Cliq by specifying its unique field ID, returning either a simplified or raw representation of the field metadata.
Inputs
- fieldId (required) — The user-field schema definition ID (field metadata/configuration ID) to retrieve. Not a user ID; must be a valid field definition identifier.
- enableAiErrorMode — Optionally enable AI error mode to return errors as output items instead of stopping execution, useful for workflows involving AI tools.
- simplify — Choose whether to simplify the response data for easier consumption in workflows.
- simplifyMode — Specify the mode of simplification: full simplified, raw, or selected specific fields.
- simplifyFields — Select which fields to include when using the 'selectedFields' simplify mode, always including the record ID.
Output shape
a single user-field schema definition object
The output contains metadata/configuration of the user field for the specified field ID. If simplification is enabled, the response is unwrapped and fields filtered according to simplify mode settings. Errors may be returned as output items if AI error mode is enabled. Requires scope ZohoCliq.Users.READ.
Examples
Example 1: Retrieve metadata of a user field by field ID with simplified output including only the ID and name.
Set 'fieldId' to the desired user field identifier, enable 'simplify', set 'simplifyMode' to 'selectedFields', and choose 'ID' and 'Name' for 'simplifyFields'.