User Field Values

List of valid attributes:

Attribute	Description	Specifics
field_id	Related field	Cannot be set
discarded_at	Null or timestamp of removal	Cannot be set
value	Actual value of the record	See table below. Omitted for sensitive fields on list unless revealed (see List).

Value-Restrictions for attribute “value”:

Depending on the related field’s field_type, there are different restrictions in place if not empty (value can always be empty to clear the field):

Field-Type	Specifics
text	String
textarea	String
email	Valid email
number	Number (only allows integers)
decimal	Number
tel	String in format +49 123 456789
date	String in format yyyy-MM-dd
city	String
country	String
singleselect	Array of strings with length 1
multiselect	Array of strings with length n
checkbox	Boolean
url	Valid url

Update

Example request:

{
  "data": {
    "type": "user",
    "attributes": {
      "field_values": [
        {
          "field_id": "d1866ffe-542f-48db-9730-786c7a894a5e",
          "value": "value"
        }
      ]
    }
  }
}

Example response:

{
  "data": [
    {
      "id": "c3e385f3-7699-4cd3-a458-e101d0f289d7",
      "type": "field_value",
      "attributes": {
        ...
      }
    }
  ]
}

This endpoint updates a list of the user’s field values.

HTTP Request

PATCH /api/v1/users/:user_id/field_values

URL Parameters

Parameter	Description
user_id	The ID of the user’s field values to update

List

This endpoint returns JSON structured like this:

{
  "data": [
    {
      "id": "c3e385f3-7699-4cd3-a458-e101d0f289d7",
      "type": "field_value",
      "attributes": {
        ...
      }
    },
    {
      ...
    }
  ]
}

This endpoint returns all field_values associated with a user.

For fields marked as sensitive, the value attribute is omitted by default. Pass reveal_sensitive=true to include sensitive values. This requires the Field Values (Sensitive) read right; without it, sensitive field values are excluded from the response entirely.

HTTP Request

GET /api/v1/users/:user_id/field_values

URL Parameters

Parameter	Description
user_id	The ID of the user from which to return field_values

Query Parameters

Parameter	Description
reveal_sensitive	When true, includes value for sensitive fields. Optional, defaults to false.

Example: GET /api/v1/users/:user_id/field_values?reveal_sensitive=true