List 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.

Query Parameters
  • filter[user_id]
    Type: integer | null

    Integer numbers.

  • filter[custom_profile_field_id]
    Type: integer | null

    Integer numbers.

Headers
  • X-Api-Version
    Type: string

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

Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/custom_profile_field_values
curl 'https://api.getcommunal.com/api/custom_profile_field_values?filter[user_id]=null&filter[custom_profile_field_id]=null' \
  --header 'X-Api-Version: 2026-03-25' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": 1,
      "tenant_id": null,
      "value": "string",
      "user_id": null,
      "custom_profile_field_id": 1,
      "created_at": null,
      "updated_at": null,
      "deleted_at": null,
      "custom_profile_field": "string"
    }
  ],
  "current_page": 1,
  "from": null,
  "last_page": 1,
  "per_page": 1,
  "to": null,
  "total": 0
}

Paginated set of CustomProfileFieldValueResource