Skip to content
onOffice API
Documentation
Menu and widgets
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
Working list
Read record
Addresses
Agents log
Appointments
Estates
User
User photo
Tasks
Basic settings
Imprint
User rights
Records last seen
Edit record
Addresses
Estates
Search criteria
Files – deprecated
Files
Appointments
Tasks
Relations
Timetracking
Delete record
Search criteria
Files – deprecated
Files
Appointments
Relations
Request information
Search
Email links
Mail signature
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
Address files
Estate files
Get Survey
Get macro resolve
Get users
Get groups
Estate tracking details
Estate categories
Calendar resources
Default attachments
Number of log entries
Selling price offer
Download Address files
Single- and multiselect values of address fields
Perform actions
File upload
Send Email
Create Email links
Create an Estate tracking account
Send Address completion
Send Appointment confirmation
Newsletter registration
Execute Webhooks
Selling price offer
Send contact form
Marketplace
Unlock marketplace provider
Get marketplace invoice recipient
Cancel subscription
Generate subsequent payment link
Refund transaction
Multi-property module / property complexes
Multilingual estates
Identification of data sets via UUID
Help / Technical Support
Records
Contains record-specific results in an array.
record
