Supporter Wall REST API

REST endpoints for the Supporter Wall feature.

When to use this instead of the shortcode. [benecaster_supporter_wall] is the right tool for a wall on a WordPress page, and the benecaster_supporter_wall_output filter covers most cases where you want to change how it looks. Reach for this endpoint when the wall has to render somewhere the shortcode cannot run — a headless front end, a React or Vue component, a mobile app, or another site entirely. It is public and unauthenticated, so it works from any origin without a nonce.

---

GET /benecaster/v1/shows/{id}/supporter-wall

Returns the list of opted-in subscribers for a show’s Supporter Wall. This endpoint is public — no authentication required.

Auth: None (permission_callback => '__return_true').

Path parameter:

Query parameters:

Response — wall enabled, subscribers opted in (200):

{
  "items": [
    {
      "user_id": 42,
      "display_name": "Jane Smith",
      "avatar_url": "https://yoursite.com/wp-content/uploads/benecaster/avatars/42.jpg",
      "badges": [
        {
          "label": "Gold Member",
          "color": "#F5A623",
          "icon_svg": "<svg …>…</svg>",
          "icon_attachment_url": null,
          "source": "tier_auto"
        }
      ],
      "joined_at": "2026-03-15T12:00:00Z",
      "message": "",
      "token_type": "subscriber"
    }
  ]
}

Response — wall enabled, no opted-in subscribers (200):

{
  "items": []
}

Response — wall disabled (404):

{
  "code": "rest_not_found",
  "message": "Supporter Wall is not enabled for this show.",
  "data": { "status": 404 }
}

Response fields:

Notes:

• The endpoint uses SupporterWallQuery internally — the result set is identical to what [benecaster_supporter_wall] renders. Query parameters (limit, tier, order) behave the same as the shortcode attributes.
• 404 vs empty 200: A 404 means the wall feature is disabled for the show. An empty items array with 200 means the wall is enabled but no subscribers have opted in. These are distinct states — don’t treat a 404 as “no supporters.”
• avatar_url is null (not a placeholder URL) when no avatar has been uploaded. Rendering code should handle null by displaying an initials-based fallback.

Example — headless React component:

const res  = await fetch( `/wp-json/benecaster/v1/shows/${showId}/supporter-wall` );
if ( res.status === 404 ) return null; // wall disabled
const { items } = await res.json();