Skip to main content
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

FieldTypeDescription
idstringUnique identifier
namestringCompany name
descriptionstringCompany description
statusstringactive, paused, archived
budgetMonthlyCentsnumberMonthly budget limit
createdAtstringISO timestamp
updatedAtstringISO timestamp