View a Company

Example View Request and Response

cURL

$ curl \
-s https://api.intercom.io/companies?company_id=141 \
-H 'Authorization:Bearer <Your access token>' \
-H "Accept:application/json" \

cURL HTTP Response

HTTP/1.1 200 OK

{
  "type": "company",
  "id": "531ee472cce572a6ec000006",
  "name": "Blue Sun",
  "plan": {
    "type":"plan",
    "id":"1",
    "name":"Paid"
  },
  "company_id": "141",
  "remote_created_at": 1394531169,
  "created_at": 1394533506,
  "updated_at": 1396874658,
  "last_request_at": 1396874658,
  "monthly_spend": 49,
  "session_count": 26,
  "user_count": 10,
  "custom_attributes": {
    "paid_subscriber" : true,
    "team_mates": 0
  }
}

Ruby

intercom.companies.find(:id => "41e66f0313708347cb0000d0")

PHP

<?php
# Using the name of the company
$intercom->companies->getCompanies(['name' => 'OneAmerica']);

# Via company_id
$intercom->companies->getCompanies(['company_id' => '10']);

?>

Java

String id = "541a144b201ebf2ec5000001";
Company company = Company.find(id);

Each company has its own URL -

• https://api.intercom.io/companies/{id}

Where {id} is the value of the company's id field. This URL is the company's canonical address in the API.

Request Parameters

Parameter	Required	Description
name	no	The name of the company
company_id	no	The company_id you have given to the company

A company can also be fetched by its name using a name or company_id parameter in the url, whose values are the ones you have defined for that company -

• https://api.intercom.io/companies?name={name}
• https://api.intercom.io/companies?company_id={company_id}

The name parameter value should be url encoded when sending, as company names are allowed to have values that either need to be encoded as character data (e.g., whitespace) or are reserved characters (e.g., ':').