Purplebricks

Purplebricks Outlook Sync API

Agent-facing microservice that reads and toggles Outlook calendar synchronisation for a local property expert. The only Purplebricks API path disclosed in robots.txt, and the thread that led to the rest of the publicly-served Swagger estate.

GitHub OpenAPI

Documentation

📖
APIReference
https://api.purplebricks.co.uk/outlook-api/swagger/index.html
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/purplebricks/refs/heads/main/authentication/purplebricks-authentication.yml

Specifications

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

Other Resources

🔗
SwaggerUI
https://api.purplebricks.co.uk/outlook-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
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/purplebricks/refs/heads/main/overlays/purplebricks-outlook-v1-overlay.yaml

OpenAPI Specification

purplebricks-outlook-v1-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Purplebricks.Microservice.Outlook.Api 1.0 - Squad Agents and Intel
  description: '### API for managing syncing appointments to their Outlook calendar

    ### [Purplebricks.Microservice.Outlook.Api Git Repository](https://dev.azure.com/purplebricks/BackEnd/_git/purplebricks-outlook)'
  version: '1.0'
paths:
  /v1/agent/outlook-sync:
    get:
      tags:
      - AgentOutlookSync
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - AgentOutlookSync
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/PutRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/PutRequest'
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '201':
          description: Success
        '204':
          description: Success
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    Model:
      type: object
      properties:
        agentPublicUserId:
          type: string
          format: uuid
        enabled:
          type: boolean
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
        status:
          type: integer
          format: int32
          nullable: true
        detail:
          type: string
          nullable: true
        instance:
          type: string
          nullable: true
      additionalProperties: {}
    PutRequest:
      type: object
      properties:
        enabled:
          type: boolean
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Authorization header using Bearer scheme
      name: Authorization
      in: header
security:
- Bearer: []