User.com REST API Docs

# Get company by id

You can return specific company details by using the company custom_id.

GET /companies-by-id/:custom_id/

Attributes Type Required Description
custom_id string yes The unique identifier for the company which is provided by the client.

# Request

  • CURL
  • JavaScript
  • PHP
  • Python 
curl -X GET -H "Authorization: Token <your_64_char_api_key>"
-H "Accept: */*; version=2" 
-H "Accept: */*; version=2" "https://<your_app_subdomain>.user.com/api/public/companies-by-id/:custom_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": " /<:custom_id>",
    "employees": [123, 432, 543]
}

← Update company →