---
title: "List user fields"
method: POST
path: "/users/v1/fields/list"
tags: ["Users"]
---

# List user fields

`POST /users/v1/fields/list`

## Request body

- S12UsersUserfieldV1ListFieldsRequest
  - `filter` S12UsersUserfieldV1ListFieldsRequestFieldsFilter
    - `field_category` 'FIELD_CATEGORY_UNSPECIFIED' | 'FIELD_CATEGORY_SYSTEM_FIELD' | 'FIELD_CATEGORY_CUSTOM_FIELD' — - FIELD_CATEGORY_UNSPECIFIED: Field category Unspecified. - FIELD_CATEGORY_SYSTEM_FIELD: Field category pre-defined. - FIELD_CATEGORY_CUSTOM_FIELD: Field category custom.
    - `data_types` S12TypefieldV1FieldValueType[] — Data type for the attributes. Providing an empty data_types list will result in all data types being returned.
    - `status` 'FIELD_STATUS_UNSPECIFIED' | 'FIELD_STATUS_ENABLED' | 'FIELD_STATUS_DISABLED'
    - `query` string — The attribute name to filter by

## Response `200`

A successful response.

- S12UsersUserfieldV1ListFieldsResponse
  - `fields` S12UsersUserfieldV1Field[] — List of user fields that satisfy the filter condition sorted by System Fields, Custom Fields
    - `id` string — Required. The field UUID
    - `data_type` 'FIELD_VALUE_TYPE_UNSPECIFIED' | 'FIELD_VALUE_TYPE_STRING' | 'FIELD_VALUE_TYPE_MONEY' | 'FIELD_VALUE_TYPE_TIMESTAMP' | 'FIELD_VALUE_TYPE_USER_ID' | 'FIELD_VALUE_TYPE_SELECT' | 'FIELD_VALUE_TYPE_TEMPLATE_ID' | 'FIELD_VALUE_TYPE_MULTI_SELECT' | 'FIELD_VALUE_TYPE_SITE' | 'FIELD_VALUE_TYPE_MULTI_SITE' | 'FIELD_VALUE_TYPE_INTEGER' | 'FIELD_VALUE_TYPE_ADDRESS' | 'FIELD_VALUE_TYPE_TIMEZONE' | 'FIELD_VALUE_TYPE_CONTACT_DETAILS' — Type of FieldValue. Defaults to type String. - FIELD_VALUE_TYPE_UNSPECIFIED: Field value type unspecified. - FIELD_VALUE_TYPE_STRING: Field value type string. - FIELD_VALUE_TYPE_MONEY: Field value type money. - FIELD_VALUE_TYPE_TIMESTAMP: Field value type timestamp. - FIELD_VALUE_TYPE_USER_ID: Field value type user ID. - FIELD_VALUE_TYPE_SELECT: Field value type select - FIELD_VALUE_TYPE_TEMPLATE_ID: Field value type template ID. - FIELD_VALUE_TYPE_MULTI_SELECT: Field value type multi-select - FIELD_VALUE_TYPE_SITE: Field value type site - FIELD_VALUE_TYPE_MULTI_SITE: Field value type multi-site - FIELD_VALUE_TYPE_INTEGER: Field value type integer - FIELD_VALUE_TYPE_ADDRESS: Field value type address. - FIELD_VALUE_TYPE_TIMEZONE: Field value type timezone - FIELD_VALUE_TYPE_CONTACT_DETAILS: Field value type contact details
    - `name` string — Required. The attribute name
    - `description` string — The attribute description
    - `has_attributes` boolean — Required. Flag to specify if the field has associated populated attributes
    - `status` 'FIELD_STATUS_UNSPECIFIED' | 'FIELD_STATUS_ENABLED' | 'FIELD_STATUS_DISABLED'
    - `settings` S12UsersUserfieldV1FieldSettings
      - `show_on_profile` boolean — Required. Flag to specify if the attribute is visible/configurable on the user profile
      - `allow_self_update` boolean — Required. Flag to specify if all users can update the attribute for their own account
      - `read_only` boolean — Read only. True when the field is system-managed and cannot be edited by users: allow_self_update is locked off and clients should render its toggle as disabled. Derived server-side from the set of read-only fields; ignored on write.
    - `category` 'FIELD_CATEGORY_UNSPECIFIED' | 'FIELD_CATEGORY_SYSTEM_FIELD' | 'FIELD_CATEGORY_CUSTOM_FIELD' — - FIELD_CATEGORY_UNSPECIFIED: Field category Unspecified. - FIELD_CATEGORY_SYSTEM_FIELD: Field category pre-defined. - FIELD_CATEGORY_CUSTOM_FIELD: Field category custom.
    - `select_options` S12TypefieldV1FieldOption[] — Field select options
      - `id` string — The id of a field select option.
      - `label` string — The label of a field select option.
      - `order` integer — The display order of this option, 0-indexed. Options should be displayed in ascending order of this field, matching the order they were defined in the field settings.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/safetyculture/apis/safetyculture-api.md) · [All operations](https://skmtc.net/safetyculture/apis/safetyculture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/safetyculture/safetyculture-api/revisions/5be91df61ded/schema)