Search CommunityPerks - Nexudus Platform

GET

api

content

communityperks

Search CommunityPerks

curl --request GET \
  --url https://spaces.nexudus.com/api/content/communityperks \
  --header 'Authorization: Basic <encoded-value>'

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Enums

eDataVisibilityCriteria

Value	Name
1	AllChildren
2	AllParents
3	AllLocations
4	HomeLocationOnly
5	HomeLocationChildren
6	HomeLocationParents
7	ThisLocationOnly
8	AllParentChildren

Query Parameters

Pagination & Sorting

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

The property name to sort results by (e.g. Name, CreatedOn).

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

CommunityPerk_Business

integer

Filter by iD of the location this perk belongs to.

CommunityPerk_Title

string

Filter by name of the perk as displayed on the Members Portal and the Admin Panel.

CommunityPerk_PerkUrl

string

Filter by uRL where customers are redirected when clicking the Claim button. If blank, no Claim button is shown. Must start with https://.

CommunityPerk_SummaryText

string

Filter by short description shown under the perk title on the Perks listing page of the Members Portal.

CommunityPerk_FullText

string

Filter by full description of the perk, displayed when a customer clicks on it from the Perks listing page.

CommunityPerk_ImageFileName

string

Filter by file name of the small image shown on the Perks listing page alongside other perks.

CommunityPerk_NewImageUrl

string

Filter by uRL of a new small image to upload for this perk.

CommunityPerk_ClearImage

boolean

Filter by set to true to remove the current small image from this perk.

CommunityPerk_LargeImageFileName

string

Filter by file name of the large image displayed under the perk title on the perk detail page.

CommunityPerk_NewLargeImageUrl

string

Filter by uRL of a new large image to upload for this perk.

CommunityPerk_ClearLargeImage

boolean

Filter by set to true to remove the current large image from this perk.

CommunityPerk_Active

boolean

Filter by whether this perk is published and visible to customers on the Members Portal. When false, the perk is only visible on the Admin Panel.

CommunityPerk_GroupName

string

Filter by group or category this perk belongs to, used to organise perks on the Members Portal.

CommunityPerk_DisplayOrder

integer

Filter by position of this perk in the list relative to other perks. Lower values appear first.

CommunityPerk_ShowInHomePage

boolean

Filter by whether to feature this perk on the Members Portal home page after users log in.

CommunityPerk_ClickCount

integer

Filter by number of times customers have clicked on this perk.

CommunityPerk_OnlyForContacts

boolean

Filter by whether this perk is only available to contacts. Set both OnlyForContacts and OnlyForMembers to false to make the perk available to all customers.

CommunityPerk_OnlyForMembers

boolean

Filter by whether this perk is only available to members. Set both OnlyForContacts and OnlyForMembers to false to make the perk available to all customers.

Range Filters

from_CommunityPerk_DisplayOrder

integer

Filter by position of this perk in the list relative to other perks. Lower values appear first greater than or equal to this value.

to_CommunityPerk_DisplayOrder

integer

Filter by position of this perk in the list relative to other perks. Lower values appear first less than or equal to this value.

from_CommunityPerk_ClickCount

integer

Filter by number of times customers have clicked on this perk greater than or equal to this value.

to_CommunityPerk_ClickCount

integer

Filter by number of times customers have clicked on this perk less than or equal to this value.

from_CommunityPerk_CreatedOn

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CommunityPerk_CreatedOn

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_CommunityPerk_UpdatedOn

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CommunityPerk_UpdatedOn

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/content/communityperks?page=1&size=15&orderBy=Title&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Title

curl -X GET \
  "https://spaces.nexudus.com/api/content/communityperks?CommunityPerk_Title=example-value&orderBy=Title&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/content/communityperks?from_CommunityPerk_UpdatedOn=2025-01-01T00:00&to_CommunityPerk_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records

CommunityPerk[]

The list of CommunityPerk records matching the query. See the Get one CommunityPerk endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each CommunityPerk. The following fields are not populated in the Records[] response: FullText, Active, ShowInHomePage, ClickCount, OnlyForContacts, OnlyForMembers.To get all fields, fetch the full record using the Get one CommunityPerk endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

The sort direction (0 = ascending, 1 = descending).

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "Title": "",
      "PerkUrl": null,
      "SummaryText": null,
      "ImageFileName": null,
      "NewImageUrl": null,
      "ClearImageFile": null,
      "LargeImageFileName": null,
      "NewLargeImageUrl": null,
      "ClearLargeImageFile": null,
      "GroupName": null,
      "DisplayOrder": 0,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Title",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one CommunityPerkRetrieve a single CommunityPerk record by its Id.

Search CommunityPerks

curl --request GET \
  --url https://spaces.nexudus.com/api/content/communityperks \
  --header 'Authorization: Basic <encoded-value>'

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Title

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Title

Range filters

Response

200