CommunityPerks
Search CommunityPerks
Search and list CommunityPerk records with filtering, sorting, and pagination.
GET
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
eDataVisibilityCriteria
| Value | Name |
|---|---|
| 1 | AllChildren |
| 2 | AllParents |
| 3 | AllLocations |
| 4 | HomeLocationOnly |
| 5 | HomeLocationChildren |
| 6 | HomeLocationParents |
| 7 | ThisLocationOnly |
| 8 | AllParentChildren |
Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by iD of the location this perk belongs to.
Filter by location name.
Filter by name of the perk as displayed on the Members Portal and the Admin Panel.
Filter by uRL where customers are redirected when clicking the Claim button. If blank, no Claim button is shown. Must start with https://.
Filter by short description shown under the perk title on the Perks listing page of the Members Portal.
Filter by full description of the perk, displayed when a customer clicks on it from the Perks listing page.
Filter by file name of the small image shown on the Perks listing page alongside other perks.
Filter by uRL of a new small image to upload for this perk.
Filter by set to true to remove the current small image from this perk.
Filter by file name of the large image displayed under the perk title on the perk detail page.
Filter by uRL of a new large image to upload for this perk.
Filter by set to true to remove the current large image from this perk.
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.
Filter by group or category this perk belongs to, used to organise perks on the Members Portal.
Filter by position of this perk in the list relative to other perks. Lower values appear first.
Filter by whether to feature this perk on the Members Portal home page after users log in.
Filter by number of times customers have clicked on this perk.
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.
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
Filter by position of this perk in the list relative to other perks. Lower values appear first greater than or equal to this value.
Filter by position of this perk in the list relative to other perks. Lower values appear first less than or equal to this value.
Filter by number of times customers have clicked on this perk greater than or equal to this value.
Filter by number of times customers have clicked on this perk less than or equal to this value.
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Title
Range filters
Response
200
The list of CommunityPerk records matching the query. See the Get one CommunityPerk endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response