List

List

curl --request GET \
  --url https://api.integrations.commenda.io/v4/core/companies/{companyId}/syncs \
  --header 'api_key: <api-key>'

import requests

url = "https://api.integrations.commenda.io/v4/core/companies/{companyId}/syncs"

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/companies/{companyId}/syncs', 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/companies/{companyId}/syncs",
  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/companies/{companyId}/syncs"

	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/companies/{companyId}/syncs")

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

{
  "data": {
    "syncs": [
      {
        "id": "<string>",
        "companyId": 123,
        "dataModels": [],
        "fullSync": true,
        "jobCounts": {
          "total": 123,
          "success": 123,
          "failed": 123,
          "running": 123,
          "pending": 123
        },
        "dataModelCounts": {
          "total": 123,
          "success": 123,
          "failed": 123,
          "running": 123,
          "pending": 123
        },
        "startTime": "2023-11-07T05:31:56Z",
        "endTime": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "count": 123,
    "next": "<string>"
  },
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

GET

core

companies

{companyId}

syncs

List

curl --request GET \
  --url https://api.integrations.commenda.io/v4/core/companies/{companyId}/syncs \
  --header 'api_key: <api-key>'

import requests

url = "https://api.integrations.commenda.io/v4/core/companies/{companyId}/syncs"

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/companies/{companyId}/syncs', 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/companies/{companyId}/syncs",
  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/companies/{companyId}/syncs"

	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/companies/{companyId}/syncs")

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

{
  "data": {
    "syncs": [
      {
        "id": "<string>",
        "companyId": 123,
        "dataModels": [],
        "fullSync": true,
        "jobCounts": {
          "total": 123,
          "success": 123,
          "failed": 123,
          "running": 123,
          "pending": 123
        },
        "dataModelCounts": {
          "total": 123,
          "success": 123,
          "failed": 123,
          "running": 123,
          "pending": 123
        },
        "startTime": "2023-11-07T05:31:56Z",
        "endTime": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "count": 123,
    "next": "<string>"
  },
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

api_key

string

header

required

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

Path Parameters

companyId

number

required

Query Parameters

limit

number

default:20

Required range: 1 <= x <= 100

cursor

string

jobType

enum<string>

Available options:

PUSH,

PULL,

CUSTOM

Response

200 - application/json

Paginated list of syncs for the company.

data

object

required

Show child attributes

request_id

string<uuid>

required

Trigger

List

General

Server Side SDKs

Core

Unified API

Authorizations

Path Parameters

Query Parameters

Response