Skip to content

Returns the FluentCRM tagging configuration together with every space and course that can be mapped, and the CRM tag list to map them onto.

Spaces are grouped by space group, with ungrouped ones under "Other Spaces" and all courses under a separate group. crm_tags is empty and has_fluentcrm is false when FluentCRM is not installed.

Endpoint

  • Method: GET

  • Path: /settings/crm-tagging-config

  • Edition: Core

  • Controller: SettingController@getCrmTaggingConfig

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

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

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

  • Reading is available in core, but saving the configuration is a Pro endpoint.

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 CRM Tagging Config

GET
/settings/crm-tagging-config

Returns the FluentCRM tagging configuration together with every space and course that can be mapped, and the CRM tag list to map them onto.

Controller: SettingController@getCrmTaggingConfig
Route source: fluent-community/app/Http/Routes/api.php:165

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Responses

Successful response

application/json
JSON
{
  
"crm_tags": [
  
  
{
  
  
  
"id": 0,
  
  
  
"title": "string"
  
  
}
  
],
  
"has_fluentcrm": true,
  
"settings": {
  
  
"create_crm_contact": "string",
  
  
"create_user": "string",
  
  
"has_course_sync": "string",
  
  
"has_course_tagging": "string",
  
  
"has_space_sync": "string",
  
  
"has_space_tagging": "string",
  
  
"is_enabled": "string",
  
  
"linked_maps": {
  
  
  
"8": 0
  
  
},
  
  
"send_welcome_email": "string",
  
  
"tagging_maps": {
  
  
  
"8": 0
  
  
}
  
},
  
"spaceGroups": [
  
  
{
  
  
  
"id": 0,
  
  
  
"spaces": [
  
  
  
  
{
  
  
  
  
  
"icon": "string",
  
  
  
  
  
"id": 0,
  
  
  
  
  
"privacy": "string",
  
  
  
  
  
"slug": "string",
  
  
  
  
  
"title": "string",
  
  
  
  
  
"type": "string"
  
  
  
  
}
  
  
  
],
  
  
  
"title": "string"
  
  
}
  
]
}

Playground

Authorization

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation