Custom Profile Field Value

List custom profile field values

GET

https://api.getcommunal.com/api

/custom_profile_field_values

Returns a paginated list of stored custom profile field values. Filter by user_id, family_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[family_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

https://api.getcommunal.com/api

/custom_profile_field_values

Stores a value for a custom profile field. POST requires exactly one of user_id or family_id. 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

StoreCustomProfileFieldValueRequest

custom_profile_field_id

integer · required

value

string | null

user_id

integer | null

family_id

integer | 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 +6 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

family_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

POST/custom_profile_field_values

curl https://api.getcommunal.com/api/custom_profile_field_values \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "value": "value",
  "user_id": 0,
  "family_id": 0,
  "custom_profile_field_id": 0
}'

Example Request Body

{
  "value": "value",
  "user_id": 0,
  "family_id": 0,
  "custom_profile_field_id": 0
}

json

Example Responses

{
  "id": 0,
  "tenant_id": 0,
  "value": "value",
  "user_id": 0,
  "family_id": 42,
  "custom_profile_field_id": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "deleted_at": "2024-08-25T15:00:00Z",
  "custom_profile_field": "custom_profile_field"
}

json

application/json

Update custom profile field value

PUT

https://api.getcommunal.com/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

StoreCustomProfileFieldValueRequest

custom_profile_field_id

integer · required

value

string | null

user_id

integer | null

family_id

integer | 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 +6 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

family_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

PUT/custom_profile_field_values/{id}

curl https://api.getcommunal.com/api/custom_profile_field_values/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "value": "value",
  "user_id": 0,
  "family_id": 0,
  "custom_profile_field_id": 0
}'

Example Request Body

{
  "value": "value",
  "user_id": 0,
  "family_id": 0,
  "custom_profile_field_id": 0
}

json

Example Responses

{
  "id": 0,
  "tenant_id": 0,
  "value": "value",
  "user_id": 0,
  "family_id": 42,
  "custom_profile_field_id": 0,
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z",
  "deleted_at": "2024-08-25T15:00:00Z",
  "custom_profile_field": "custom_profile_field"
}

json

application/json

Custom Profile Field

List custom profile field values

GET

https://api.getcommunal.com/api

/custom_profile_field_values

Returns a paginated list of stored custom profile field values. Filter by user_id, family_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[family_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

https://api.getcommunal.com/api

/custom_profile_field_values

Stores a value for a custom profile field. POST requires exactly one of user_id or family_id. 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

StoreCustomProfileFieldValueRequest

custom_profile_field_id

integer · required

value

string | null

user_id

integer | null

family_id

integer | 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 +6 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

family_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

https://api.getcommunal.com/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

StoreCustomProfileFieldValueRequest

custom_profile_field_id

integer · required

value

string | null

user_id

integer | null

family_id

integer | 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 +6 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

family_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