Return a bundled profile for one company: identifiers (slug, ticker, domain, CIK, QID, linked entity), name, and description. The default response is lean — flipDocumentation Index
Fetch the complete documentation index at: https://docs.particle.pro/llms.txt
Use this file to discover all available pages before exploring further.
include_products and include_competitors when you need the heavier sub-resources. For sponsor/advertising analytics on this company, use advertising/get_company_ad_presence instead.
Inputs
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
company_slug | string | yes | — | Company identifier — accepts slug (e.g. "nvidia"), domain (e.g. "nvidia.com"), or canonical ID. If you already know the domain you can call this tool directly without first running resolve_company. |
include_products | boolean | no | false | Include the three-level product hierarchy (segments → product lines → products). |
product_status | string | no | "active" | Comma-separated lifecycle filter when include_products=true. Allowed values: active, announced, discontinued, rumored. |
include_competitors | boolean | no | false | Include the competitor list (paginated to 25 by default). |
Output
A markdown document with the company name as an H2, identifier KV lines (**Slug:**, **Ticker:**, **Domain:**, **CIK:**, **QID:** — only those that have values), then a paragraph with the description. With include_products=true, a ### Products section follows containing an indented bullet hierarchy - **Name** (level, status) (segment → product_line → product). With include_competitors=true, a ### Competitors section follows with one bullet per competitor: - Name (handles) — competitive_basis.
Sample (company_slug="nvidia", include_products=true, include_competitors=true, truncated):
Example
Related
- REST equivalent:
GET /v1/companies/{id}, with sub-resources for products and competitors. - For sponsor analytics, use
advertising/get_company_ad_presence. - For dialogue mentioning the company, use
podcasts/get_entity_mentionswithcompany_slug.