Purplebricks

Purplebricks Users API

The Users API from Purplebricks — 4 operation(s) for users.

GitHub OpenAPI

Operations 4

GET /v1/creatio/users/{userId}/properties Get creatio users by user id properties #
GET /v1/creatio/users/{userId}/valuations Get creatio users by user id valuations #
GET /v1/creatio/users/{userId}/viewings Get creatio users by user id viewings #
GET /v1/creatio/users/{userId}/viewings/feedback Get creatio users by user id viewings feedback #

Documentation

📖
APIReference
https://api.purplebricks.co.uk/property-api/swagger/index.html
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/purplebricks/refs/heads/main/authentication/purplebricks-authentication.yml
📖
APIReference
https://api.purplebricks.co.uk/account-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/valuations-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/viewings-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/messaging-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/lettings-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/branch-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/communications-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/conveyancing-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/agent-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/feedback-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/workflow-api/swagger/index.html
📖
APIReference
https://api.purplebricks.co.uk/outlook-api/swagger/index.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/purplebricks/refs/heads/main/openapi/purplebricks-users-api-openapi.yml

Other Resources

🔗
SwaggerUI
https://api.purplebricks.co.uk/property-api/swagger/index.html
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/purplebricks/refs/heads/main/conventions/purplebricks-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/purplebricks/refs/heads/main/errors/purplebricks-problem-types.yml
🔗
SwaggerUI
https://api.purplebricks.co.uk/account-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/valuations-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/viewings-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/messaging-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/lettings-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/branch-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/communications-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/conveyancing-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/agent-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/feedback-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/workflow-api/swagger/index.html
🔗
SwaggerUI
https://api.purplebricks.co.uk/outlook-api/swagger/index.html

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/purplebricks-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

purplebricks-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Purplebricks Users API
  version: '1.0'
  description: 'Operations tagged Users across 3 of this provider''s published API definitions: purplebricks-property-v1-openapi.yml, purplebricks-valuations-v1-openapi.yml, purplebricks-viewings-v1-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.purplebricks.co.uk/property-api
- url: https://api.purplebricks.co.uk/valuations-api
- url: https://api.purplebricks.co.uk/viewings-api
security:
- Bearer: []
tags:
- name: Users
paths:
  /v1/creatio/users/{userId}/properties:
    get:
      tags:
      - Users
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Purplebricks.Property.Business.ViewModels.Creatio.CreatioUserPropertiesViewModel'
            application/json:
              schema:
                $ref: '#/components/schemas/Purplebricks.Property.Business.ViewModels.Creatio.CreatioUserPropertiesViewModel'
            text/json:
              schema:
                $ref: '#/components/schemas/Purplebricks.Property.Business.ViewModels.Creatio.CreatioUserPropertiesViewModel'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '500':
          description: Server Error
      summary: Get creatio users by user id properties
      x-summary-source: derived
      operationId: getV1CreatioUsersByUserIdProperties
      x-operation-id-source: derived
    servers:
    - url: https://api.purplebricks.co.uk/property-api
  /v1/creatio/users/{userId}/valuations:
    get:
      tags:
      - Users
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Purplebricks.Valuations.Domains.Models.CreatioValuationDetail'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Purplebricks.Valuations.Domains.Models.CreatioValuationDetail'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Purplebricks.Valuations.Domains.Models.CreatioValuationDetail'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails'
        '500':
          description: Server Error
      summary: Get creatio users by user id valuations
      x-summary-source: derived
      operationId: getV1CreatioUsersByUserIdValuations
      x-operation-id-source: derived
    servers:
    - url: https://api.purplebricks.co.uk/valuations-api
  /v1/creatio/users/{userId}/viewings:
    get:
      tags:
      - Users
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Purplebricks.Viewings.Business.Models.UserViewingDetail'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Purplebricks.Viewings.Business.Models.UserViewingDetail'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Purplebricks.Viewings.Business.Models.UserViewingDetail'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '500':
          description: Server Error
      summary: Get creatio users by user id viewings
      x-summary-source: derived
      operationId: getV1CreatioUsersByUserIdViewings
      x-operation-id-source: derived
    servers:
    - url: https://api.purplebricks.co.uk/viewings-api
  /v1/creatio/users/{userId}/viewings/feedback:
    get:
      tags:
      - Users
      parameters:
      - name: userId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Purplebricks.Viewings.Business.Models.CreatioFeedbackDetail'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Purplebricks.Viewings.Business.Models.CreatioFeedbackDetail'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Purplebricks.Viewings.Business.Models.CreatioFeedbackDetail'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
        '500':
          description: Server Error
      summary: Get creatio users by user id viewings feedback
      x-summary-source: derived
      operationId: getV1CreatioUsersByUserIdViewingsFeedback
      x-operation-id-source: derived
    servers:
    - url: https://api.purplebricks.co.uk/viewings-api
components:
  schemas:
    Purplebricks.Property.Business.ViewModels.Creatio.CreatioProperty:
      type: object
      properties:
        propertyId:
          type: integer
          format: int32
        address:
          $ref: '#/components/schemas/Purplebricks.Property.Business.ViewModels.Creatio.Address'
        status:
          type:
          - string
          - 'null'
        isSales:
          type: boolean
        isLettings:
          type: boolean
        lpp:
          $ref: '#/components/schemas/Purplebricks.Property.Business.ViewModels.Creatio.CreatioExpert'
        accountManager:
          $ref: '#/components/schemas/Purplebricks.Property.Business.ViewModels.Creatio.CreatioExpert'
        negotiationExpert:
          $ref: '#/components/schemas/Purplebricks.Property.Business.ViewModels.Creatio.CreatioExpert'
        salesProgressor:
          $ref: '#/components/schemas/Purplebricks.Property.Business.ViewModels.Creatio.CreatioExpert'
      additionalProperties: false
    Purplebricks.Property.Business.ViewModels.Creatio.CreatioExpert:
      type: object
      properties:
        fullName:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
      additionalProperties: false
    Microsoft.AspNetCore.Mvc.ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
    Purplebricks.Property.Business.ViewModels.Creatio.CreatioUserPropertiesViewModel:
      type: object
      properties:
        total:
          type: integer
          format: int32
        properties:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Purplebricks.Property.Business.ViewModels.Creatio.CreatioProperty'
      additionalProperties: false
    Purplebricks.Property.Business.ViewModels.Creatio.Address:
      type: object
      properties:
        line1:
          type:
          - string
          - 'null'
        line2:
          type:
          - string
          - 'null'
        town:
          type:
          - string
          - 'null'
        county:
          type:
          - string
          - 'null'
        postcode:
          type:
          - string
          - 'null'
        country:
          type:
          - string
          - 'null'
      additionalProperties: false
    Purplebricks.Valuations.Domains.Models.CreatioValuationDetail:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/Purplebricks.Valuations.Domains.Models.AddressViewModel'
        propertyId:
          type: integer
          format: int32
        valuationDate:
          type: string
          format: date-time
        status:
          type:
          - string
          - 'null'
        isSales:
          type: boolean
        recommendedListPrice:
          type:
          - number
          - 'null'
          format: double
        lowListPrice:
          type:
          - number
          - 'null'
          format: double
        highListPrice:
          type:
          - number
          - 'null'
          format: double
        lpp:
          $ref: '#/components/schemas/Purplebricks.Valuations.Domains.Models.CreatioExpert'
        accountManager:
          $ref: '#/components/schemas/Purplebricks.Valuations.Domains.Models.CreatioExpert'
        valuationType:
          $ref: '#/components/schemas/Purplebricks.Valuations.Domains.Models.Enums.EventType'
      additionalProperties: false
    Purplebricks.Valuations.Domains.Models.AddressViewModel:
      type: object
      properties:
        line1:
          type:
          - string
          - 'null'
        line2:
          type:
          - string
          - 'null'
        town:
          type:
          - string
          - 'null'
        county:
          type:
          - string
          - 'null'
        country:
          type:
          - string
          - 'null'
        postcode:
          type:
          - string
          - 'null'
      additionalProperties: false
    Purplebricks.Valuations.Domains.Models.Enums.EventType:
      enum:
      - Valuation
      - Viewing
      - OpenDay
      - Busy
      - VirtualValuation
      type: string
    Purplebricks.Valuations.Domains.Models.CreatioExpert:
      type: object
      properties:
        fullName:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
      additionalProperties: false
    Purplebricks.Viewings.Business.ViewModels.EventUserDetailsViewModel:
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type:
          - string
          - 'null'
        forename:
          type:
          - string
          - 'null'
        surname:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
        phone:
          type:
          - string
          - 'null'
      additionalProperties: false
    Purplebricks.Viewings.Business.ViewModels.AddressViewModel:
      type: object
      properties:
        line1:
          type:
          - string
          - 'null'
        line2:
          type:
          - string
          - 'null'
        town:
          type:
          - string
          - 'null'
        county:
          type:
          - string
          - 'null'
        country:
          type:
          - string
          - 'null'
        postcode:
          type:
          - string
          - 'null'
      additionalProperties: false
    Purplebricks.Viewings.Business.Models.UserViewingDetail:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/Purplebricks.Viewings.Business.ViewModels.AddressViewModel'
        viewingDate:
          type: string
          format: date-time
        status:
          type:
          - string
          - 'null'
        isSales:
          type: boolean
        conductingAppointment:
          type:
          - string
          - 'null'
        viewingId:
          type: integer
          format: int32
        propertyId:
          type: integer
          format: int32
        viewer:
          $ref: '#/components/schemas/Purplebricks.Viewings.Business.ViewModels.EventUserDetailsViewModel'
        host:
          $ref: '#/components/schemas/Purplebricks.Viewings.Business.ViewModels.EventUserDetailsViewModel'
        seller:
          $ref: '#/components/schemas/Purplebricks.Viewings.Business.ViewModels.EventUserDetailsViewModel'
        bookedByUser:
          type: boolean
        userRole:
          type:
          - string
          - 'null'
      additionalProperties: false
    Purplebricks.Viewings.Business.Models.CreatioFeedbackDetail:
      type: object
      properties:
        viewingDate:
          type: string
          format: date-time
        address:
          $ref: '#/components/schemas/Purplebricks.Viewings.Business.ViewModels.AddressViewModel'
        isSales:
          type: boolean
        comments:
          type:
          - string
          - 'null'
        presentationScore:
          type:
          - integer
          - 'null'
          format: int32
        suitabilityScore:
          type:
          - integer
          - 'null'
          format: int32
        priceScore:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Authorization header using Bearer scheme
      name: Authorization
      in: header
x-refined-from:
- purplebricks-property-v1-openapi.yml
- purplebricks-valuations-v1-openapi.yml
- purplebricks-viewings-v1-openapi.yml