Appearance
Pages & Onboarding API
Two small groups: pages (a page/post search used by admin pickers) and onboarding (the first-run setup wizard).
Base URL: https://your-site.com/wp-json/wpsocialreviews/v2
Pages
Policy: PagesPolicy · Handler: PagesController
Search Pages
GET/pages/searchPaginated page/post search for pickers (e.g. selecting a display location).
Handler: @search
| Parameter | Type | Location | Required | Description |
|---|---|---|---|---|
search | string | query | No | Search text |
page | integer | query | No | Page number (default 1) |
per_page | integer | query | No | Items per page (default 20) |
include_ids | array | query | No | Always include these IDs |
post_type | string | query | No | Restrict to a post type |
Returns the paginated result from Helper::searchPagesList.
Onboarding
Policy: AdminPolicy · Handler: OnboardingController
| Method | Endpoint | Handler | Inputs | Response |
|---|---|---|---|---|
| GET | /onboarding | @index | — | { "status", "data" } (platforms/templates/post types) |
| POST | /onboarding | @create | see below | { "status", "message" } |
| POST | /onboarding/skip | @skip | — | { "status", "message" } |
| GET | /onboarding/config | @getConfig | — | { "status", "data": { steps[], platform_config, settings } } |
Complete onboarding — POST /onboarding
| Parameter | Type | Required | Description |
|---|---|---|---|
platform_types | string/array | Yes | Which platform families are being set up |
platform_name | string | Yes | The chosen platform |
template | object | Yes | { name, type } |
review_platforms / feed_platforms / chat_platforms | array | No | Selected platforms |
post_type, template_id | mixed | No | Target display |
subscribe_to_newsletter, share_data | bool | No | Opt-ins |