List Views - Plugixa FAQ for WordPress

List Views - Plugixa FAQ

GET /plugixa-faq/v1/views

List saved views: named designs (layout, colours, typography, behaviour) that shortcodes and blocks can use.

Any signed-in user with the plugixa_faq_manage capability or WordPress’s edit_posts (Contributors and up, by default).

Request

GET https://your-site.example/wp-json/plugixa-faq/v1/views?search=support

Query parameters

Name	Type	Description
`search`	`string`	Text found in the name, slug or description. Same as `filter[search]`.
`filter[layout_types][]`	`string[]`	Views whose `config.layout.style` is one of these.
`filter[is_default]`	`string`	`yes` for the default view, any other value for the rest.

Plus the list parameters every paged list accepts. orderby accepts id, name, slug, is_default, created_at and modified_at.

Responses

`200` OK. `data.items` is one page of views.

{
  "success": true,
  "message": "",
  "data": {
    "items": [
      {
        "id": "2",
        "name": "Support centre",
        "slug": "support-centre",
        "description": "Accordion for the help pages.",
        "config": {
          "layout": {
            "style": "accordion",
            "columns": 1,
            "groupByCategory": false
          },
          "behavior": {
            "openFirst": false,
            "allowMultiple": true,
            "animationSpeed": 300
          },
          "icon": {
            "style": "chevron",
            "position": "right"
          },
          "colors": {
            "questionText": "#1d2327",
            "questionBg": "#f0f0f1",
            "answerText": "#1d2327",
            "answerBg": "#ffffff",
            "borderColor": "#c3c4c7",
            "accentColor": "#2271b1"
          },
          "typography": {
            "questionFontSize": 16,
            "questionFontWeight": 600,
            "answerFontSize": 14,
            "answerFontWeight": 400
          },
          "spacing": {
            "padding": 15,
            "margin": 10,
            "gap": 8
          },
          "borders": {
            "radius": 4,
            "width": 1
          },
          "shadows": {
            "enabled": false,
            "value": "0 2px 4px rgba(0,0,0,0.1)"
          },
          "feedback": {
            "enabled": false
          }
        },
        "is_default": "0",
        "created_at": "2026-11-12 09:30:00",
        "created_by": "1",
        "modified_at": null,
        "modified_by": null
      }
    ],
    "total": 1,
    "state": {
      "filter": {
        "search": "support"
      },
      "limit": 20,
      "offset": 0,
      "orderby": "created_at",
      "order": "DESC"
    }
  }
}

Field	Type	Meaning
`data.items[].slug`	`string`	What a shortcode or block refers to
`data.items[].config`	`object`	The design settings
`data.items[].is_default`	`string`	`"1"` for the default view
`data.total`	`integer`	Views matching the filters, before paging

See Views and the View editor.

Errors

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-faq/v1/views?search=support" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$query = http_build_query([
    'search' => 'support',
]);
$ch = curl_init('https://your-site.example/wp-json/plugixa-faq/v1/views?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_USERPWD        => 'admin:' . getenv('WP_APP_PASSWORD'),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const query = new URLSearchParams({ search: 'support' });
const response = await fetch(`https://your-site.example/wp-json/plugixa-faq/v1/views?${query}`, {
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data } = await response.json();