Get company details using custom company ID

Return all information about a specified company.

GET

/companies-by-id/:company_id/

Data

Type

Description

company_id

string

Your company custom ID

curl -X GET -H "Authorization: Token <your_64_char_api_key>" "https://<your_app_subdomain>.user.com/api/public/companies-by-id/:company_id/"

Response

{
            "id": 1665,
            "name": "Company from API 1",
            "description": "Company created using API request",
            "email": "company@email.com",
            "country": "United States",
            "region": null,
            "city": "Beverly Hills",
            "address": null,
            "postal_code": "90210",
            "approx_employees": null,
            "created_at": "2017-07-06T15:32:10.090817Z",
            "updated_at": "2017-07-06T15:32:10.090843Z",
            "attributes": [
              {
                "id": 248896,
                "name": "company attribute",
                "name_std": "company_attribute",
                "value": "my value"
              },
              {
                "id": 248895,
                "name": "company attribute 2",
                "name_std": "company_attribute_2",
                "value": "my value"
              }
            ],
            "phone_numbers": [
                "13102990912",
                "123456789"
            ],
            "company_id": "<:company_id>"
}

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://<your_app_subdomain>.user.com/api/public/companies-by-id/:company_id/",
  "method": "GET",
  "headers": {
    "authorization": "Token <your_64_char_api_key>"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://<your_app_subdomain>.user.com/api/public/companies-by-id/:company_id/");
xhr.setRequestHeader("authorization", "Token <your_64_char_api_key>");

xhr.send(data);

var request = require("request");

var options = { method: 'GET',
  url: 'https://<your_app_subdomain>.user.com/api/public/companies-by-id/:company_id/',
  headers: { authorization: 'Token <your_64_char_api_key>' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://<your_app_subdomain>.user.com/api/public/companies-by-id/: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_POSTFIELDS => "",
  CURLOPT_HTTPHEADER => array(
    "authorization: Token <your_64_char_api_key>"
  ),
));

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

curl_close($curl);

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

import requests

url = "https://<your_app_subdomain>.user.com/api/public/companies-by-id/:company_id/"

payload = ""
headers = {'authorization': 'Token <your_64_char_api_key>'}

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

import http.client

conn = http.client.HTTPSConnection("<your_app_subdomain>.user.com")

payload = ""

headers = { 'authorization': "Token <your_64_char_api_key>" }

conn.request("GET", "/api/public/companies-by-id/:company_id/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))