paperclip_list_companies
Retrieve a paginated list of all companies accessible to the authenticated board user. Supports limit, offset, and output format options.
Instructions
⚠ Board-only: List all companies accessible to the authenticated board user.
Args:
limit: number (optional) — Max companies per page (1–100, default 50)
offset: number (optional) — Number of companies to skip (default 0)
response_format: 'markdown' | 'json' (optional) — Output format (default: markdown)
Returns: Pagination envelope { items: Company[], total, count, offset, limit, has_more, next_offset }. Each item: id, name, description, status, issuePrefix, budgetMonthlyCents, createdAt.
Examples:
Use when: discovering all companies on the board before looking up a specific companyId
Don't use when: you already have the companyId — use paperclip_get_company instead
Error Handling:
401: authentication failed → check PAPERCLIP_API_KEY
403: board key required → this endpoint requires board-level authentication
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | Yes | Max companies per page (1–100, default 50) | |
| offset | Yes | Number of companies to skip (default 0) | |
| response_format | Yes | Output format: 'markdown' (default, human-readable) or 'json' (structured) | markdown |