Contents
On this page

Get Group - Plugixa Team

GET /plugixateam/v1/groups/{id}

Read one group, with its member count.

Needs the plugixa_team_edit capability, or any user who can write posts (edit_posts): the Team block offers groups as a choice in the post editor.

Request

GET https://your-site.example/wp-json/plugixateam/v1/groups/3

Path parameters

Name Type Description
id integer The group’s id

Responses

200 OK. data is the group.

{
  "success": true,
  "message": "",
  "data": {
    "id": "3",
    "name": "Leadership",
    "slug": "leadership",
    "description": "The people who set direction.",
    "display_order": "0",
    "language_code": null,
    "translation_group": null,
    "created_at": "2026-11-12 09:30:00",
    "modified_at": null,
    "member_count": "4"
  }
}
Field Type Meaning
data.id string The group’s id, as a numeric string
data.name string The name
data.slug string Unique URL name, used by the shortcode and block group filters
data.description string|null Plain text
data.display_order string Position among the groups
data.member_count string Members in the group, whatever their status
data.language_code, data.translation_group string|null Set when WPML or Polylang is active
data.created_at, data.modified_at string|null Site-time datetimes

The group’s members are not included: list them with filter[groups][]=3 in List Members.

Errors

Status Code When
404 rest_error No group with that id.

Plus the errors every endpoint can return.

Examples

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

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixateam/v1/groups/3');
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/groups/3', {
  headers: {
    'Authorization': `Basic ${auth}`,
  },
});
const { data } = await response.json();

Quick Links

Share