Purplebricks

Purplebricks Step API

The Step API from Purplebricks — 2 operation(s) for step.

Documentation GitHub OpenAPI

Operations 2

GET /v1/step/canmove

POST /v1/step/move

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-step-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

openapi: 3.2.0
info:
  title: Purplebricks Workflow API 1.0 - Platform Step API
  description: '### The new home for accessing the workflow service library

    ### [Purplebricks Workflow API Git Repository](https://purplebricks@dev.azure.com/purplebricks/Purplebricks/_git/workflow-api)'
  version: '1.0'
servers:
- url: https://api.purplebricks.co.uk/workflow
security:
- Bearer: []
tags:
- name: Step
paths:
  /v1/step/canmove:
    get:
      tags:
      - Step
      parameters:
      - name: propertyId
        in: query
        schema:
          type: integer
          format: int32
      - name: type
        in: query
        schema:
          $ref: '#/components/schemas/WorkflowStepType'
      responses:
        '200':
          description: Success
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                type: integer
                format: int32
            application/json:
              schema:
                type: integer
                format: int32
            text/json:
              schema:
                type: integer
                format: int32
        '409':
          description: Conflict
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /v1/step/move:
    post:
      tags:
      - Step
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MoveToStepRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/MoveToStepRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/MoveToStepRequest'
      responses:
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/MoveToStepResult'
            application/json:
              schema:
                $ref: '#/components/schemas/MoveToStepResult'
            text/json:
              schema:
                $ref: '#/components/schemas/MoveToStepResult'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                type: integer
                format: int32
            application/json:
              schema:
                type: integer
                format: int32
            text/json:
              schema:
                type: integer
                format: int32
        '409':
          description: Conflict
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/WorkflowStepType'
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowStepType'
            text/json:
              schema:
                $ref: '#/components/schemas/WorkflowStepType'
components:
  schemas:
    MoveToStepRequest:
      required:
      - propertyId
      - type
      - userId
      type: object
      properties:
        propertyId:
          type: integer
          format: int32
        type:
          $ref: '#/components/schemas/WorkflowStepType'
        userId:
          type: integer
          format: int32
        impersonationUserId:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    MoveToStepResult:
      type: object
      properties:
        success:
          type: boolean
        stepTypeMovedTo:
          $ref: '#/components/schemas/WorkflowStepType'
      additionalProperties: false
    WorkflowStepType:
      enum:
      - Create
      - BookValuation
      - Valuation
      - Instruct
      - CreateAdvert
      - RejectAdvert
      - AmendAdvert
      - ApproveAdvert
      - SchedulePendingRegCert
      - Schedule
      - PublishPendingRegCert
      - Publish
      - Withdraw
      - Suspend
      - SuspendByUser
      - SuspendAccount
      - UnderOffer
      - SoldSubjectToContract
      - LetSubjectToContract
      - DeclineOffer
      - UpdateProperty
      - AcceptableOffer
      - ApplicationReceived
      - AcceptableOfferNotMarketed
      - WithdrawOffer
      - UpdateAdvert
      - ApprovePhoto
      - ContractsExchanged
      - Completion
      - SchedulePendingContract
      - PublishPendingContract
      - UpdatePropertyDiary
      - ContractsExchangedCoolingOffPeriod
      - ForceSold
      - ForceSoldSubjectToContract
      - ForceContractsExchanged
      - ForceCompletion
      - SoldSubjectToEscrow
      - PendingEscrow
      - Closing
      - ForceAcceptableOffer
      - ForceAcceptableOfferNotMarketed
      - ForceContractsExchangedCoolingOffPeriod
      - InstantValuation
      - FakeValuation
      - Cancelled
      type: string
    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: {}
  securitySchemes:
    Bearer:
      type: apiKey
      description: Authorization header using Bearer scheme
      name: Authorization
      in: header