GET Get Company​
GET
/companies/{id}
Retrieve a single company by its ID, or by an alternate field (name, email, or phone) using the find_by and find_by_value query parameters. The response includes the eager-loaded owner relation (with stats if available) and the computed contacts_count.
Authorizations​
ApplicationPasswords
WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password
Type
API Key (header: Authorization)
Parameters​
Path Parameters
id*
The company ID.
Type
Requiredinteger
Query Parameters
find_by
Field to look up the company by instead of the path id. Supported values: name, email, phone.
Type
string
Valid values
"id""name""email""phone"Default
"id"find_by_value
The value to search for when using find_by. Required when find_by is not id.
Type
string
Responses​
Company details.
application/json
JSON
{
"company": {
"id": 0,
"name": "string",
"description": "string",
"email": "string",
"phone": "string",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string",
"type": "string",
"industry": "string",
"logo": "string",
"website": "string",
"linkedin_url": "string",
"facebook_url": "string",
"twitter_url": "string",
"owner_user_id": 0,
"employees_number": 0,
"status": "string",
"contacts_count": 0,
"created_at": "string",
"updated_at": "string",
"owner": {
"id": 0,
"first_name": "string",
"last_name": "string",
"email": "string"
}
}
}