Custom Profile Field

Server

List custom profile fields

GET

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

/custom_profile_fields

Returns a paginated list of the tenant's custom profile fields. Use ?include=values to embed each field's stored values.

List custom profile fields › query Parameters

cross_tenant_user_id

integer | null

cross_tenant_values

boolean | null

List custom profile fields › 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 fields › Responses

Paginated set of CustomProfileFieldResource

CustomProfileFieldResource[] · 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

GET/custom_profile_fields

curl http://api.community-management.test/api/custom_profile_fields \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 0,
      "tenant_id": 0,
      "name": "name",
      "display_on_membership_card": true,
      "user_editable": true,
      "locked": true,
      "parent_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",
      "values": [
        {
          "id": 0,
          "tenant_id": 0,
          "value": "value",
          "user_id": 0,
          "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"
        }
      ]
    }
  ],
  "current_page": 1,
  "from": 1,
  "last_page": 1,
  "per_page": 1,
  "to": 1,
  "total": 0
}

json

application/json

Create custom profile field

POST

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

/custom_profile_fields

Creates a new custom profile field for the tenant. Set for_child_tenants to also propagate the field to child tenants.

Create custom profile field › 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 › Request Body

name

string · required

display_on_membership_card

boolean | null

for_child_tenants

boolean | null

user_editable

boolean | null

Create custom profile field › Responses

CustomProfileFieldResource

CustomProfileFieldResource

id

integer · required

tenant_id

integer | null · required

name

string · required

display_on_membership_card

boolean · required

user_editable

boolean · required

locked

boolean · required

parent_profile_field_id

integer | null · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

CustomProfileFieldValueResource[]

POST/custom_profile_fields

curl http://api.community-management.test/api/custom_profile_fields \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "display_on_membership_card": true,
  "for_child_tenants": true,
  "user_editable": true
}'

Example Request Body

{
  "name": "name",
  "display_on_membership_card": true,
  "for_child_tenants": true,
  "user_editable": true
}

json

Example Responses

{
  "id": 0,
  "tenant_id": 0,
  "name": "name",
  "display_on_membership_card": true,
  "user_editable": true,
  "locked": true,
  "parent_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",
  "values": [
    {
      "id": 0,
      "tenant_id": 0,
      "value": "value",
      "user_id": 0,
      "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

PUT

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

/custom_profile_fields/{id}

Updates an existing custom profile field by id. Set for_child_tenants to also propagate the change to child tenants.

Update custom profile field › path Parameters

id

string · required

Update custom profile field › 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 › Request Body

name

string · required

display_on_membership_card

boolean | null

for_child_tenants

boolean | null

user_editable

boolean | null

Update custom profile field › Responses

CustomProfileFieldResource

CustomProfileFieldResource

id

integer · required

tenant_id

integer | null · required

name

string · required

display_on_membership_card

boolean · required

user_editable

boolean · required

locked

boolean · required

parent_profile_field_id

integer | null · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

CustomProfileFieldValueResource[]

PUT/custom_profile_fields/{id}

curl http://api.community-management.test/api/custom_profile_fields/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "display_on_membership_card": true,
  "for_child_tenants": true,
  "user_editable": true
}'

Example Request Body

{
  "name": "name",
  "display_on_membership_card": true,
  "for_child_tenants": true,
  "user_editable": true
}

json

Example Responses

{
  "id": 0,
  "tenant_id": 0,
  "name": "name",
  "display_on_membership_card": true,
  "user_editable": true,
  "locked": true,
  "parent_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",
  "values": [
    {
      "id": 0,
      "tenant_id": 0,
      "value": "value",
      "user_id": 0,
      "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

User Custom Profile Field Value

List custom profile fields

GET

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

/custom_profile_fields

Returns a paginated list of the tenant's custom profile fields. Use ?include=values to embed each field's stored values.

List custom profile fields › query Parameters

cross_tenant_user_id

integer | null

cross_tenant_values

boolean | null

List custom profile fields › 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 fields › Responses

Paginated set of CustomProfileFieldResource

CustomProfileFieldResource[] · 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

POST

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

/custom_profile_fields

Creates a new custom profile field for the tenant. Set for_child_tenants to also propagate the field to child tenants.

Create custom profile field › 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 › Request Body

name

string · required

display_on_membership_card

boolean | null

for_child_tenants

boolean | null

user_editable

boolean | null

Create custom profile field › Responses

CustomProfileFieldResource

CustomProfileFieldResource

id

integer · required

tenant_id

integer | null · required

name

string · required

display_on_membership_card

boolean · required

user_editable

boolean · required

locked

boolean · required

parent_profile_field_id

integer | null · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

CustomProfileFieldValueResource[]

Update custom profile field

PUT

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

/custom_profile_fields/{id}

Updates an existing custom profile field by id. Set for_child_tenants to also propagate the change to child tenants.

Update custom profile field › path Parameters

id

string · required

Update custom profile field › 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 › Request Body

name

string · required

display_on_membership_card

boolean | null

for_child_tenants

boolean | null

user_editable

boolean | null

Update custom profile field › Responses

CustomProfileFieldResource

CustomProfileFieldResource

id

integer · required

tenant_id

integer | null · required

name

string · required

display_on_membership_card

boolean · required

user_editable

boolean · required

locked

boolean · required

parent_profile_field_id

integer | null · required

created_at

string | null · date-time · required

updated_at

string | null · date-time · required

deleted_at

string | null · date-time · required

CustomProfileFieldValueResource[]