Get Shortcode - Plugixa FAQ for WordPress

Get Shortcode - Plugixa FAQ

GET /plugixa-faq/v1/shortcodes/{id}

Read one saved shortcode with all its settings.

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/shortcodes/12

Path parameters

Name	Type	Description
`id`	`integer`	The shortcode’s id

Responses

`200` OK. `data` is the shortcode.

{
  "success": true,
  "message": "",
  "data": {
    "id": "12",
    "name": "Shipping FAQ",
    "slug": "shipping-faq",
    "description": "Shipping questions for the checkout page.",
    "config": {
      "view": "support-centre",
      "categories": [
        "shipping"
      ],
      "ids": [],
      "limit": -1,
      "pagination": "none",
      "perPage": 10,
      "orderby": "menu_order",
      "order": "ASC",
      "search": false,
      "searchPlaceholder": "",
      "groupByCategory": false,
      "schema": true,
      "darkMode": "from_view",
      "openFirst": false,
      "allowMultiple": true,
      "enablePermalinks": true,
      "permalinkText": "Permalink",
      "permalinkPosition": "answer-top-right",
      "enableSocialShare": false,
      "feedbackEnabled": false,
      "paginationEnabled": true,
      "paginationStyle": "numbers",
      "loadMoreLabel": "Load More",
      "enableToggleAll": false,
      "showReadMore": false,
      "readMoreText": "Read More",
      "showAuthor": true,
      "showDate": true,
      "showCategory": true
    },
    "created_at": "2026-11-12 09:30:00",
    "created_by": "1",
    "modified_at": null,
    "modified_by": null
  }
}

Field	Type	Meaning
`data.config.view`	`string`	Slug of the view to use, empty for the default view
`data.config.categories`	`string[]`	Category slugs to show, empty for all
`data.config.ids`	`array`	Specific FAQ ids, empty for all
`data.config.limit`	`integer`	`-1` for no limit
`data.config.paginationStyle`	`string`	`numbers`, `load_more` or `infinite_scroll`
`data.config.darkMode`	`string`	`from_view` follows the view

Settings saved by older versions under snake_case keys are returned under their camelCase name as well.

Errors

Status	Code	When
`404`	`rest_error`	No shortcode with that id.

Plus the errors every endpoint can return.

Examples

curl -s "https://your-site.example/wp-json/plugixa-faq/v1/shortcodes/12" \
  -u "admin:$WP_APP_PASSWORD"

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-faq/v1/shortcodes/12');
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 response = await fetch('https://your-site.example/wp-json/plugixa-faq/v1/shortcodes/12', {
  headers: {
    'Authorization': 'Basic ' + btoa(`admin:${process.env.WP_APP_PASSWORD}`),
  },
});
const { data } = await response.json();