Skip to main content
GET
Get a custom field value

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

id
string
required

CustomFieldValue identifier

Response

CustomFieldValue resource

Stored answers for tenant-defined custom fields. Each row links a CustomField definition to one of three possible owners: a user (user), a contact (contact), or an event attendance (eventAttend). Exactly one of these is set per row; the others are null. The value column holds the answer as a string (multi-option fields store a comma-separated list, file/image fields store the answer in media and leave value blank). All queries are tenant-isolated through field.tenant, which is guaranteed non-null. The endpoint exposes only the values whose custom field definition belongs to the current user's tenant. Custom field values attached to event attendances are typically read through /event_attends/{id} rather than this collection. Values can be created directly through POST on this resource (one value per request, with exactly one of user/contact/ eventAttend set), or as nested writes inside the owning entity (e.g. PATCH /users/{id} with a rawUserCustomFieldsValues map, PATCH /contacts/{id} with rawContactCustomFieldsValues). The direct POST route delegates to the same underlying service as the nested-write path, so encryption, file-media handling, and field-visibility checks behave identically.

id
integer
read-only
field
string<iri-reference>
Example:

"/api/v1/custom_fields/1"

user
string<iri-reference> | null
Example:

"/api/v1/users/1"

value
string
default:""
contact
string<iri-reference> | null
Example:

"/api/v1/contacts/1"

media
object | null
eventAttend
string<iri-reference> | null
Example:

"/api/v1/event_attends/1"