How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Purplebricks

Purplebricks Property API

The Property API from Purplebricks — 30 operation(s) for property.

Documentation Provider Profile APIs.io OpenAPI GitHub

Purplebricks Property API is one of 58 APIs that Purplebricks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Property. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

This API exposes 30 operations across 30 paths, and defines 154 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.purplebricks.co.uk/branch-api, https://api.purplebricks.co.uk/property-api.

30 operations 30 paths 154 schemas 2 DELETE18 GET9 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.purplebricks.co.uk/property-api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Purplebricks Property API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — Authorization header using Bearer scheme

Paths & Operations 30

Across 30 paths, the API surfaces 30 operations — 2 DELETE, 18 GET, 9 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Property 30
GET
/v1/property/{propertyId}/rightmovebranch
1 param → 401200404403
GET
/v1/property/{propertyId}/zooplabranch
1 param → 401200404403
GET
/v1/property/{propertyId}/onthemarketbranch
1 param → 401200404403
POST
/v1/property/create
body → 401201404400409
POST
/v1/property/relistproperty
body → 401409403201404
GET
/v1/property/getpropertylist
→ 200
GET
/v1/property/getproperty
1 param → 200
GET
/v1/property/getowners
1 param → 200
POST
/v1/property/marketingprice
body → 401403400404409
PUT
/v1/property/addpropertymediadata
body → 401409403201404
GET
/v1/property/{propertyId}
1 param → 200404400401
GET
/v1/property/{propertyId}/address
1 param body → 200401405404400
POST
/v1/property/rentalprice
body → 200
GET
/v1/property/getagentforproperty
1 param → 200
GET
/v1/property/getsalesaddonavailability
1 param → 200
GET
/v1/property/hasboardordered
1 param → 200
GET
/v1/property/getpropertyhistory
1 param → 200
GET
/v1/property/getuserproperties
1 param → 200
GET
/v1/property/getportalenquiries
1 param → 200
GET
/v1/property/getpropertytracks
1 param → 200
POST
/v1/property/registertrackedrecord
body → 201400401404
DELETE
/v1/property/withdrawtrackedrecord
1 param → 200400401404
POST
/v1/property/registernoteofinterest
body → 201400401404
DELETE
/v1/property/withdrawnoteofinterest
1 param → 200400401404
GET
/v1/property/getpropertyactions
1 param → 200
POST
/v1/property/createproperty
body → 401201400404500default
POST
/v1/property/resetproperty/{propertyId}/{userId}
2 params → 401201400404500default
POST
/v1/property/sendinstantinstructcontactrequest
body → 200401400500
GET
/v1/creatio/properties/{propertyId}
1 param → 200400401404500
GET
/v1/creatio/properties/{propertyId}/notes
1 param → 200400401500

Schemas 154

The contract defines 154 schemas that model the data the API accepts and returns. The most detailed are Purplebricks.Property.Domain.Entities.Property (99 properties), Purplebricks.Property.Business.ViewModels.PropertyDetailsViewModel (83 properties), Purplebricks.Property.Contract.PropertyDetails (27 properties), Purplebricks.Property.Domain.Entities.Customer (27 properties). Each schema is shown below with its type and property counts.

BranchService
string
OnTheMarketBranch
object
5 properties
RightmoveBranch
object
5 properties
ProblemDetails
object
5 properties
Purplebricks.Property.Domain.Entities.Valuation
object
5 properties
Purplebricks.Property.Domain.Enums.PaymentStatus
string
Purplebricks.Property.Domain.Enums.HistoryEventType
string
Purplebricks.Property.Domain.Enums.ExpertType
string
Purplebricks.Property.Domain.Enums.BoardProviderType
string
Purplebricks.Property.Domain.Enums.Furnished
string
Purplebricks.Property.Business.ViewModels.Creatio.CreatioExpert
object
2 properties
Purplebricks.Property.Business.InputModels.RentalPriceInputModel
object
4 properties
Purplebricks.Property.Domain.Enums.ViewingPurpose
string
Purplebricks.Property.Domain.Enums.SellerOwnership
string
Purplebricks.Property.Domain.Enums.AmendmentStatus
string
Purplebricks.Property.Business.ViewModels.Creatio.CreatioPropertyViewModel
object
1 property
Purplebricks.Property.Domain.Enums.LandAreaUnit
string
Purplebricks.Property.Domain.Enums.RegionType
string
Purplebricks.Property.Domain.Enums.ComplianceStatus
string
Purplebricks.Property.Domain.Enums.PropertyListingRemovalReason
string
Purplebricks.Property.Business.InputModels.PropertyMediaData
object
10 properties
Purplebricks.Property.Domain.Entities.TenantAdditionalData
object
14 properties
Purplebricks.Property.Domain.Enums.InstructionSourceType
string
Purplebricks.Property.Domain.Entities.PaymentTransaction
object
4 properties
Purplebricks.Property.Domain.Enums.IdUploadType
string
Purplebricks.Property.Domain.Model.PropertyEnquiryModel
object
8 properties
Purplebricks.Property.Business.ViewModels.Creatio.PropertyNote
object
8 properties
Purplebricks.Property.Domain.Enums.EventType
string
Purplebricks.Property.Domain.Enums.VoucherType
string
Purplebricks.Property.Domain.Entities.BookingDiary
object
20 properties
Purplebricks.Property.Domain.Entities.StreetViewData
object
10 properties 8 required
Purplebricks.Property.Domain.Enums.ImageStatus
string
Purplebricks.Property.Domain.Enums.IdUploadFileType
string
Purplebricks.Property.Domain.Enums.RentFrequency
string
Purplebricks.Property.Domain.Enums.OwnershipReviewStatus
string
Purplebricks.Property.Domain.Enums.BookingProcess
string
Purplebricks.Property.Domain.Enums.CashSource
string
Purplebricks.Property.Domain.Enums.PriceQualifier
string
Purplebricks.Property.Domain.Enums.OrderStatus
string
Purplebricks.Property.Domain.Enums.WorkflowStepType
string
Purplebricks.Property.Business.ViewModels.OwnersViewModel
object
3 properties
Purplebricks.Property.Contract.Enums.Tenure
string
Purplebricks.Property.Domain.Enums.HistoryEventAction
string
Purplebricks.Property.Domain.Enums.BoardProcessingStatus
string
Purplebricks.Property.Domain.Entities.Address
object
16 properties
Purplebricks.Property.Domain.Entities.PropertyTitleDeed
object
3 properties
Purplebricks.Property.Domain.Enums.UserDiscriminator
string
Purplebricks.Property.Domain.Entities.PropertyContract
object
3 properties
Purplebricks.Property.Domain.Entities.ImageDetail
object
14 properties
Purplebricks.Property.Domain.Entities.PropertyBoardAction
object
14 properties
Purplebricks.Property.Domain.Enums.IanaTimeZone
string
Purplebricks.Property.Contract.PropertyDetails
object
27 properties
Purplebricks.Property.Domain.Entities.VoucherAddOnType
object
3 properties
Purplebricks.Property.Business.ViewModels.OwnerViewModel
object
19 properties 2 required
Purplebricks.Property.Domain.Entities.IdCheck
object
12 properties
Purplebricks.Property.Domain.Enums.Garden
string
Purplebricks.Property.Domain.Entities.PropertyListingHistory
object
6 properties
Purplebricks.Property.Domain.Entities.Feedback
object
10 properties
Purplebricks.Property.Domain.Enums.TaxBand
string
Purplebricks.Property.Domain.Model.PropertyTrackModel
object
5 properties
Purplebricks.Property.Domain.Entities.ShoppingCartItem
object
10 properties
Purplebricks.Property.Domain.Entities.CustomerAdditionalData
object
9 properties
Purplebricks.Property.Domain.Entities.PurplebricksPlus
object
6 properties
Purplebricks.Property.Domain.Entities.ShoppingCart
object
11 properties
Purplebricks.Property.Domain.Enums.AddOnType
string
Purplebricks.Property.Business.ViewModels.OwnerIdCheckViewModel
object
9 properties
Purplebricks.Property.Domain.Enums.RegulatoryCertificateType
string
Purplebricks.Property.Contract.Enums.Parking
string
Purplebricks.Property.Domain.Entities.PropertyMaster
object
3 properties
Purplebricks.Property.Domain.Entities.Order
object
12 properties
Purplebricks.Property.Domain.Enums.AssociationFeeFrequency
string
Purplebricks.Property.Domain.Enums.WithdrawPropertyReason
string
Purplebricks.Property.Domain.Entities.PropertyAttributeDescriptionAmendment
object
7 properties
Purplebricks.Property.Domain.Entities.User
object
15 properties
Purplebricks.Property.Domain.Enums.OfferTenancyStatus
string
Purplebricks.Property.Domain.Entities.MarketingPriceStatus
string
Purplebricks.Property.Domain.Enums.RegulatoryCertificateStatus
string
Purplebricks.Property.Domain.Entities.Property
object
99 properties
Purplebricks.Property.Domain.Entities.LocalPropertyExpert
object
21 properties
Purplebricks.Property.Domain.Model.HistoryEventModel
object
7 properties
Purplebricks.Property.Domain.Entities.OfferTenancy
object
7 properties
Purplebricks.Property.Domain.Enums.PaymentMethod
string
Purplebricks.Property.Domain.Entities.BuyerAdditionalData
object
18 properties
Purplebricks.Property.Business.ViewModels.Creatio.CreatioPropertyNotesViewModel
object
1 property
Purplebricks.Property.Domain.Entities.OrderLine
object
7 properties
Purplebricks.Property.Business.InputModels.ContactRequestInputModel
object
3 properties
Purplebricks.Property.Domain.Enums.OrderType
string
Purplebricks.Property.Domain.Entities.PropertyAttribute
object
14 properties
Purplebricks.Property.Domain.Entities.LocationGroupAddOnPrice
object
4 properties
Purplebricks.Property.Domain.Model.UserPropertyModel
object
11 properties
Purplebricks.Property.Business.ViewModels.HomeOwnerAssociationViewModel
object
4 properties
Purplebricks.Property.Business.ViewModels.LocationGroupSalesAddOnAvailabilityViewModel
object
1 property
Purplebricks.Property.Business.ViewModels.Creatio.Address
object
6 properties
Purplebricks.Property.Domain.Enums.LettingTerms
string
Purplebricks.Property.Domain.Enums.IdStatus
string
Purplebricks.Property.Domain.Entities.OfferBuyer
object
11 properties 1 required
Purplebricks.Property.Domain.Entities.PropertyViewed
object
6 properties
Purplebricks.Property.Contract.Enums.Heating
string
Purplebricks.Property.Contract.Enums.Garage
string
Purplebricks.Property.Domain.Entities.PropertyBoardProvider
object
6 properties
Purplebricks.Property.Domain.Entities.PortalEnquiry
object
14 properties 1 required
Purplebricks.Property.Domain.Entities.AddOn
object
6 properties
Purplebricks.Property.Domain.Entities.PropertyCompliance
object
6 properties
Purplebricks.Property.Domain.Entities.RightmoveAdvertPerformance
object
5 properties
Purplebricks.Property.Domain.Entities.LocationGroup
object
6 properties
Purplebricks.Property.Domain.Enums.EmploymentStatus
string
Purplebricks.Property.Domain.Entities.PropertyTenancy
object
23 properties
Purplebricks.Property.Domain.Enums.Parking
string
Microsoft.AspNetCore.Mvc.ProblemDetails
object
5 properties
Purplebricks.Property.Domain.Enums.Deposit
string
Purplebricks.Property.Contract.RelistPropertyRequest
object
2 properties 2 required
Purplebricks.Property.Domain.Entities.HistoryEvent
object
20 properties
Purplebricks.Property.Domain.Enums.TenantTerms
string
Purplebricks.Property.Domain.Enums.LettingServiceLevel
string
Purplebricks.Property.Business.InputModels.PropertyAddressRequest
object
1 property
Purplebricks.Property.Domain.Entities.EmailConfirmationToken
object
3 properties
Purplebricks.Property.Domain.Entities.PurpleBricksUser
object
19 properties
Purplebricks.Property.Domain.Enums.Glazing
string
Purplebricks.Property.Domain.Enums.MortgageAgreementStatus
string
Purplebricks.Property.Contract.Enums.Garden
string
Purplebricks.Property.Business.ViewModels.ExpertContactViewModel
object
3 properties
Purplebricks.Property.Domain.Entities.RegulatoryCertificate
object
13 properties
Purplebricks.Property.Business.ViewModels.Creatio.CreatioProperty
object
9 properties
Purplebricks.Property.Domain.Enums.UserType
string
Purplebricks.Property.Domain.Entities.PropertyTenureDetails
object
14 properties
Purplebricks.Property.Domain.Entities.ShoppingCartVoucher
object
8 properties
Purplebricks.Property.Domain.Entities.AdditionalOwner
object
13 properties
Purplebricks.Property.Domain.Enums.PortalType
string
Purplebricks.Property.Business.ViewModels.PropertyDetailsViewModel
object
83 properties
Purplebricks.Property.Domain.Entities.PropertyTrack
object
9 properties
Purplebricks.Property.Domain.Enums.MethodOfSale
string
Purplebricks.Property.Domain.Entities.BlockedViewing
object
9 properties
Purplebricks.Property.Domain.Entities.Voucher
object
2 properties
Purplebricks.Property.Domain.Entities.Offer
object
23 properties
Purplebricks.Property.Domain.Enums.Garage
string
Purplebricks.Property.Business.InputModels.SellingPriceInputModel
object
3 properties
Purplebricks.Property.Domain.Enums.AddressType
string
Purplebricks.Property.Contract.Enums.Glazing
string
Purplebricks.Property.Domain.Enums.Heating
string
Purplebricks.Property.Business.InputModels.PropertyTrackedInput
object
1 property
Purplebricks.Property.Domain.Entities.MarketPriceDetail
object
6 properties
Purplebricks.Property.Domain.Enums.OfferStatus
string
Purplebricks.Property.Business.InputModels.CreatePropertyInput
object
1 property
Purplebricks.Property.Domain.Enums.EmailAlertFrequency
string
Purplebricks.Property.Domain.Enums.Tenure
string
Purplebricks.Property.Domain.Entities.Customer
object
27 properties
Purplebricks.Property.Domain.Entities.PropertyAction
object
6 properties
Purplebricks.Property.Domain.Model.ExpertModel
object
5 properties
Purplebricks.Property.Domain.Entities.AddOnPrice
object
5 properties
Purplebricks.Property.Business.ViewModels.CreatePropertyViewModel
object
1 property
Purplebricks.Property.Domain.Entities.PropertySpecifics
object
23 properties
Purplebricks.Property.Domain.Enums.SaleProgressOption
string
Purplebricks.Property.Domain.Entities.FloorPlan
object
9 properties
Purplebricks.Property.Domain.Enums.JobType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

purplebricks-property-api-openapi.yml Raw ↑

Other APIs Purplebricks publishes across the network.

Purplebricks Access Details API
AE Profile APIs.io
Purplebricks Active Property API
AE Profile APIs.io
Purplebricks Activity Dashboard API
AE Profile APIs.io
Purplebricks Address API
AE Profile APIs.io
Purplebricks Agent Outlook Sync API
AE Profile APIs.io
Purplebricks Appointments API
AE Profile APIs.io
Purplebricks Auth API
AE Profile APIs.io
Purplebricks Bland API
AE Profile APIs.io
Purplebricks Contact Us API
AE Profile APIs.io
Purplebricks Conveyancing Quote API
AE Profile APIs.io
Purplebricks Countrywide API
AE Profile APIs.io
Purplebricks Customer Emails API
AE Profile APIs.io
#Property
← Back to P APIs
API Details
ID
purplebricks:purplebricks-property-api
Base URL
https://api.purplebricks.co.uk/property-api
Docs
https://api.purplebricks.co.uk/property-api/swagger/index.html
Provider
Purplebricks
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=purplebricks-property-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/purplebricks-property-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Purplebricks Property API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.