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

# Portal Syndication

> Export your active property listings as JSON or XML for distribution to external portals. Available on the BUSINESS plan.

Portal Syndication lets you export your active property listings from BrikSync PropOS in a structured format — JSON or XML — so you can share them with external property portals, feed bulk-import tools, or connect your own systems.

<Note>
  Portal Syndication is available on the **BUSINESS plan** only. Owners and Admins on the Business
  plan can trigger exports. Property Managers on Business can view export history.
</Note>

***

## How it works

BrikSync PropOS generates a snapshot of your active properties and their units on demand. You trigger the export from the **Syndication** page; the system builds the file and makes it available for download. Export history is kept inline on the same page.

There are no scheduled or automatic exports — each export is triggered manually.

***

## Triggering an export

1. Go to **Syndication** in the left sidebar.
2. Click **Export JSON** or **Export XML** depending on the format you need.
3. The export runs immediately. Refresh the page or wait for the page to update — the new entry will appear in the **Export History** table below.
4. Once the export shows **Completed**, click **Download** to save the file.

<Note>
  Only Admins and Owners can trigger exports. Property Managers on the Business plan can view export
  history but cannot trigger new exports.
</Note>

***

## Export formats

### JSON

The JSON export contains a structured array of property listings, each with nested unit data. Use this format for integrations, custom tooling, or portals that accept JSON feeds.

```json theme={null}
{
  "generated": "2026-06-21T10:00:00.000Z",
  "listings": [
    {
      "id": "abc12345-...",
      "ref": "ABC12345",
      "title": "Maple House",
      "type": "residential",
      "address": "12 Maple Street",
      "city": "London",
      "postcode": "E1 6RF",
      "description": "A well-maintained Victorian terrace...",
      "available_units": 2,
      "units": [
        {
          "id": "unit-uuid",
          "unit_number": "Flat 1",
          "bedrooms": 2,
          "bathrooms": 1,
          "floor_area_sqft": 750,
          "rent_amount": 1800,
          "status": "available"
        }
      ],
      "created_at": "2026-01-15T09:00:00.000Z"
    }
  ]
}
```

### XML

The XML export uses a structure compatible with most portal bulk-import tools. Use this format for portals that accept XML property feeds.

```xml theme={null}
<?xml version="1.0" encoding="UTF-8"?>
<listings generated="2026-06-21T10:00:00.000Z">
  <property id="abc12345-...">
    <ref>ABC12345</ref>
    <title>Maple House</title>
    <type>residential</type>
    <address>12 Maple Street</address>
    <city>London</city>
    <postcode>E1 6RF</postcode>
    <available_units>2</available_units>
    <units>
      <unit id="unit-uuid">
        <number>Flat 1</number>
        <status>available</status>
        <bedrooms>2</bedrooms>
        <bathrooms>1</bathrooms>
        <rent>1800</rent>
      </unit>
    </units>
  </property>
</listings>
```

***

## Export status

Each export in the history table shows one of the following statuses:

| Status         | Description                                                |
| -------------- | ---------------------------------------------------------- |
| **Pending**    | Export is queued and waiting to be processed.              |
| **Processing** | Export is currently being generated.                       |
| **Completed**  | Export finished — the Download link is active.             |
| **Failed**     | Export encountered an error. Try again or contact support. |

***

## What is included in an export

Each export includes all **active** properties in your organisation, up to a maximum of 500 properties per export. For each property, the export includes:

* Property reference, title, type, address, city, and postcode
* Description
* All units with their status, rent amount, bedroom and bathroom count, and floor area
* Count of available units

Inactive or archived properties are not included.

***

## Uploading to a portal

After downloading the export file, upload it to your property portal using that portal's bulk import or feed tool. The steps vary by portal — refer to your portal's documentation for the specific upload process.

<Note>
  Direct API connections to Rightmove, Zoopla, OnTheMarket, PrimeLocation, and other portals are
  planned for a future release. Until then, use the JSON or XML export to upload manually or via
  your portal's bulk import tool.
</Note>

***

Built by [Errsol Technologies LLP](https://errsol.com)