Skip to content
onOffice API

onOffice API

Documentation

  • Introduction
  • First Steps / API connection
  • API Structure and General Information
    • Terminology
    • Create API User
    • Generate Access Tokens
    • General information / FAQ
    • Errors
    • onOffice API Request
      • Structure
      • Request elements
        • Root element
        • Request
        • Actions
        • Action
    • onOffice API Response
      • Structure
      • Response elements
        • Root element
        • Status
        • Response
        • Results
        • Result
        • Data
        • Records
        • Record
        • Elements
  • API calls sorted by module
    • Estates
      • Read Estates
      • Create Estates
      • Modify Estates
      • Do Generation of PDF exposés
      • Get Estate files
      • Get Estate images published on Homepage
      • Modify Estate Files
        Modify meta data of estate files
      • Delete Estate Files
      • Get Estate Filter
      • Create Estate Working list
      • Get Selling price offer
      • Do Selling price offer
      • Get Estate tracking details
      • Do Create an Estate tracking account
      • Get Estate categories
      • Get Search for Estates (Quick Search for Estate address, Owner and external Estate number)
      • Get Tenant / Buyer seeker (Immomatching)
    • Addresses
      • Read Addresses
      • Create Addresses
      • Modify Addresses
      • Get Search Addresses
      • Get Address files
      • Get Download Address files
      • Delete Address Files
      • Get Address Filter
      • Create Address Working list
      • Get Address completion fields
      • Do Send Address completion
      • Do Newsletter registration
      • Get Single- and multiselect values of address fields
    • Search Criteria
      • Get Search criteria
      • Create Search criteria
      • Modify Search criteria
      • Delete Search criteria
      • Get Search criteria fields
      • Get Search for suitable Search criteria
    • Agents log / Activities
      • Read Agents log / Activities
      • Create Agents log / Activities
      • Delete Agents log Files
    • Appointments
      • Read Appointments
      • Create Appointments
      • Modify Appointments
      • Delete Appointments
      • Do Send Appointment confirmation
      • Get Calendar resources
    • Tasks
      • Read Tasks
      • Create Tasks
      • Modify Tasks
      • Delete Task Files
    • Relations
      Links data records from different modules with each other
      • Relations diagram
      • Get Relations
      • Create Relations
      • Modify Relations
      • Delete Relations
    • Files and Templates
      • Do File upload
        Files for estates, addresses, tasks and agents log can be uploaded
      • Get Templates
      • Get Default attachments
    • Emails
      • Do Send Email
      • Get Email Links (deprecated)
      • Get Email Info
      • Do Email links
      • Get Mail signature
    • Settings
      • Read Basic settings
      • Read Imprint
      • Get Groups
      • Read User
      • Get Users
      • Read User photo
      • Read User rights
      • Get Field Configuration
      • Get Multiselect Configuration
      • Get Kind of action and Type of action
      • Get Regions
      • Get Regions Live Search
      • Do Access Control (data record rights stamp)
    • Miscellaneous
      • Read Records last seen
      • Get macro resolve
        Macros for estates, addresses, appointments and agents log can be resolved
      • Read log entries
      • Get Survey
      • Modify Timetracking
      • Get link
        Get URLs of detail views for editing estates, addresses and activities
    • Marketplace
      • Do Unlock marketplace provider
      • Get marketplace invoice recipient
      • Do Cancel subscription
      • Do Generate subsequent payment link
      • Do Refund transaction
      • Do Execute Webhooks
  • API calls sorted by action and action IDs
    • Read record
    • Create record
    • Modify record
    • Delete record
    • Request information
    • Perform actions
  • Various special topics
    • Multi-property module / property complexes
    • Multilingual estates
    • Identification of data sets via UUID
  • API news / RSS feed
    • API release news 12/23
    • API release news 01/24
    • API release news 03/24
    • API release news 05/24
    • API release news 06/24
    • API release news 07/24
    • API release news 08/24
    • API release news 09/24
    • API release news 10/24
    • API release news 11/24
  • Help / Technical Support

Need Support?

Technical Support for APIFeel free to contact us!

Request elements

  • Root element
  • Request
  • Actions
  • Action

onOffice GmbH © 2024
Imprint Privacy Settings