Custom Profile Field Value

Server

List custom profile field values

GET

http://api.community-management.test/api

/custom_profile_field_values

Returns a paginated list of stored custom profile field values. Filter by user_id or custom_profile_field_id, and use ?include=customProfileField to embed the parent field.

List custom profile field values › query Parameters

filter[user_id]

integer | null

filter[custom_profile_field_id]

integer | null

List custom profile field values › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

List custom profile field values › Responses

Paginated set of CustomProfileFieldValueResource

CustomProfileFieldValueResource[] · required

current_page

integer · min: 1 · required

from

integer | null · min: 1 · required

last_page

integer · min: 1 · required

per_page

integer · min: 1 · required

to

integer | null · min: 1 · required

total

integer · min: 0 · required

Create custom profile field value

POST

http://api.community-management.test/api

/custom_profile_field_values

Stores a value for a custom profile field. Empty values are ignored, and values cannot be modified from a parent tenant.

Create custom profile field value › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

Create custom profile field value › Request Body

user_id

integer · required

custom_profile_field_id

integer · required

value

string | null

Create custom profile field value › Responses

CustomProfileFieldValueResource

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, tenant_id, value +5 more
	type = object · requires: message

Properties for CustomProfileFieldValueResource:

CustomProfileFieldValueResource

id

integer · required

tenant_id

integer | null · required

value

string · required

user_id

integer | null · required

custom_profile_field_id

integer · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

custom_profile_field

string

Update custom profile field value

PUT

http://api.community-management.test/api

/custom_profile_field_values/{id}

Updates a stored custom profile field value by id. Submitting an empty value clears (deletes) the record.

Update custom profile field value › path Parameters

id

string · required

Update custom profile field value › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

Update custom profile field value › Request Body

user_id

integer · required

custom_profile_field_id

integer · required

value

string | null

Update custom profile field value › Responses

CustomProfileFieldValueResource

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, tenant_id, value +5 more
	type = object · requires: message

Properties for CustomProfileFieldValueResource:

CustomProfileFieldValueResource

id

integer · required

tenant_id

integer | null · required

value

string · required

user_id

integer | null · required

custom_profile_field_id

integer · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

custom_profile_field

string

Custom Profile Field

List custom profile field values

GET

http://api.community-management.test/api

/custom_profile_field_values

Returns a paginated list of stored custom profile field values. Filter by user_id or custom_profile_field_id, and use ?include=customProfileField to embed the parent field.

List custom profile field values › query Parameters

filter[user_id]

integer | null

filter[custom_profile_field_id]

integer | null

List custom profile field values › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

List custom profile field values › Responses

Paginated set of CustomProfileFieldValueResource

CustomProfileFieldValueResource[] · required

current_page

integer · min: 1 · required

from

integer | null · min: 1 · required

last_page

integer · min: 1 · required

per_page

integer · min: 1 · required

to

integer | null · min: 1 · required

total

integer · min: 0 · required

Create custom profile field value

POST

http://api.community-management.test/api

/custom_profile_field_values

Stores a value for a custom profile field. Empty values are ignored, and values cannot be modified from a parent tenant.

Create custom profile field value › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

Create custom profile field value › Request Body

user_id

integer · required

custom_profile_field_id

integer · required

value

string | null

Create custom profile field value › Responses

CustomProfileFieldValueResource

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, tenant_id, value +5 more
	type = object · requires: message

Properties for CustomProfileFieldValueResource:

CustomProfileFieldValueResource

id

integer · required

tenant_id

integer | null · required

value

string · required

user_id

integer | null · required

custom_profile_field_id

integer · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

custom_profile_field

string

Update custom profile field value

PUT

http://api.community-management.test/api

/custom_profile_field_values/{id}

Updates a stored custom profile field value by id. Submitting an empty value clears (deletes) the record.

Update custom profile field value › path Parameters

id

string · required

Update custom profile field value › Headers

X-Api-Version

string

Optional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.

Update custom profile field value › Request Body

user_id

integer · required

custom_profile_field_id

integer · required

value

string | null

Update custom profile field value › Responses

CustomProfileFieldValueResource

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, tenant_id, value +5 more
	type = object · requires: message

Properties for CustomProfileFieldValueResource:

CustomProfileFieldValueResource

id

integer · required

tenant_id

integer | null · required

value

string · required

user_id

integer | null · required

custom_profile_field_id

integer · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

custom_profile_field

string