Contents
On this page

Get Custom Field - Plugixa Team

GET /plugixateam/v1/custom-fields/{id}

Read one custom field definition.

Needs Plugixa Team Pro. Needs a signed-in WordPress user with the plugixa_team_edit capability, which administrators and editors get when the plugin is activated, or manage_options.

Request

GET https://your-site.example/wp-json/plugixateam/v1/custom-fields/4

Path parameters

Name Type Description
id integer The field’s id

Responses

200 OK. data is the field definition.

{
  "success": true,
  "message": "",
  "data": {
    "id": "4",
    "field_key": "pronouns",
    "field_label": "Pronouns",
    "field_type": "select",
    "field_options": [
      "she/her",
      "he/him",
      "they/them"
    ],
    "placeholder": "",
    "is_required": false,
    "show_in_frontend": true,
    "show_in_form": true,
    "menu_order": "0",
    "language_code": null,
    "translation_group": null,
    "created_at": "2026-11-12 09:30:00",
    "modified_at": "2026-11-12 09:30:00",
    "value_count": "12"
  }
}
Field Type Meaning
data.id string The field’s id, as a numeric string
data.field_key string The key member values are stored under, in a member’s meta
data.field_label string The label shown to people
data.field_type string text, textarea, url, number, date, select, checkbox, color, file, email or phone
data.field_options array|null The choices of a select or checkbox field
data.placeholder string|null Placeholder text
data.is_required boolean Required on the submission form
data.show_in_frontend boolean Shown on the site
data.show_in_form boolean Offered on the submission form
data.menu_order string Position among the fields
data.value_count string How many members have a value stored for this key
data.language_code, data.translation_group string|null Set when WPML or Polylang is active
data.created_at, data.modified_at string Site-time datetimes

Errors

Status Code When
404 rest_error No field with that id.
404 rest_no_route The site runs the free build.

Plus the errors every endpoint can return.

Examples

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

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

Quick Links

Share