PropertyMe Scope: Properties API

openapi: 3.2.0
info:
  title: 'PropertyMe Scope: Properties API'
  version: '1.0'
servers:
- url: https://app.propertyme.com/api
tags:
- name: ' Scope: Properties'
paths:
  /v1/tenancies:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - ' Scope: Properties'
      summary: List of all tenancies
      description: The auth token must contain a scope of property:read.
      operationId: TenancyRequesttenancies_Get
      parameters:
      - name: ContactId
        in: query
        description: Id of the contact associated with the tenancies
        required: false
        schema:
          type: string
      - name: LotId
        in: query
        description: Id of the property associated with the tenancies
        required: false
        schema:
          type: string
      - name: HasOwnership
        in: query
        description: Flag indicating whether tenancy has an ownership
        required: false
        schema:
          type: boolean
      - name: IncludeClosed
        in: query
        description: Flag to include/exclude closed tenancies
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                title: List<TenancyApiData>
                type: array
                items:
                  $ref: '#/components/schemas/TenancyApiData'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                title: List<TenancyApiData>
                type: array
                items:
                  $ref: '#/components/schemas/TenancyApiData'
        '400':
          description: Invalid contact and/or lot id(s)
          content:
            application/json:
              schema:
                title: List<TenancyApiData>
                type: array
                items:
                  $ref: '#/components/schemas/TenancyApiData'
      deprecated: false
      security:
      - Bearer: []
  /v1/lots:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - ' Scope: Properties'
      summary: List all lots that have changed since a given timestamp
      description: The auth token must contain a scope of property:read.
      operationId: ChangedLotRequestlots_Get
      parameters:
      - name: Timestamp
        in: query
        description: Records returned will have a changed timestamp greater than this value
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                title: List<MobLotGridData>
                type: array
                items:
                  $ref: '#/components/schemas/MobLotGridData'
        '502':
          description: Timestamp value is not supplied
          content:
            application/json:
              schema:
                title: List<MobLotGridData>
                type: array
                items:
                  $ref: '#/components/schemas/MobLotGridData'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                title: List<MobLotGridData>
                type: array
                items:
                  $ref: '#/components/schemas/MobLotGridData'
      deprecated: false
      security:
      - Bearer: []
  /v1/tenancies/balances:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - ' Scope: Properties'
      summary: List of all tenancy balances
      description: The auth token must contain a scope of property:read.
      operationId: TenancyBalanceRequesttenanciesbalances_Get
      parameters:
      - name: ContactId
        in: query
        description: Id of the contact associated with the balance
        required: false
        schema:
          type: string
      - name: LotId
        in: query
        description: Id of the property associated with the balance
        required: false
        schema:
          type: string
      - name: LastUpdated
        in: query
        description: Only records updated on or after this last updated date time (UTC) will be included in the results set
        required: false
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                title: List<TenancyBalanceData>
                type: array
                items:
                  $ref: '#/components/schemas/TenancyBalanceData'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                title: List<TenancyBalanceData>
                type: array
                items:
                  $ref: '#/components/schemas/TenancyBalanceData'
        '400':
          description: Invalid contact and/or lot id(s)
          content:
            application/json:
              schema:
                title: List<TenancyBalanceData>
                type: array
                items:
                  $ref: '#/components/schemas/TenancyBalanceData'
      deprecated: false
      security:
      - Bearer: []
  /v1/lots/sales:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - ' Scope: Properties'
      summary: List of all lots describing active sales
      description: The auth token must contain a scope of property:read.
      operationId: LotActiveSalesRequestlotssales_Get
      parameters:
      - name: RentalOnly
        in: query
        description: Rental only
        required: false
        schema:
          type: boolean
      - name: Offset
        in: query
        description: The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
        required: true
        schema:
          type: integer
          format: int32
      - name: Limit
        in: query
        description: The maximum number of results to be returned. There may be less if the query returned less than the maximum.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                title: List<SalePropertyQueryData>
                type: array
                items:
                  $ref: '#/components/schemas/SalePropertyQueryData'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                title: List<SalePropertyQueryData>
                type: array
                items:
                  $ref: '#/components/schemas/SalePropertyQueryData'
        '400':
          description: Invalid value of offset or limit
          content:
            application/json:
              schema:
                title: List<SalePropertyQueryData>
                type: array
                items:
                  $ref: '#/components/schemas/SalePropertyQueryData'
      deprecated: false
      security:
      - Bearer: []
  /v1/lots/archived:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - ' Scope: Properties'
      summary: List of all lots described as archived lots
      description: The auth token must contain a scope of property:read.
      operationId: LotArchivedRequestlotsarchived_Get
      parameters:
      - name: ArchivedSince
        in: query
        description: Only records updated on or after this archived since date time (UTC) will be included in the results set
        required: false
        schema:
          type: string
          format: date-time
      - name: Offset
        in: query
        description: The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
        required: true
        schema:
          type: integer
          format: int32
      - name: Limit
        in: query
        description: The maximum number of results to be returned. There may be less if the query returned less than the maximum.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                title: List<LotGridData>
                type: array
                items:
                  $ref: '#/components/schemas/LotGridData'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                title: List<LotGridData>
                type: array
                items:
                  $ref: '#/components/schemas/LotGridData'
        '400':
          description: Invalid value of offset or limit
          content:
            application/json:
              schema:
                title: List<LotGridData>
                type: array
                items:
                  $ref: '#/components/schemas/LotGridData'
      deprecated: false
      security:
      - Bearer: []
  /v1/lots/{Id}:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - ' Scope: Properties'
      summary: Find a lot by id
      description: The auth token must contain a scope of property:read.
      operationId: LotRequestlotsId_Get
      parameters:
      - name: Id
        in: path
        description: Id of the lot
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Lot'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Lot'
      deprecated: false
      security:
      - Bearer: []
  /v1/lots/rentals:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - ' Scope: Properties'
      summary: List all rentals described as rentals
      description: The auth token must contain a scope of property:read.
      operationId: LotRentalsRequestlotsrentals_Get
      parameters:
      - name: Offset
        in: query
        description: The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
        required: true
        schema:
          type: integer
          format: int32
      - name: Limit
        in: query
        description: The maximum number of results to be returned. There may be less if the query returned less than the maximum.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                title: List<RentalLotQueryData>
                type: array
                items:
                  $ref: '#/components/schemas/RentalLotQueryData'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                title: List<RentalLotQueryData>
                type: array
                items:
                  $ref: '#/components/schemas/RentalLotQueryData'
        '400':
          description: Invalid value of offset or limit
          content:
            application/json:
              schema:
                title: List<RentalLotQueryData>
                type: array
                items:
                  $ref: '#/components/schemas/RentalLotQueryData'
      deprecated: false
      security:
      - Bearer: []
  /v1/lots/vacancy:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - ' Scope: Properties'
      summary: List of all lots described as vacant
      description: The auth token must contain a scope of property:read.
      operationId: LotVacantSalesRequestlotsvacancy_Get
      parameters:
      - name: RentalOnly
        in: query
        description: Rental only
        required: false
        schema:
          type: boolean
      - name: Offset
        in: query
        description: The number of rows to skip before beginning to return rows. An offset of 0 is the same as omitting the offset parameter.
        required: true
        schema:
          type: integer
          format: int32
      - name: Limit
        in: query
        description: The maximum number of results to be returned. There may be less if the query returned less than the maximum.
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                title: List<LotsQueryData>
                type: array
                items:
                  $ref: '#/components/schemas/LotsQueryData'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                title: List<LotsQueryData>
                type: array
                items:
                  $ref: '#/components/schemas/LotsQueryData'
        '400':
          description: Invalid value of offset or limit
          content:
            application/json:
              schema:
                title: List<LotsQueryData>
                type: array
                items:
                  $ref: '#/components/schemas/LotsQueryData'
      deprecated: false
      security:
      - Bearer: []
  /v1/tenancies/balances/{id}:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - ' Scope: Properties'
      summary: Find a tenancy balance record by Id
      description: The auth token must contain a scope of property:read.
      operationId: SingleTenancyBalanceRequesttenanciesbalancesid_Get
      parameters:
      - name: Id
        in: path
        description: Id of the tenancy balance record
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenancyBalanceData'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenancyBalanceData'
        '400':
          description: Invalid Id)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TenancyBalanceData'
      deprecated: false
      security:
      - Bearer: []
  /v1/lots/{Id}/comments:
    parameters:
    - $ref: '#/components/parameters/Accept'
    post:
      tags:
      - ' Scope: Properties'
      summary: Create a new comment for a given lot
      description: The auth token must contain a scope of property:write.
      operationId: AddLotCommentRequestlotsIdcomments_Post
      parameters:
      - name: Id
        in: query
        description: The id of the lot
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
        '400':
          description: Invalid lot id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
      deprecated: false
      security:
      - Bearer: []
      requestBody:
        content:
          application/json:
            schema: {}
        description: comment
  /v1/lots/{Id}/documents:
    parameters:
    - $ref: '#/components/parameters/Accept'
    post:
      tags:
      - ' Scope: Properties'
      summary: Create a new document for a given lot
      description: The auth token must contain a scope of property:write.
      operationId: AddLotDocumentRequestlotsIddocuments_Post
      parameters:
      - name: Id
        in: path
        description: Id of the lot
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
        '400':
          description: Invalid lot id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
      deprecated: false
      security:
      - Bearer: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddLotDocumentRequest'
  /v1/lots/{Id}/images:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - ' Scope: Properties'
      summary: List all images for a given lot
      description: The auth token must contain a scope of property:read.
      operationId: GetLotImageslotsIdimages_Get
      parameters:
      - name: Id
        in: path
        description: Id of the lot
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                title: List<QueryDocumentData>
                type: array
                items:
                  $ref: '#/components/schemas/QueryDocumentData'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                title: List<QueryDocumentData>
                type: array
                items:
                  $ref: '#/components/schemas/QueryDocumentData'
        '400':
          description: Invalid lot id
          content:
            application/json:
              schema:
                title: List<QueryDocumentData>
                type: array
                items:
                  $ref: '#/components/schemas/QueryDocumentData'
      deprecated: false
      security:
      - Bearer: []
  /v1/lots/{Id}/detail:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - ' Scope: Properties'
      summary: Find a lot by id
      description: The auth token must contain a scope of property:read.
      operationId: LotDetailRequestlotsIddetail_Get
      parameters:
      - name: Id
        in: path
        description: Id of the lot
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LotDetailApiResponse'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LotDetailApiResponse'
      deprecated: false
      security:
      - Bearer: []
  /v1/lots/{Id}/members:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - ' Scope: Properties'
      summary: Find a lot manager by lot id
      description: The auth token must contain a scope of property:read.
      operationId: LotManagerRequestlotsIdmembers_Get
      parameters:
      - name: Id
        in: path
        description: Id of the lot
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerMemberData'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomerMemberData'
      deprecated: false
      security:
      - Bearer: []
  /v1/dashboards/lots/{Type}:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - ' Scope: Properties'
      summary: Get dashboard item by type
      description: The auth token must contain a scope of property:read.
      operationId: LotDashboardRequestdashboardslotsType_Get
      parameters:
      - name: Type
        in: path
        description: 'The available dashboard type: AllProperties, Vacancies'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardResponse'
        '502':
          description: Dashboard type is not supplied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardResponse'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardResponse'
      deprecated: false
      security:
      - Bearer: []
  /v1/lots/{Id}/folio/documents:
    parameters:
    - $ref: '#/components/parameters/Accept'
    post:
      tags:
      - ' Scope: Properties'
      summary: Create a new document for a given owner or tenant
      description: The auth token must contain a scope of property:write.
      operationId: AddLotFolioDocumentRequestlotsIdfoliodocuments_Post
      parameters:
      - name: Id
        in: path
        description: Id of the lot
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
        '400':
          description: Invalid lot id or folio id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseBase'
      deprecated: false
      security:
      - Bearer: []
      requestBody:
        content:
          application/json:
            schema: {}
        description: Visible on the portal
        required: true
  /v1/lots/{Id}/alerts/{Type}:
    parameters:
    - $ref: '#/components/parameters/Accept'
    get:
      tags:
      - ' Scope: Properties'
      summary: List all contact alerts for a given lot by contact alert type
      description: The auth token must contain a scope of property:read.
      operationId: GetContactAlertsRequestlotsIdalertsType_Get
      parameters:
      - name: Id
        in: path
        description: Id of the contact
        required: true
        schema:
          type: string
      - name: Type
        in: path
        description: Contact alert type can be one of Property, Job and Inspection
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                title: List<ContactAlert>
                type: array
                items:
                  $ref: '#/components/schemas/ContactAlert'
        '500':
          description: An internal error has occurred
          content:
            application/json:
              schema:
                title: List<ContactAlert>
                type: array
                items:
                  $ref: '#/components/schemas/ContactAlert'
        '400':
          description: Invalid lot id or contact alert type
          content:
            application/json:
              schema:
                title: List<ContactAlert>
                type: array
                items:
                  $ref: '#/components/schemas/ContactAlert'
      deprecated: false
      security:
      - Bearer: []
components:
  schemas:
    TenancyBalanceData:
      title: TenancyBalanceData
      properties:
        FirstName:
          type: string
        LastName:
          type: string
        Salutation:
          type: string
        LotAddress:
          type: string
        LotReference:
          type: string
        ContactReference:
          type: string
        ContactEmail:
          type: string
        HomePhone:
          type: string
        WorkPhone:
          type: string
        CellPhone:
          type: string
        NormalisedMobilePhone:
          type: string
        FolioNumber:
          type: integer
          format: int32
        Code:
          type: string
        IsActive:
          type: boolean
        BondReceipted:
          type: number
          format: double
        Deposited:
          type: number
          format: double
        DirectDeposited:
          type: number
          format: double
        ArrearsDays:
          type: integer
          format: int32
        InvoiceDaysInArrears:
          type: integer
          format: int32
        InvoiceArrears:
          type: number
          format: double
        ClosedOn:
          type: string
          format: date-time
        ProrataRentDue:
          type: number
          format: double
        MostRentDue:
          type: number
          format: double
        RentDueByPeriod:
          type: number
          format: double
        TotalRentPaid:
          type: number
          format: double
        UnclearedBalance:
          type: number
          format: double
        PendingPayments:
          type: number
          format: double
        PendingRentPayments:
          type: number
          format: double
        PendingInvoicePayments:
          type: number
          format: double
        PendingDepositPayments:
          type: number
          format: double
        PendingBondPayments:
          type: number
          format: double
        MepayStatus:
          type: string
        ActiveOwnershipId:
          type: string
        HasActiveOwner:
          type: boolean
        ContactPersonCount:
          type: integer
          format: int32
        DaysInArrears:
          type: integer
          format: int32
        RentArrears:
          type: number
          format: double
        RentArrearsByPeriod:
          type: number
          format: double
        FolioId:
          type: string
        BondArrears:
          type: number
          format: double
        TotalArrears:
          type: number
          format: double
        TotalArrearsByPeriod:
          type: number
          format: double
        IsClosed:
          type: boolean
        Label:
          type: string
        SearchText:
          type: string
        Name:
          type: string
        Id:
          type: string
        CustomerId:
          type: string
        LotId:
          type: string
        ContactId:
          type: string
        TenancyStart:
          type: string
          format: date-time
        AgreementStart:
          type: string
          format: date-time
        AgreementEnd:
          type: string
          format: date-time
        Periodic:
          type: boolean
        TenancyEnd:
          type: string
          format: date-time
        Termination:
          type: string
          format: date-time
        BreakLease:
          type: string
          format: date-time
        Notes:
          type: string
        RentAmount:
          type: number
          format: double
        RentPeriod:
          type: string
        BondAmount:
          type: number
          format: double
        OpenBondReceived:
          type: number
          format: double
        BondReference:
          type: string
        BondInTrust:
          type: number
          format: double
        BankReference:
          type: string
        TaxOnRent:
          type: boolean
        GenerateRentInvoice:
          type: boolean
        RentInvoiceDaysInAdvance:
          type: integer
          format: int32
        ReceiptWarning:
          type: string
        NextIncreaseAmount:
          type: number
          format: double
        NextIncreaseDate:
          type: string
          format: date-time
        RentSequence:
          type: integer
          format: int32
        PaidTo:
          type: string
          format: date-time
        EffectivePaidTo:
          type: string
          format: date-time
        PartPaid:
          type: number
          format: double
        ProrataTo:
          type: string
          format: date-time
        AllowMepayPayments:
          type: boolean
        ReviewFrequency:
          type: integer
          format: int32
        NextReviewDate:
          type: string
          format: date-time
        LastReviewedOn:
          type: string
          format: date-time
        DirectDebit:
          type: boolean
        DirectDebitFixedAmount:
          type: number
          format: double
        DirectDebitFrequency:
          type: string
        NextDirectDebitDate:
          type: string
          format: date-time
        CreatedOn:
          type: string
          format: date-time
        UpdatedOn:
          type: string
          format: date-time
        ExcludeArrearsAutomation:
          type: boolean
        IsWaterUsageCharged:
          type: boolean
        BondDueDate:
          type: string
          format: date-time
      description: TenancyBalanceData
      type: object
    MobLotGridData:
      title: MobLotGridData
      properties:
        OwnerContactReference:
          type: string
        TenantContactReference:
          type: string
        RentAmount:
          type: number
          format: double
        RentPeriod:
          type: string
        TenancyStart:
          type: string
          format: date-time
        TenancyEnd:
          type: string
          format: date-time
        AgreementStart:
          type: string
          format: date-time
        AgreementEnd:
          type: string
          format: date-time
        OwnerContactId:
          type: string
        TenantContactId:
          type: string
        Vacant:
          type: boolean
        ManagerName:
          type: string
        EffectivePaidTo:
          type: string
          format: date-time
        OwnershipUpdatedOn:
          type: string
          format: date-time
        TenancyUpdatedOn:
          type: string
          format: date-time
        SaleAgreementUpdatedOn:
          type: string
          format: date-time
        StrataManagerContactName:
          type: string
        HasAccessDetails:
          type: boolean
        PetStatus:
          type: string
        Pets:
          type: integer
          format: int32
        PetDetails:
          type: string
        Reason:
          type: string
        Occupants:
          type: integer
          format: int32
        Leaseholders:
          type: integer
          format: int32
        AdditionalOccupants:
          type: integer
          format: int32
        Details:
          type: string
        Timestamp:
          type: integer
          format: int64
        PropertyType:
          type: string
        CommercialCategory:
          type: string
        Id:
          type: string
        CustomerId:
          type: string
        Reference:
          type: string
        Address:
          $ref: '#/components/schemas/AddressDetail'
        AddressText:
          type: string
        PrimaryType:
          type: string
        PropertySubtype:
          type: string

# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/propertyme/refs/heads/main/openapi/propertyme-scope-properties-api-openapi.yml