List Custom Fields - Plugixa FAQ for WordPress

List Custom Fields - Plugixa FAQ

GET /plugixa-faq/v1/custom-fields

List every custom field definition, in manual order.

Any signed-in user with the plugixa_faq_manage capability or WordPress’s edit_posts (Contributors and up, by default). Needs Plugixa FAQ Pro: the free build does not register this route, so it answers 404 there.

Note. This list is not paged: every field comes back, and limit, offset, orderby and order have no effect (they are still validated).

Request

GET https://your-site.example/wp-json/plugixa-faq/v1/custom-fields

Query parameters

Name	Type	Default	Description
`filter[language]`	`string`		One language code. Only with WPML or Polylang active.
`group_by_translation`	`boolean`	`false`	With WPML or Polylang active: default-language fields only.

Responses

`200` OK. `data.items` is every field.

{
  "success": true,
  "message": "",
  "data": {
    "items": [
      {
        "id": "5",
        "field_key": "warranty",
        "field_label": "Warranty",
        "field_type": "text",
        "field_options": null,
        "placeholder": "e.g. 2 years",
        "is_required": false,
        "show_in_frontend": true,
        "menu_order": "1",
        "created_at": "2026-11-12 09:30:00",
        "created_by": null,
        "modified_at": "2026-11-12 09:30:00",
        "modified_by": null,
        "language_code": null,
        "translation_group": null
      }
    ],
    "total": 1
  }
}

Field	Type	Meaning
`data.items[].field_key`	`string`	The key FAQ values are stored under
`data.items[].field_type`	`string`	One of the eight types
`data.items[].field_options`	`array\|null`	Choices of a `select` field
`data.items[].is_required`	`boolean`	Real boolean
`data.items[].show_in_frontend`	`boolean`	Real boolean
`data.items[].translations`	`array`	Only with WPML or Polylang active
`data.total`	`integer`	Number of fields

Values are set per FAQ through custom_fields on Create FAQ and Update FAQ. See Custom fields.

Errors

Plus the errors every endpoint can return.

Examples

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

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