Returns the custom profile field configuration — the field groups, the field definitions and whether the feature is switched on.

Endpoint

• Method: GET

• Path: /admin/custom-profile-fields

• Edition: PRO

• Controller: ProAdminController@getCustomProfileFields

• Route source: fluent-community-pro/app/Http/Routes/api.php:24

• Controller source: fluent-community-pro/app/Http/Controllers/ProAdminController.php

• Requires the FluentCommunity community-admin permission (or a WordPress super admin).

• Requires FluentCommunity Pro.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

GET Get Custom Profile Fields

GET

/admin/custom-profile-fields

Returns the custom profile field configuration — the field groups, the field definitions and whether the feature is switched on.

Controller: ProAdminController@getCustomProfileFields
Route source: fluent-community-pro/app/Http/Routes/api.php:24

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type

API Key (header: Authorization)

Responses

Successful response

Content-Type

application/json

{

  

"config": {

  

  

"fields": [

  

  

  

{

  

  

  

  

"additionalProperties": "string"

  

  

  

}

  

  

],

  

  

"groups": [

  

  

  

{

  

  

  

  

"edit_description": "string",

  

  

  

  

"is_system": true,

  

  

  

  

"label": "string",

  

  

  

  

"slug": "string"

  

  

  

}

  

  

],

  

  

"is_enabled": "string"

  

}

}

GET

/admin/custom-profile-fields

Playground

Authorization

ApplicationPasswords

Samples

Powered by VitePress OpenAPI