> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one CommunityPerk

> Retrieve a single CommunityPerk record by its Id.

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

<Note>
  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.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the CommunityPerk record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/content/communityperks/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/communityperks/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/content/communityperks/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the location this perk belongs to.
</ResponseField>

<ResponseField name="Title" type="string">
  Name of the perk as displayed on the Members Portal and the Admin Panel.
</ResponseField>

<ResponseField name="PerkUrl" type="string">
  URL where customers are redirected when clicking the Claim button. If blank, no Claim button is shown. Must start with https\://.
</ResponseField>

<ResponseField name="SummaryText" type="string">
  Short description shown under the perk title on the Perks listing page of the Members Portal.
</ResponseField>

<ResponseField name="FullText" type="string">
  Full description of the perk, displayed when a customer clicks on it from the Perks listing page.
</ResponseField>

<ResponseField name="ImageFileName" type="string">
  File name of the small image shown on the Perks listing page alongside other perks.
</ResponseField>

<ResponseField name="NewImageUrl" type="string">
  URL of a new small image to upload for this perk.
</ResponseField>

<ResponseField name="ClearImageFile" type="boolean">
  Set to true to remove the current small image from this perk.
</ResponseField>

<ResponseField name="LargeImageFileName" type="string">
  File name of the large image displayed under the perk title on the perk detail page.
</ResponseField>

<ResponseField name="NewLargeImageUrl" type="string">
  URL of a new large image to upload for this perk.
</ResponseField>

<ResponseField name="ClearLargeImageFile" type="boolean">
  Set to true to remove the current large image from this perk.
</ResponseField>

<ResponseField name="Active" type="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.
</ResponseField>

<ResponseField name="GroupName" type="string">
  Group or category this perk belongs to, used to organise perks on the Members Portal.
</ResponseField>

<ResponseField name="DisplayOrder" type="integer">
  Position of this perk in the list relative to other perks. Lower values appear first.
</ResponseField>

<ResponseField name="ShowInHomePage" type="boolean">
  Whether to feature this perk on the Members Portal home page after users log in.
</ResponseField>

<ResponseField name="ClickCount" type="integer">
  Number of times customers have clicked on this perk.
</ResponseField>

<ResponseField name="OnlyForContacts" type="boolean">
  Whether this perk is only available to contacts. Set both OnlyForContacts and OnlyForMembers to false to make the perk available to all customers.
</ResponseField>

<ResponseField name="OnlyForMembers" type="boolean">
  Whether this perk is only available to members. Set both OnlyForContacts and OnlyForMembers to false to make the perk available to all customers.
</ResponseField>

<ResponseField name="Tariffs" type="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.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "BusinessId": 0,
  "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
}
```