Get

GET /v4/core/companies/{companyId}

Get

cURL

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

import requests

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

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}', 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}",
  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}"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.integrations.commenda.io/v4/core/companies/{companyId}")
  .header("api_key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

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

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

200

{
  "data": {
    "company": {
      "id": 123,
      "inviteLinkId": "<string>",
      "companyId": 123,
      "companyName": "<string>",
      "integrationEntityId": "<string>",
      "hasActiveSync": true,
      "lastSynced": "2023-11-07T05:31:56Z",
      "syncFrom": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "dataModelConfigs": [
        {
          "enabled": true,
          "scopeAccess": {
            "READ": true,
            "CREATE": true,
            "UPDATE": true,
            "DELETE": true
          },
          "interval": 123,
          "syncFrom": "<string>",
          "isOverridden": true,
          "isChild": true
        }
      ],
      "connection": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "companyId": 123,
        "organisationId": 123,
        "integrationEntityId": "<string>",
        "syncResumeAt": "2023-11-07T05:31:56Z",
        "lastSynced": "2023-11-07T05:31:56Z",
        "variables": {}
      }
    }
  },
  "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

Response

200 - application/json

The requested company.

data · object · required

Show child attributes

request_id · string<uuid> · required