> ## 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 BusinessAnnouncement

> Retrieve a single BusinessAnnouncement record by its Id.

A **BusinessAnnouncement** is a notification displayed to customers on the members portal and mobile app. Announcements support plain text only (no bold, italics, or lists) and can include an optional image and a call-to-action button.

Use `ActiveFrom` and `ActiveTo` to schedule when the announcement is visible. Use `OnlyForContacts` and `OnlyForMembers` to control the audience:

| OnlyForContacts | OnlyForMembers | Audience                               |
| --------------- | -------------- | -------------------------------------- |
| false           | false          | All customers (contacts and members)   |
| true            | false          | Contacts only (no active contract)     |
| false           | true           | Members only (with an active contract) |

Announcement images should ideally be 600x350 pixels (12:7 aspect ratio). Set `NewImageUrl` to a URL to upload a new image, or set `ClearImage` to true to remove the current image.

## 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 **`BusinessAnnouncement-Read`** role.
</Note>

## Path Parameters

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

## Code Examples

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

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/content/businessannouncements/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/businessannouncements/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  Business Id.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Business name.
</ResponseField>

<ResponseField name="Name" type="string">
  Announcement title.
</ResponseField>

<ResponseField name="Active" type="boolean">
  Whether the announcement is active and visible to customers.
</ResponseField>

<ResponseField name="ImageFileName" type="string">
  Current image file name.
</ResponseField>

<ResponseField name="NewImageUrl" type="string">
  URL of a new image to upload (ideal size 600x350 pixels, 12:7 aspect ratio).
</ResponseField>

<ResponseField name="ClearImageFile" type="boolean">
  Clear Image File.
</ResponseField>

<ResponseField name="Body" type="string">
  Announcement body text (plain text only, no formatting).
</ResponseField>

<ResponseField name="ShowButton" type="boolean">
  Whether to display a call-to-action button in the announcement.
</ResponseField>

<ResponseField name="ButtonLabel" type="string">
  Text displayed on the call-to-action button.
</ResponseField>

<ResponseField name="ButtonUrl" type="string">
  URL the call-to-action button redirects to (must start with https\://).
</ResponseField>

<ResponseField name="SendPushNotification" type="boolean">
  Whether to send a push notification to customers when the announcement is published.
</ResponseField>

<ResponseField name="PushNotificationText" type="string">
  Text of the push notification sent to customers.
</ResponseField>

<ResponseField name="ActiveFrom" type="string">
  Date from which the announcement is visible to customers (publish from).
</ResponseField>

<ResponseField name="ActiveTo" type="string">
  Date until which the announcement is visible to customers (publish to).
</ResponseField>

<ResponseField name="OnlyForContacts" type="boolean">
  Restrict announcement visibility to contacts (customers without an active contract).
</ResponseField>

<ResponseField name="OnlyForMembers" type="boolean">
  Restrict announcement visibility to members (customers with an active contract).
</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,
  "BusinessName": null,
  "Name": "",
  "Active": false,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "Body": null,
  "ShowButton": false,
  "ButtonLabel": null,
  "ButtonUrl": null,
  "SendPushNotification": false,
  "PushNotificationText": null,
  "ActiveFrom": null,
  "ActiveTo": null,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "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": "BusinessAnnouncement Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```