Skip to main content
GET
/
api
/
content
/
communityperks
/
{id}
{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Title": "<string>",
  "PerkUrl": "<string>",
  "SummaryText": "<string>",
  "FullText": "<string>",
  "ImageFileName": "<string>",
  "NewImageUrl": "<string>",
  "ClearImageFile": true,
  "LargeImageFileName": "<string>",
  "NewLargeImageUrl": "<string>",
  "ClearLargeImageFile": true,
  "Active": true,
  "GroupName": "<string>",
  "DisplayOrder": 123,
  "ShowInHomePage": true,
  "ClickCount": 123,
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "Tariffs": [
    123
  ],
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A CommunityPerk represents a perk, discount, or benefit that a location offers to its customers in partnership with other businesses. Perks can be discounts, free trials, or any other benefit negotiated with a partner business — for example, 50% off a car rental or a free hot drink at a nearby café. They are published on the Members Portal where customers can view and claim them. Use Active to control visibility — when false, the perk is only visible on the Admin Panel. Use ShowInHomePage to feature a perk on the Members Portal home page after users log in. Availability can be restricted via OnlyForContacts and OnlyForMembers. If neither flag is set, the perk is available to all customers. Use Tariffs to further restrict access to customers on specific pricing plans. Which perks are listed in a location is also controlled by the Access.Data.Perks BusinessSetting, whose value is an eDataVisibilityCriteria enum integer. This determines which locations’ perks are visible to customers at a given location — for example ThisLocationOnly (7) shows only perks belonging to the current location, while AllLocations (3) shows perks from all locations in the network.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CommunityPerk-Read role.

​
Path Parameters

​
id
integer
required
The Id of the CommunityPerk record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/content/communityperks/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
BusinessId
integer
ID of the location this perk belongs to.
​
BusinessName
string
Location name.
​
Title
string
Name of the perk as displayed on the Members Portal and the Admin Panel.
​
PerkUrl
string
URL where customers are redirected when clicking the Claim button. If blank, no Claim button is shown. Must start with https://.
​
SummaryText
string
Short description shown under the perk title on the Perks listing page of the Members Portal.
​
FullText
string
Full description of the perk, displayed when a customer clicks on it from the Perks listing page.
​
ImageFileName
string
File name of the small image shown on the Perks listing page alongside other perks.
​
NewImageUrl
string
URL of a new small image to upload for this perk.
​
ClearImageFile
boolean
Set to true to remove the current small image from this perk.
​
LargeImageFileName
string
File name of the large image displayed under the perk title on the perk detail page.
​
NewLargeImageUrl
string
URL of a new large image to upload for this perk.
​
ClearLargeImageFile
boolean
Set to true to remove the current large image from this perk.
​
Active
boolean
Whether this perk is published and visible to customers on the Members Portal. When false, the perk is only visible on the Admin Panel.
​
GroupName
string
Group or category this perk belongs to, used to organise perks on the Members Portal.
​
DisplayOrder
integer
Position of this perk in the list relative to other perks. Lower values appear first.
​
ShowInHomePage
boolean
Whether to feature this perk on the Members Portal home page after users log in.
​
ClickCount
integer
Number of times customers have clicked on this perk.
​
OnlyForContacts
boolean
Whether this perk is only available to contacts. Set both OnlyForContacts and OnlyForMembers to false to make the perk available to all customers.
​
OnlyForMembers
boolean
Whether this perk is only available to members. Set both OnlyForContacts and OnlyForMembers to false to make the perk available to all customers.
​
Tariffs
integer[]
IDs of the pricing plans (tariffs) whose members can see and claim this perk. Leave empty to make the perk available regardless of pricing plan.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "BusinessId": 0,
  "BusinessName": null,
  "Title": "",
  "PerkUrl": null,
  "SummaryText": null,
  "FullText": null,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "LargeImageFileName": null,
  "NewLargeImageUrl": null,
  "ClearLargeImageFile": null,
  "Active": false,
  "GroupName": null,
  "DisplayOrder": 0,
  "ShowInHomePage": false,
  "ClickCount": 0,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "Tariffs": [],
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CommunityPerk Example",
  "LocalizationDetails": null,
  "CustomFields": null
}