Get Company

Retrieve a single company from the database.

GET /core/companies/{company_id}

Get Company

cURL

curl --request GET \
  --url https://api.rootfi.dev/v3/core/companies/{company_id} \
  --header 'api_key: <api-key>'

import requests

url = "https://api.rootfi.dev/v3/core/companies/{company_id}"

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.rootfi.dev/v3/core/companies/{company_id}', 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.rootfi.dev/v3/core/companies/{company_id}",
  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.rootfi.dev/v3/core/companies/{company_id}"

	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.rootfi.dev/v3/core/companies/{company_id}")
  .header("api_key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootfi.dev/v3/core/companies/{company_id}")

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": {
    "rootfi_id": 123,
    "rootfi_created_at": "2023-11-07T05:31:56Z",
    "rootfi_updated_at": "2023-11-07T05:31:56Z",
    "name": "Rootfi",
    "partner_id": "<string>",
    "invite_link": {
      "rootfi_id": 123,
      "rootfi_created_at": "2023-11-07T05:31:56Z",
      "rootfi_updated_at": "2023-11-07T05:31:56Z",
      "invite_link_id": "1",
      "integrations": [],
      "integration_categories": []
    },
    "connections": [
      {
        "rootfi_id": 123,
        "rootfi_created_at": "2023-11-07T05:31:56Z",
        "rootfi_updated_at": "2023-11-07T05:31:56Z",
        "rate_limits": {
          "counters": {},
          "lastReset": {},
          "maxLimits": {}
        },
        "zoho_sub_calls_enabled": false,
        "sync_resume_at": "2023-11-07T05:31:56Z",
        "last_synced": "2023-11-07T05:31:56Z",
        "tally_last_active_at": "2023-11-07T05:31:56Z",
        "sync_config": {
          "enabled": true,
          "interval": 1,
          "scope_access": {
            "READ": true,
            "CREATE": true,
            "UPDATE": true,
            "DELETE": true
          },
          "sync_from": "2023-11-07T05:31:56Z",
          "custom_fields": [
            "<string>"
          ]
        }
      }
    ],
    "activity_log": [
      {
        "rootfi_id": 123,
        "rootfi_created_at": "2023-11-07T05:31:56Z",
        "rootfi_updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}

Authorizations

api_key · string · header · required

Path Parameters

company_id · integer · required

The ID of the company to retrieve

Response

200

application/json

The data of the company endpoint

data · coreCompanyData · object · required

The data of the company endpoint

Show child attributes