Skip to content
onOffice API

onOffice API

Documentation

  • Introduction
  • Terminology
  • Create API User
  • Generate Access Tokens
  • First Steps
  • 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
  • Actions
    • Create record
      • Estates
      • Addresses
      • Search criteria
      • Agents log / Activities
      • Relations
      • Appointments
      • Tasks
    • Read record
      • Addresses
      • Agents log
      • Calendar (Appointment)
      • Estates
      • User
      • User photo
      • Tasks
      • Read basic settings
      • Read imprint
      • Read user rights
      • Messenger roomlist
      • Messenger chatroom participants
    • Edit record
      • Addresses
      • Estates
      • Search criteria
      • Files
      • Appointments
      • Tasks
      • Relations
    • Delete record
      • Search criteria
      • Files
      • Appointments
      • Relations
    • Request information
      • Search
      • Email links
      • Email & PDF exposé templates
      • Field Configuration
      • Kind of action and Type of action
      • Relations
      • Address completion fields
      • Search criteria
      • Search criteria fields
      • Search for suitable Search criteria
      • Regions Live Search
      • Tenant / Buyer seeker (Immomatching)
      • Search for Estates (Quick Search for Estate address, Owner and external Estate number)
      • Estate images published on Homepage
      • Regions
      • Generation of PDF exposés
      • Filter
      • Estate files
      • Messenger room messages
      • Get Survey
      • Get macro resolve
      • Get users
      • Get groups
      • Estate tracking details
      • Estate categories
      • Calendar resources
    • Perform actions
      • File upload
      • Send Email
      • Create Email links
      • Create an Estate tracking account
      • Send Address completion
      • Send Appointment confirmation
      • Newsletter registration
      • Send message to messenger room
      • Mark messenger room messages as read
  • Marketplace
    • Unlock marketplace provider
    • Get marketplace invoice recipient
    • Cancel subscription
    • Generate subsequent payment link
    • Refund transaction
  • internal API calls
  • Multi-property module / property complexes
  • Multilingual estates
  • Help / Technical Support
  • API Consulting

Need Support?

Technical Support for APIFeel free to contact us!

Request elements

  • Root element
  • Request
  • Actions
  • Action

onOffice GmbH © 2018
Imprint