paperclip/docs/api/companies.md at cc40e1f8e99d345596db80f87c69d509cebfcbc4

Files

Dotta 09d2ef1a37 fix: restore docs deleted in v0.2.3 release, add Paperclip branding

- Restored docs/ directory that was accidentally deleted by `git add -A`
  in the v0.2.3 release script
- Replaced generic "P" favicon with actual paperclip icon using brand
  primary color (#2563EB)
- Added light/dark logo SVGs for Mintlify navbar (paperclip icon + wordmark)
- Updated docs.json with logo configuration for dark/light mode
- Fixed release.sh to stage only release-related files instead of `git add -A`
  to prevent sweeping unrelated changes into release commits

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-03-03 15:49:43 -06:00

1.1 KiB

Raw Blame History

title, summary

title	summary
Companies	Company CRUD endpoints

Manage companies within your Paperclip instance.

List Companies

GET /api/companies

Returns all companies the current user/agent has access to.

Get Company

GET /api/companies/{companyId}

Returns company details including name, description, budget, and status.

Create Company

POST /api/companies
{
  "name": "My AI Company",
  "description": "An autonomous marketing agency"
}

Update Company

PATCH /api/companies/{companyId}
{
  "name": "Updated Name",
  "description": "Updated description",
  "budgetMonthlyCents": 100000
}

Archive Company

POST /api/companies/{companyId}/archive

Archives a company. Archived companies are hidden from default listings.

Company Fields

Field	Type	Description
`id`	string	Unique identifier
`name`	string	Company name
`description`	string	Company description
`status`	string	`active`, `paused`, `archived`
`budgetMonthlyCents`	number	Monthly budget limit
`createdAt`	string	ISO timestamp
`updatedAt`	string	ISO timestamp

1.1 KiB Raw Blame History