list_user_fields
Read-onlyIdempotent
Retrieve custom user field definitions from Zendesk with id, type, key, title, and active status. Supports pagination, field selection, and filtering for targeted schema exploration.
Instructions
Returns user-level custom fields (the schema, not values) as paginated skeletons (id, type, key, title, active, updated_at). Default limit: 100; pass cursor, fields, filter, or verbose: true for dropdown options. Distinct from list_ticket_fields and list_organization_fields. For values on a specific user, fetch with get_user and read user_fields.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max items to return. Default 100. The full corpus is fetched and cached server-side; this only limits what the response carries. | |
| cursor | No | Opaque pagination token from a previous response. Slices the next page from the cached corpus. Stale cursors (older than the cache TTL) auto-reset to offset 0 and set cursor_invalidated: true. | |
| fields | No | Whitelist of field names. Overrides the default projection. Use to opt into extra fields (e.g. ["id","title","active","position","category_id","updated_at"]) without going fully verbose. | |
| filter | No | Structured filter applied to the cached corpus before slicing. Supported keys: active (bool), category_id (number/string), title_contains (string, case-insensitive), updated_since (ISO timestamp). Unsupported keys are ignored with a note in the response. | |
| refresh | No | Bypass cache and re-fetch from Zendesk | |
| verbose | No | Return full user-field objects instead of the thin projection | |
| instance | No | Override the sticky instance for this call |