Purplebricks

Purplebricks Agent API

Small agent-experience service exposing team lookups for the local property experts who staff the Purplebricks model in place of high-street branches.

GitHub OpenAPI

Documentation

📖
APIReference
https://api.purplebricks.co.uk/agent-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-agent-v1-openapi.yml

Other Resources

🔗
SwaggerUI
https://api.purplebricks.co.uk/agent-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-agent-v1-overlay.yaml

OpenAPI Specification

purplebricks-agent-v1-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Purplebricks.Agent.Api 1.0 - Squad Agents Experience
  description: '### API agregating all agents specific functionality and endpoints

    ### [Purplebricks.Agent.Api Git Repository](https://dev.azure.com/purplebricks/BackEnd/_git/agents-mono)'
  version: '1.0'
servers:
- url: https:///agent
paths:
  /v1/team:
    get:
      tags:
      - Team
      parameters:
      - name: agentEmail
        in: query
        schema:
          type: string
      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/AgentTeam'
            application/json:
              schema:
                $ref: '#/components/schemas/AgentTeam'
            text/json:
              schema:
                $ref: '#/components/schemas/AgentTeam'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /v1/team/getagentmanager:
    get:
      tags:
      - Team
      parameters:
      - name: agentEmail
        in: query
        schema:
          type: string
      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/AgentTeamMember'
            application/json:
              schema:
                $ref: '#/components/schemas/AgentTeamMember'
            text/json:
              schema:
                $ref: '#/components/schemas/AgentTeamMember'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    AgentTeam:
      type: object
      properties:
        me:
          $ref: '#/components/schemas/AgentTeamMember'
        teamMembers:
          type: array
          items:
            $ref: '#/components/schemas/AgentTeamMember'
          nullable: true
      additionalProperties: false
    AgentTeamMember:
      type: object
      properties:
        activeDirectoryId:
          type: string
          nullable: true
        email:
          type: string
          nullable: true
        forename:
          type: string
          nullable: true
        surname:
          type: string
          nullable: true
        department:
          type: string
          nullable: true
        preferredLanguage:
          type: string
          nullable: true
        isManager:
          type: boolean
          readOnly: true
      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: {}
  securitySchemes:
    Bearer:
      type: apiKey
      description: Authorization header using Bearer scheme
      name: Authorization
      in: header
security:
- Bearer: []