List competitors
list_competitorsRetrieve all competitors in your workspace with full profile details, including social links and page URLs. Filter by active status or specific IDs for targeted results.
Instructions
Wraps GET /competitors. Lists every competitor in the authenticated workspace. Defaults to expand=full so the agent gets each competitor's social URLs (linkedin, twitter, …) and canonical page URLs (pricing, blog, …) in one call — no round-trip to get_competitor needed for that metadata.
Filters:
active: when true, only competitors still being tracked; when false, only archived ones.ids: narrow to a specific subset (comma-joined upstream).expand:full(default — profile + social + pages) orcompact(id / name / website / category / active only).
Chaining: Discover competitor ids here, then pass them to get_competitor, list_activities (competitor_ids), or list_digests (competitor_id).
Errors: unauthorized, rate_limited.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | Narrow to this subset of competitor ids. Omit to return all. | |
| active | No | Filter to active (true) or archived (false) competitors. Omit to return both. | |
| expand | No | `full` (default) adds social + pages metadata; `compact` returns id/name/website/category/active only. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes |