Developers
Users38

List user custom field values

GET/users/{user_id}/custom-fields

Returns the user's custom field values, keyed by custom field public ID. Values of deleted custom fields are not included.

If custom fields are not enabled for the account, the API returns feature_disabled.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

user_id*string

Public ID of the user, prefixed with usr_.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/users/string/custom-fields"
{  "data": {    "values": {}  }}

Delete a user avatar DELETE

Removes the user's avatar. The operation is idempotent: removing an avatar that is not set also succeeds.

Update user custom field values PUT

Sets custom field values for the user. Send a `values` object keyed by custom field public ID. Custom fields not included in the request keep their current values. Values are validated against the field type: `number` fields require a numeric value and `date` fields require the `YYYY-MM-DD` format. Invalid values return `validation_failed`, with the affected field identified in `details[].field`. If custom fields are not enabled for the account, the API returns `feature_disabled`.