Skip to main content
GET
/
api
/
public
/
perks
{
  "Groups": [
    "<string>"
  ],
  "Perks": [
    {}
  ],
  "Perks[].Id": 123,
  "Perks[].Title": "<string>",
  "Perks[].GroupName": "<string>",
  "Perks[].FullText": "<string>",
  "Perks[].SummaryText": "<string>"
}

​
List Perks

Returns all published perks available at the current location. Perks are grouped by their GroupName and include full-text descriptions suitable for rendering in a perks catalogue.
A perk is a benefit or discount offered by a partner business (restaurant, gym, etc.) to coworking members. Operators configure perks in the admin dashboard and members can claim them from the portal.

​
Authentication

Requires a valid customer bearer token.

​
Query Parameters

​
_shape
string
Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation.

​
Response

​
Core Fields

​
Groups
string[]
required
List of unique group names across all perks — use to build category tabs or filter UI.
​
Perks
Perk[]
required
Array of all published perks.
​
Perks[].Id
number
required
Unique identifier for the perk. Use as {perkId} in the claim endpoint.
​
Perks[].Title
string
required
Display title of the perk.
​
Perks[].GroupName
string
Category group this perk belongs to. Matches one of the values in the Groups array.
​
Perks[].FullText
string
required
Full description of the perk. May contain HTML.
​
Perks[].SummaryText
string
Short summary shown in perk cards.

​
Examples

​
Fetch all perks

GET /api/public/perks
Authorization: Bearer {token}

{
  "Groups": ["Food & Drink", "Fitness"],
  "Perks": [
    {
      "Id": 101,
      "Title": "15% off at Corner Café",
      "GroupName": "Food & Drink",
      "FullText": "<p>Show your member badge at Corner Café for 15% off any order.</p>",
      "SummaryText": "15% off any order"
    }
  ]
}

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const { resource: perks } = useTypedData(httpClient, endpoints.perks.list())
// perks.Groups, perks.Perks