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

Purplebricks Appointments API

The Appointments API from Purplebricks — 2 operation(s) for appointments.

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

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

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

Requests are made against a single base URL, https://api.purplebricks.co.uk/viewings-api.

2 operations 2 paths 17 schemas 2 POST

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 Appointments 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 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Appointments 2
POST
/v1/appointments
Books a viewing appointment.
body → 201400401403409429
POST
/v1/appointments/cancel
body → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Purplebricks.Viewings.Business.ViewModels.BookViewingConfirmationViewModel (17 properties), Purplebricks.Viewings.Business.Models.ViewingBuyerAdditionalDataInputModel (10 properties), Purplebricks.Viewings.Business.Models.BookViewingInputModel (9 properties), Purplebricks.Viewings.Business.Models.ViewingTenantAdditionalDataInputModel (8 properties). Each schema is shown below with its type and property counts.

Purplebricks.Viewings.Business.Models.ViewingTenantAdditionalDataInputModel
object
8 properties
Purplebricks.Viewings.Business.Commands.CancelViewingCommand
object
4 properties
Purplebricks.DatabaseModel.Enumerations.Property.LettingTerms
string
Purplebricks.DatabaseModel.Enumerations.ViewingAdditional.MortgageAgreementStatus
string
Purplebricks.Viewings.Business.Models.BookingRequestStatus
string
Purplebricks.Viewings.Business.Models.ViewingCustomerContactDetailsInputModel
object
4 properties
Purplebricks.DatabaseModel.Enumerations.ViewingAdditional.ViewingPurpose
string
Purplebricks.DatabaseModel.Enumerations.BookingProcess
string
Purplebricks.DatabaseModel.Enumerations.Offer.SaleProgressOption
string
Microsoft.AspNetCore.Mvc.ProblemDetails
object
5 properties
Purplebricks.Viewings.Business.ViewModels.BookViewingConfirmationViewModel
object
17 properties
Purplebricks.Viewings.Business.Models.BookViewingInputModel
object
9 properties
Purplebricks.DatabaseModel.Enumerations.Offer.EmploymentStatus
string
Purplebricks.DatabaseModel.Enumerations.Offer.TenantTerms
string
Purplebricks.DatabaseModel.Enumerations.IanaTimeZone
string
Purplebricks.DatabaseModel.Enumerations.ContactNumberType
string
Purplebricks.Viewings.Business.Models.ViewingBuyerAdditionalDataInputModel
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

purplebricks-appointments-api-openapi.yml Raw ↑

Other APIs Purplebricks publishes across the network.

Purplebricks Access Details API
Purplebricks Active Property API
Purplebricks Activity Dashboard API
Purplebricks Address API
Purplebricks Agent Outlook Sync API
Purplebricks Auth API
Purplebricks Bland API
Purplebricks Contact Us API
Purplebricks Conveyancing Quote API
Purplebricks Countrywide API
Purplebricks Customer Emails API
Purplebricks Dashboard API
Where this information came from

This is an independent, third-party profile of Purplebricks Appointments 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.