{"id":504,"date":"2019-09-02T09:14:34","date_gmt":"2019-09-02T09:14:34","guid":{"rendered":"https:\/\/www.marketplacedoc.onoffice.de\/api-calls\/"},"modified":"2026-01-29T14:47:43","modified_gmt":"2026-01-29T13:47:43","slug":"api-calls","status":"publish","type":"page","link":"https:\/\/www.marketplacedoc.onoffice.de\/en\/api-calls\/","title":{"rendered":"API calls"},"content":{"rendered":"\n<style type=\"text\/css\" data-created_by=\"avia_inline_auto\" id=\"style-css-av-5ays-dfee786cbc446d94fc0b910afc3f3657\">\n.flex_column.av-5ays-dfee786cbc446d94fc0b910afc3f3657{\nborder-radius:0px 0px 0px 0px;\npadding:0px 0px 0px 0px;\n}\n<\/style>\n<div  class='flex_column av-5ays-dfee786cbc446d94fc0b910afc3f3657 av_one_full  avia-builder-el-0  avia-builder-el-no-sibling  first flex_column_div av-zero-column-padding  '     ><section  class='av_textblock_section av-jyo5jo6y-7fdfe14620fb853956df7dc43a8d39d0 '   itemscope=\"itemscope\" itemtype=\"https:\/\/schema.org\/CreativeWork\" ><div class='avia_textblock'  itemprop=\"text\" ><h1><em>API calls<\/em><\/h1>\n<\/div><\/section><br \/>\n\n<style type=\"text\/css\" data-created_by=\"avia_inline_auto\" id=\"style-css-av-jyo5ggp9-29082c61daedccf442914cdf0871af9c\">\n#top .hr.hr-invisible.av-jyo5ggp9-29082c61daedccf442914cdf0871af9c{\nheight:5px;\n}\n<\/style>\n<div  class='hr av-jyo5ggp9-29082c61daedccf442914cdf0871af9c hr-invisible  avia-builder-el-2  el_after_av_textblock  el_before_av_textblock '><span class='hr-inner '><span class=\"hr-inner-style\"><\/span><\/span><\/div><br \/>\n<section  class='av_textblock_section av-jyo5jo6y-1-1765f278b3371be3c6c28a9f539d8c2c '   itemscope=\"itemscope\" itemtype=\"https:\/\/schema.org\/CreativeWork\" ><div class='avia_textblock'  itemprop=\"text\" ><p>The official documentation for the onOffice API can be found at <a href=\"https:\/\/apidoc.onoffice.de\/\" target=\"_blank\" rel=\"noopener\">apidoc.onoffice.de<\/a>.<\/p>\n<p>Do you have questions about the API or need help? If so, please contact API Support at <a href=\"mailto:apisupport@onoffice.de\">apisupport@onoffice.de.<\/a><\/p>\n<p>For specific questions about the Marketplace, please contact us at<a href=\"mailto:marketplace-dev@onoffice.de\"> marketplace-dev@onoffice.de.<\/a><\/p>\n<h4>API calls<\/h4>\n<p>Some API calls are required specifically for the Marketplace:<\/p>\n<ul>\n<li><a href=\"https:\/\/apidoc.onoffice.de\/index.php\/marketplace\/unlock-marketplace-provider\/\" target=\"_blank\" rel=\"noopener\">Activation of a provider<\/a><\/li>\n<li><a href=\"https:\/\/apidoc.onoffice.de\/index.php\/actions\/datensatz-lesen\/read-basic-settings\/\" target=\"_blank\" rel=\"noopener\">CI colors and logo<\/a><\/li>\n<li><a href=\"https:\/\/apidoc.onoffice.de\/index.php\/marketplace\/get-marketplace-invoice-recipient\/\" target=\"_blank\" rel=\"noopener\">Data of the invoice recipient<\/a><\/li>\n<li><a href=\"https:\/\/apidoc.onoffice.de\/index.php\/cancel-subscription\/\" target=\"_blank\" rel=\"noopener\">Cancel subscriptions<\/a><\/li>\n<li><a href=\"https:\/\/apidoc.onoffice.de\/index.php\/actions\/datensatz-lesen\/user-photo\/\" target=\"_blank\" rel=\"noopener\">Read user photos<\/a><\/li>\n<li><a href=\"https:\/\/apidoc.onoffice.de\/marketplace\/refund-transaction\/\" target=\"_blank\" rel=\"noopener\">Cancel transaction<\/a><\/li>\n<li><a href=\"https:\/\/apidoc.onoffice.de\/marketplace\/generate-subsequent-payment-link\/\" target=\"_blank\" rel=\"noopener\">Generate post payment link<\/a><\/li>\n<\/ul>\n<h4 id=\"Benutzer\">API user \/ parameter extendedclaim<\/h4>\n<p>In each customer version, your API user is present so that you can have read and write access to your customers&#8217; onOffice enterprise version. This is created automatically when the customer activates their service.<\/p>\n<p>The user rights (e.g. which properties or addresses he is allowed to read) of the customer ordering in your store must be respected by your API user. So your API user cannot request more data and perform more actions than the set rights of the client allow.<\/p>\n<p>Therefore, each time the customer calls your service, an &#8220;apiClaim&#8221; parameter is passed to you. Afterwards you have to return this &#8220;apiclaim&#8221; as parameter &#8220;extendedclaim&#8221; for all API calls. This is to ensure that the transfer of the user ID and the customer version is verified. Please use the &#8220;apiClaim&#8221; from the customer&#8217;s latest service call. The validity of the &#8220;apiClaim&#8221; will be limited in time in the future. Therefore it is not sufficient to always work with the same &#8220;apiClaim&#8221;.<\/p>\n<p>The &#8220;extendedclaim&#8221; during unlocking is only valid during unlocking and not for the service calls after activation.<br \/>\nDo not use any other calls during unlocking except <a href=\"https:\/\/apidoc.onoffice.de\/marketplace\/unlock-marketplace-provider\/\">unlockProvider<\/a>. After activating the service, you can retrieve the required data via API.<\/p>\n<p>This parameter will soon be mandatory in the context of the Marketplace. Set this parameter if you use API calls within the Marketplace. The parameter must be set for all API calls listed on <a href=\"https:\/\/apidoc.onoffice.de\/\" target=\"_blank\" rel=\"noopener\">apidoc.onoffice.de<\/a> . Please include this parameter in your API calls as soon as possible.<\/p>\n<p><strong>You can find an API example with the extendedclaim parameter <a href=\"https:\/\/apidoc.onoffice.de\/marketplace\/\">here<\/a>.<\/strong><\/p>\n<hr \/>\n<p>In addition to the API users in the customer versions, there are also &#8220;normal&#8221; API users with which you can query information from your vendor version. For more information on creating and setting API users, see the <a href=\"https:\/\/apidoc.onoffice.de\/api-benutzer-anlegen\/\" target=\"_blank\" rel=\"noopener\">API documentation<\/a> and <a href=\"https:\/\/de.enterprisehilfe.onoffice.com\/category\/zusatzmodule\/api-modul\/\" target=\"_blank\" rel=\"noopener\">online help<\/a>.<\/p>\n<h4>API versions<\/h4>\n<p>There are 2 API versions, latest and stable. It is at your discretion whether to use stable or latest. The stable version is updated monthly on the first Tuesday of the month. The latest version is updated 2x a week, and becomes stable on the first Tuesday of the next month. In the initial phase of the marketplace, when a lot is still changing and direct testing is required, latest makes more sense. Later stable makes more sense because then errors in the API are less likely.<\/p>\n<p>The request URI for the &#8220;latest&#8221; API version is <a href=\"https:\/\/api.onoffice.de\/api\/latest\/api.php\">https:\/\/api.onoffice.de\/api\/latest\/api.php<\/a><\/p>\n<p>The request URI for the &#8220;stable&#8221; API version, which is updated monthly, is <a href=\"https:\/\/api.onoffice.de\/api\/stable\/api.php\">https:\/\/api.onoffice.de\/api\/stable\/api.php<\/a><\/p>\n<p>If you are using a live client, it is automatically redirected to the stable API version, regardless of the set API version.<br \/>\nIf you are using a beta client, it will be automatically redirected to the latest API version, regardless of the set API version.<\/p>\n<h4><strong>Multilingual properties<\/strong><\/h4>\n<p>If you want your service to work with <a href=\"https:\/\/de.enterprisehilfe.onoffice.com\/help_entries\/mehrsprachige-immobilien\/\">multilingual properties<\/a> and function correctly, please note the following information when reading and writing multilingual properties: If your customer calls your service from a multilingual property, then in addition to the property ID <code>estateid<\/code> the parameter<code>language<\/code> is passed to you. You can then use <code>estateid<\/code> and <code>language<\/code> to read the required values from a multilingual property via the API call<a href=\"https:\/\/apidoc.onoffice.de\/index.php\/actions\/datensatz-lesen\/objekte\/\"> &#8220;Read property<\/a>&#8221; and write the required values back to multilingual properties via the API call <a href=\"https:\/\/apidoc.onoffice.de\/index.php\/actions\/datensatz-bearbeiten\/objekte\/\">&#8220;Edit property<\/a>&#8220;. <code>estateid<\/code> is specified in the API as <code>resourceid<\/code> , <code>language<\/code> as <code>estatelanguage<\/code> . Without specifying the parameter <code>estatelanguage<\/code> would be written to the wrong language version of the property.<\/p>\n<h4>NOTE<\/h4>\n<p>The API calls for the Marketplace can still change sometimes. In the vast majority of cases, the changes remain downward compatible, e.g. new parameters are added. Please be prepared for this and build your interface accordingly flexible and fault tolerant.<\/p>\n<\/div><\/section><\/p><\/div>\n","protected":false},"excerpt":{"rendered":"","protected":false},"author":4,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"footnotes":""},"class_list":["post-504","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v27.5 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>API calls - onOffice Marketplace<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.marketplacedoc.onoffice.de\/en\/api-calls\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"API calls - onOffice Marketplace\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.marketplacedoc.onoffice.de\/en\/api-calls\/\" \/>\n<meta property=\"og:site_name\" content=\"onOffice Marketplace\" \/>\n<meta property=\"article:modified_time\" content=\"2026-01-29T13:47:43+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/en\\\/api-calls\\\/\",\"url\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/en\\\/api-calls\\\/\",\"name\":\"API calls - onOffice Marketplace\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/#website\"},\"datePublished\":\"2019-09-02T09:14:34+00:00\",\"dateModified\":\"2026-01-29T13:47:43+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/en\\\/api-calls\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/en\\\/api-calls\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/en\\\/api-calls\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/en\\\/homepage\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API calls\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/#website\",\"url\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/\",\"name\":\"onOffice Marketplace\",\"description\":\"Dokumentation\",\"publisher\":{\"@id\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/#organization\",\"name\":\"onOffice GmbH\",\"url\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/wp-content\\\/uploads\\\/2019\\\/07\\\/onOffice-Logo.png\",\"contentUrl\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/wp-content\\\/uploads\\\/2019\\\/07\\\/onOffice-Logo.png\",\"width\":209,\"height\":72,\"caption\":\"onOffice GmbH\"},\"image\":{\"@id\":\"https:\\\/\\\/www.marketplacedoc.onoffice.de\\\/#\\\/schema\\\/logo\\\/image\\\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"API calls - onOffice Marketplace","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.marketplacedoc.onoffice.de\/en\/api-calls\/","og_locale":"en_US","og_type":"article","og_title":"API calls - onOffice Marketplace","og_url":"https:\/\/www.marketplacedoc.onoffice.de\/en\/api-calls\/","og_site_name":"onOffice Marketplace","article_modified_time":"2026-01-29T13:47:43+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.marketplacedoc.onoffice.de\/en\/api-calls\/","url":"https:\/\/www.marketplacedoc.onoffice.de\/en\/api-calls\/","name":"API calls - onOffice Marketplace","isPartOf":{"@id":"https:\/\/www.marketplacedoc.onoffice.de\/#website"},"datePublished":"2019-09-02T09:14:34+00:00","dateModified":"2026-01-29T13:47:43+00:00","breadcrumb":{"@id":"https:\/\/www.marketplacedoc.onoffice.de\/en\/api-calls\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.marketplacedoc.onoffice.de\/en\/api-calls\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.marketplacedoc.onoffice.de\/en\/api-calls\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.marketplacedoc.onoffice.de\/en\/homepage\/"},{"@type":"ListItem","position":2,"name":"API calls"}]},{"@type":"WebSite","@id":"https:\/\/www.marketplacedoc.onoffice.de\/#website","url":"https:\/\/www.marketplacedoc.onoffice.de\/","name":"onOffice Marketplace","description":"Dokumentation","publisher":{"@id":"https:\/\/www.marketplacedoc.onoffice.de\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.marketplacedoc.onoffice.de\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.marketplacedoc.onoffice.de\/#organization","name":"onOffice GmbH","url":"https:\/\/www.marketplacedoc.onoffice.de\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.marketplacedoc.onoffice.de\/#\/schema\/logo\/image\/","url":"https:\/\/www.marketplacedoc.onoffice.de\/wp-content\/uploads\/2019\/07\/onOffice-Logo.png","contentUrl":"https:\/\/www.marketplacedoc.onoffice.de\/wp-content\/uploads\/2019\/07\/onOffice-Logo.png","width":209,"height":72,"caption":"onOffice GmbH"},"image":{"@id":"https:\/\/www.marketplacedoc.onoffice.de\/#\/schema\/logo\/image\/"}}]}},"_links":{"self":[{"href":"https:\/\/www.marketplacedoc.onoffice.de\/en\/wp-json\/wp\/v2\/pages\/504","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.marketplacedoc.onoffice.de\/en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.marketplacedoc.onoffice.de\/en\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.marketplacedoc.onoffice.de\/en\/wp-json\/wp\/v2\/users\/4"}],"replies":[{"embeddable":true,"href":"https:\/\/www.marketplacedoc.onoffice.de\/en\/wp-json\/wp\/v2\/comments?post=504"}],"version-history":[{"count":13,"href":"https:\/\/www.marketplacedoc.onoffice.de\/en\/wp-json\/wp\/v2\/pages\/504\/revisions"}],"predecessor-version":[{"id":1636,"href":"https:\/\/www.marketplacedoc.onoffice.de\/en\/wp-json\/wp\/v2\/pages\/504\/revisions\/1636"}],"wp:attachment":[{"href":"https:\/\/www.marketplacedoc.onoffice.de\/en\/wp-json\/wp\/v2\/media?parent=504"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}