Purplebricks · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Purplebricks Property API 2.0 - Platform

12 actions 12 updates documentation extends openapi/purplebricks-property-v2-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Purplebricks's API. It is a proposal applied on top of the contract, not a document Purplebricks publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

operationIdx-apievangelist-sourcex-apievangelist-harvestedx-apievangelist-accessx-apievangelist-swagger-ui

Targets 12

$.info
$.paths['/v2/activeproperty/{id}'].get
$.paths['/v2/activitydashboard/getactivitydocument'].get
$.paths['/v2/activitydashboard/getpropertiesbyuserid'].get
$.paths['/v2/activitydashboard/getpropertynotificationcount'].get
$.paths['/v2/address/createaddress'].post
$.paths['/v2/dashboard'].get
$.paths['/v2/dashboard/externallinks'].get
$.paths['/v2/gotomarket/{propertyId}/boardandkeysafepreference'].post
$.paths['/v2/performancereport/{id}'].get
$.paths['/v2/performancereport/getadvertperformance'].get
$.paths['/v2/preactive/{id}'].get

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Purplebricks Property API 2.0 - Platform
  version: 1.0.0
extends: openapi/purplebricks-property-v2-openapi.yml
x-generated: '2026-07-26'
x-method: generated
x-note: Adds provenance metadata, a verified servers[] entry where the harvested document omitted or malformed it,
  and 11 derived operationId values. The upstream Purplebricks documents declare almost no operationIds, summaries
  or descriptions; this overlay never mutates the harvested original.
actions:
- target: $.info
  update:
    x-apievangelist-source: https://api.purplebricks.co.uk/property-api/swagger/v2/swagger.json
    x-apievangelist-harvested: '2026-07-26'
    x-apievangelist-access: publicly-served, Bearer-token protected, no public key issuance and no developer programme
    x-apievangelist-swagger-ui: https://api.purplebricks.co.uk/property-api/swagger/index.html
- target: $.paths['/v2/activeproperty/{id}'].get
  update:
    operationId: getV2ActivepropertyId
- target: $.paths['/v2/activitydashboard/getactivitydocument'].get
  update:
    operationId: getV2ActivitydashboardGetactivitydocument
- target: $.paths['/v2/activitydashboard/getpropertiesbyuserid'].get
  update:
    operationId: getV2ActivitydashboardGetpropertiesbyuserid
- target: $.paths['/v2/activitydashboard/getpropertynotificationcount'].get
  update:
    operationId: getV2ActivitydashboardGetpropertynotificationcount
- target: $.paths['/v2/address/createaddress'].post
  update:
    operationId: postV2AddressCreateaddress
- target: $.paths['/v2/dashboard'].get
  update:
    operationId: getV2Dashboard
- target: $.paths['/v2/dashboard/externallinks'].get
  update:
    operationId: getV2DashboardExternallinks
- target: $.paths['/v2/gotomarket/{propertyId}/boardandkeysafepreference'].post
  update:
    operationId: postV2GotomarketPropertyIdBoardandkeysafepreference
- target: $.paths['/v2/performancereport/{id}'].get
  update:
    operationId: getV2PerformancereportId
- target: $.paths['/v2/performancereport/getadvertperformance'].get
  update:
    operationId: getV2PerformancereportGetadvertperformance
- target: $.paths['/v2/preactive/{id}'].get
  update:
    operationId: getV2PreactiveId