API Reference

The PropertyPal Commercial Listings API.
View as Markdown

The Commercial Listings API lets you manage commercial property listings on PropertyPal. It supports uploading new listings, updating existing ones (keyed on the reference field), and retrieving or removing them.

Before you start, make sure you’ve read Authentication and Environments.

Endpoints

MethodPathDescription
PUT/v2/property/commercial/{reference}Create or update a commercial property.
GET/v2/property/commercial/{reference}Retrieve a single listing.
GET/v2/property/commercial/branchPage through all live listings for a branch.
DELETE/v2/property/commercial/{reference}Remove a listing.

Key concepts

  • reference is your stable identifier for a property. Re-sending the same reference updates the existing record; a new reference creates a new listing.
  • Building vs. spaces — upload a property as a standalone building, or include a spaces[] array to market individual floors/units. Converting BUILDINGSPACE is supported; the reverse is not.
  • Media — photos, floor plans, EPCs, brochures and virtual tours are submitted as arrays of media assets. Brochure URLs must end in .pdf.

Error handling

For 4xx and 5xx errors the API returns a JSON ProblemDetail body:

ProblemDetail (400)
1{
2 "type": "https://api-services.rightmove.co.uk/problems/validation",
3 "title": "Validation failed",
4 "status": 400,
5 "detail": "One or more fields failed validation.",
6 "instance": "/v2/property/commercial/DEMO-001",
7 "properties": {
8 "traceId": "1d3b0a4e-9c9e-4d6a-9a45-c7c0a8f7c2a1",
9 "timestamp": "2026-06-19T09:00:00Z",
10 "validationError": [
11 { "field": "building.location.postcode", "message": "postcode is required" }
12 ]
13 }
14}

Include properties.traceId when contacting support about a failed request.

Browse the full endpoint reference in the sidebar for schemas, enums, and live request/response examples.