Skip to content

Returns everything the migration wizard needs before it starts: the BuddyPress groups with their member counts and migrated state, the source data statistics, and any previously saved progress.

has_previous tells the client whether a partially completed run already exists, so it can offer to resume or reset.

Endpoint

  • Method: GET

  • Path: /migrations/buddypress/config

  • Edition: Core

  • Controller: BPMigrationController@getMigrationConfig

  • Route source: fluent-community/Modules/Migrations/Http/migration_api.php:14

  • Controller source: fluent-community/Modules/Migrations/Http/Controllers/BPMigrationController.php

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

Reconstructed sample

This endpoint belongs to a module that is not active on the reference install (or needs a file upload), so the payload below was reconstructed by reading the controller rather than recorded. Field names and types follow the source; values are illustrative.

GET Get Buddypress Migration Config

GET
/migrations/buddypress/config

Returns everything the migration wizard needs before it starts: the BuddyPress groups with their member counts and migrated state, the source data statistics, and any previously saved progress.

Controller: BPMigrationController@getMigrationConfig
Route source: fluent-community/Modules/Migrations/Http/migration_api.php:14

Authorizations

ApplicationPasswords

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

Type
API Key (header: Authorization)

Responses

Successful response

application/json
JSON
{
  
"groupItems": [
  
  
{
  
  
  
"id": "string",
  
  
  
"name": "string",
  
  
  
"members_count": 0,
  
  
  
"is_migrated": true
  
  
}
  
],
  
"featureConfig": {
  
  
"has_groups": true
  
},
  
"stats": {
  
  
"groups": 0,
  
  
"total_posts": 0,
  
  
"total_comments": 0,
  
  
"total_reactions": 0,
  
  
"total_community_users": 0
  
},
  
"current_status": {
  
  
"migrated_groups": {
  
  
  
"1": 0
  
  
},
  
  
"last_activity_id": 0,
  
  
"migrated_posts_count": 0,
  
  
"last_migrated_user_id": 0,
  
  
"last_migrated_member_id": 0,
  
  
"current_stage": "string"
  
},
  
"has_previous": true
}

Playground

Authorization

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation