Retrieves detailed information about a specific company using either the internal Customerly company ID or your custom identifier.
This is the primary way to fetch a single company's complete profile.

Company Identification

You can retrieve a company using two types of identifiers:

1. Customerly Company ID (numeric):

• Use the internal company ID directly (e.g., 12345)
• Example: GET /companies/12345

2. Custom Company ID (prefixed with cid:):

• Use your custom identifier with the cid: prefix
• Example: If your custom_company_id is company_12345, use GET /companies/cid:company_12345

Response Data

Always included in the response:

• Basic company information (ID, name, creation date, last seen)
• All custom attributes as key-value pairs

Optional data (use include parameter):
You can request additional related data by adding an include query parameter:

• contacts: Paginated list of contacts in this company (max 20 items, with total count and has_more flag)
• segments: Paginated list of segments this company belongs to (max 20 items, with total count and has_more flag)

How to use include:

• Single: ?include=contacts
• Multiple: ?include=contacts,segments

Example Requests

# Get company by Customerly ID with contacts
GET /companies/12345?include=contacts

# Get company by custom company ID with both contacts and segments
GET /companies/cid:company_abc123?include=contacts,segments

# Get company by ID with segments only
GET /companies/12345?include=segments

# Get company basic data only (no optional fields)
GET /companies/cid:company_abc123