Get sync config - Integrations by Commenda

Get sync config

curl --request GET \
  --url https://api.integrations.commenda.io/v4/core/organizations/sync-config \
  --header 'api_key: <api-key>'

import requests

url = "https://api.integrations.commenda.io/v4/core/organizations/sync-config"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://api.integrations.commenda.io/v4/core/organizations/sync-config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.integrations.commenda.io/v4/core/organizations/sync-config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.integrations.commenda.io/v4/core/organizations/sync-config"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.integrations.commenda.io/v4/core/organizations/sync-config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "syncConfig": [
    {
      "enabled": true,
      "scopeAccess": {
        "READ": true,
        "CREATE": true,
        "UPDATE": true,
        "DELETE": true
      },
      "interval": 123,
      "syncFrom": {},
      "isOverridden": true,
      "isChild": true
    }
  ]
}

GET

/

v4

/

core

/

organizations

/

sync-config

Get sync config

curl --request GET \
  --url https://api.integrations.commenda.io/v4/core/organizations/sync-config \
  --header 'api_key: <api-key>'

import requests

url = "https://api.integrations.commenda.io/v4/core/organizations/sync-config"

headers = {"api_key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {api_key: '<api-key>'}};

fetch('https://api.integrations.commenda.io/v4/core/organizations/sync-config', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.integrations.commenda.io/v4/core/organizations/sync-config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.integrations.commenda.io/v4/core/organizations/sync-config"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.integrations.commenda.io/v4/core/organizations/sync-config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "syncConfig": [
    {
      "enabled": true,
      "scopeAccess": {
        "READ": true,
        "CREATE": true,
        "UPDATE": true,
        "DELETE": true
      },
      "interval": 123,
      "syncFrom": {},
      "isOverridden": true,
      "isChild": true
    }
  ]
}

Authorizations

api_key

string

header

required

Your Commenda Integrations API key, sent in the api_key header.

Query Parameters

integration_type

enum<string>

Available options:

BUSY,

CLEARBOOKS,

FREEAGENT,

FRESHBOOKS,

KASHFLOW,

MEKARI_JURNAL,

MS_DYNAMICS_365,

MS_DYNAMICS_365_FO,

MYOB_BUSINESS,

NETSUITE,

ODOO_ACCOUNTING,

QOYOD,

QUICKBOOKS,

QUICKBOOKS_SANDBOX,

ROOTFI_SANDBOX,

SAGE_CLOUD_ACCOUNTING,

SAGE_ZA_CLOUD_ACCOUNTING,

SAGE_INTACCT,

TALLY,

WAFEQ,

WAVE,

XERO,

ZOHO_BOOKS,

PUZZLE_SANDBOX,

PUZZLE,

RILLET,

RILLET_SANDBOX,

AMAZON,

BIG_COMMERCE,

SHOPIFY,

SQUARESPACE,

WIX,

WOO_COMMERCE,

GOOGLE_PLAYSTORE,

CHARGEBEE,

MOLLIE,

PAYPAL,

PAYPAL_SANDBOX,

RAZORPAY,

SQUARE,

SQUARE_SANDBOX,

STRIPE,

STRIPE_TEST,

STRIPE_SANDBOX,

ZOHO_INVOICE,

PADDLE,

PADDLE_SANDBOX,

HUBSPOT,

PIPEDRIVE,

SALES_FORCE,

ZOHO_CRM,

GUSTO

Example:

"QUICKBOOKS"

Response

200 - application/json

syncConfig

object[]

required

Show child attributes

Update sync config