API ReferencePlatform API

Api Admin Staff Groups Retrieve

GET / PATCH / DELETE /api/admin/staff-groups/<name>/

DELETE soft-disables the group (sets revoked_at + actor email). All members lose authority atomically per the resolver’s group- revoked check.

Authentication

AuthorizationBearer
JWT access token or Respan API key

Path parameters

namestringRequired

Response

idstringRead-only
namestringformat: "^[A-Za-z0-9_-]+$"<=100 characters
granted_byinteger or nullRead-only
granted_atdatetimeRead-only
revoked_atdatetime or nullRead-only
revoked_by_emailstring or nullRead-only
member_countintegerRead-only

Active (non-revoked) members of this group. Tiny — staff roster is bounded, so the COUNT runs without a separate query when the queryset annotates it; otherwise it’s a cheap COUNT.

descriptionstring<=500 characters
permissions_overridelist of strings