INintercom
Companies

Retrieve companies

Changed on

You can fetch a single company by passing in company_id or name.

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

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

You can fetch all companies and filter by segment_id or tag_id as a query parameter.

https://api.intercom.io/companies?tag_id={tag_id}

https://api.intercom.io/companies?segment_id={segment_id}

get/companies

Request

  • Base URL
    https://api.intercom.io
  • Auth
    HTTP bearer

Query parameters

namestring

The name of the company to filter by.

company_idstring

The company_id of the company to filter by.

tag_idstring

The tag_id of the company to filter by.

segment_idstring

The segment_id of the company to filter by.

pageinteger

The page of results to fetch. Defaults to first page

per_pageinteger

How many results to display per page. Defaults to 15

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Response

Successful

type'list'

The type of object - list.

total_countinteger

The total number of companies.

Example response

{
  "type": "list",
  "pages": {
    "type": "pages",
    "page": 1,
    "next": {
      "per_page": 2,
      "starting_after": "your-cursor-from-response"
    },
    "per_page": 2,
    "total_pages": 13
  },
  "total_count": 100,
  "data": [
    {
      "type": "company",
      "id": "531ee472cce572a6ec000006",
      "name": "Blue Sun",
      "app_id": "ecahpwf5",
      "plan": {
        "type": "plan",
        "id": "269315",
        "name": "Pro"
      },
      "company_id": "6",
      "remote_created_at": 1663597223,
      "created_at": 1663597223,
      "updated_at": 1663597223,
      "last_request_at": 1663597223,
      "size": 100,
      "website": "https://www.intercom.com",
      "industry": "Software",
      "monthly_spend": 100,
      "session_count": 100,
      "user_count": 100,
      "custom_attributes": {
        "paid_subscriber": true,
        "monthly_spend": 155.5,
        "team_mates": 9
      },
      "tags": {
        "tags": [
          {
            "type": "tag",
            "id": "123456",
            "name": "Test tag"
          }
        ]
      },
      "segments": {
        "segments": [
          {
            "type": "segment",
            "id": "56203d253cba154d39010062",
            "name": "Active",
            "created_at": 1394621988,
            "updated_at": 1394622004,
            "person_type": "contact",
            "count": 3
          }
        ]
      }
    }
  ]
}

Changes

  • 2.14788255ed5694Revision changes
    • breaking

      the //// response's property type changed from no type to object for status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status