Reference
Product screens
Taxonomy, portal users, ESG requests, company products and investors, and the integration screens.
These are the screens a person opens in the app. The firm comes from the token. records:read and records:write cover every route on this page.
Taxonomy
Section titled “Taxonomy”GET /api/v1/x/taxonomy/{group} lists one group. The first read of an empty group seeds the defaults. Groups are sectors, geographies, expertise, deal_types, inv_types, co_stages, esg_fw, esg_pillar, doc_types, task_types, role_types, email_template_categories, engagement_statuses, investment_stage, risk_category, and kpi_category.
POST adds an item. PUT /taxonomy/{group}/{key} updates it. DELETE removes it and its children. POST /taxonomy/{group}/reorder takes keys in the new order.
capsure taxonomy list sectors
Portal users
Section titled “Portal users”| Method | Path | What it does |
|---|---|---|
| GET | /api/v1/x/portal/access | Who can sign in. Optional personId, companyId, investorId |
| POST | /api/v1/x/portal/access | Grant access. personId, subjectKind, subjectId, roleId |
| DELETE | /api/v1/x/portal/access/{id} | Revoke access |
| GET, POST | /api/v1/x/portal/roles | Portal security roles |
| PUT, DELETE | /api/v1/x/portal/roles/{id} | Change or remove a role |
| GET, PUT | /api/v1/x/portal/settings | The portal address and what a guest can see |
ESG requests and metrics
Section titled “ESG requests and metrics”GET /api/v1/x/esg-requests?reportingPeriodId= lists the requests for a period. POST creates one. Issue, submit, approve, waive, start progress, and start review are POST /esg-requests/{id}/....
POST /esg-requests/issue-for-period issues a request for every company in the period. POST /esg-requests/issue-for-companies takes the companies you pick. POST /esg-requests/scope-preview shows who is in scope.
GET /api/v1/x/esg-metrics/library is the metric library. GET /esg-metrics?frameworkId= lists one framework. Create, update, and delete use the same path.
Products and investors on a company
Section titled “Products and investors on a company”| Method | Path | What it does |
|---|---|---|
| GET, POST | /api/v1/x/companies/{id}/products | Products. Create needs name and status. status is Planned, Concept, Beta, Live, Sunset, or Discontinued. launchDate is yyyy-MM-dd |
| PUT, DELETE | /api/v1/x/companies/{id}/products/{productId} | Change or remove a product |
| GET, POST | /api/v1/x/companies/{id}/investors | Investors recorded on the company |
| PUT, DELETE | /api/v1/x/companies/{id}/investors/{investorId} | Change or remove one |
capsure products list <company-id> and capsure company-investors list <company-id>.
Integrations
Section titled “Integrations”| Path | What it does |
|---|---|
/api/v1/x/integrations | Integration credentials. Create, update, activate, deactivate |
/api/v1/x/mailboxes | Connected mailboxes. Test, sync, disconnect |
/api/v1/x/rss-feeds | RSS feeds. Create, update, delete, fetch |
/api/v1/x/fx/settings, /fx/pairs, /fx/rates | FX ingestion, tracked pairs, and stored rates |
/api/v1/x/public-markets/status and /listing | The price feed. Listing needs ticker and exchange |
/api/v1/x/screening | The screening provider settings the admin screen saves. Secrets come back redacted |
/api/v1/x/document-storage | SharePoint, Google Drive, and Box settings the documents screen saves. Secrets come back redacted |
/api/v1/x/esg-benchmarks and /providers | Benchmark values and data providers |
/api/v1/x/emission-factors/providers and /search | Emission factor sources. Search needs q |
A screening or document-storage write is { "key", "value" }. The key has to be one that screen already uses. A secret is stored as a secret. You cannot read it back.
The rest of the sidebar
Section titled “The rest of the sidebar”These use the same records:read and records:write scopes. The firm comes from the token.
| Path | Screen |
|---|---|
/api/v1/x/campaigns | Investor relations campaigns |
/api/v1/x/marketing-lists, /marketing-campaigns, /email-templates | Communications |
/api/v1/x/emails | Mailbox inbox |
/api/v1/x/meetings, /time-blocks | Calendar and meetings |
/api/v1/x/experts, /shortlists | Experts and shortlist |
/api/v1/x/comparable-sets, /comparable-set-templates | Comparable sets. List sets with dealId |
/api/v1/x/projection-templates, /projection-models | Projection templates and models. Templates can be created, updated, and deleted |
/api/v1/x/scorecard-templates, /scorecards | Scoring. Scorecards need companyId |
/api/v1/x/deal-benchmarks | Deal benchmarks |
/api/v1/x/planner | Portfolio planner |
/api/v1/x/board-events, /board-cadences | Board. Both lists need portfolioCompanyId |
/api/v1/x/portfolio-requests | Portfolio requests. Needs portfolioCompanyId |
/api/v1/x/materiality | Materiality. List needs portfolioCompanyId |
/api/v1/x/esg-reports | ESG reports. List needs entityType and entityId |
/api/v1/x/esg-analytics/collection, /completion, /review-queue | ESG analytics and the review queue |
/api/v1/x/metric-mappings | Field mappings |
/api/v1/x/datasets, /components | Report datasets and components |
/api/v1/x/lifecycles, /conformance, /workflow-health | Workflow in flight, conformance, and health |
/api/v1/x/approval-types, /workflow-configs | Approval types and workflow config |
/api/v1/x/checklist-templates | Checklist templates |
/api/v1/x/booking-types | Booking settings |
/api/v1/x/dedupe | Deduplication. Needs entityType |
/api/v1/x/audit-log | Audit log |
/api/v1/x/usage | Storage and AI credits for this month. PUT /usage/ai/limits sets a monthly credit limit |
capsure campaigns list, capsure meetings list, capsure esg-analytics review-queue, and capsure audit-log list are the list commands. capsure --help has the rest.
What a person fills in
Section titled “What a person fills in”These are the writes on a company, a deal, a form, and a legal file. They use the same records:read and records:write scopes. A list that exists can be read with GET.
Company children
Section titled “Company children”| Method | Path | Body |
|---|---|---|
| GET, POST | /api/v1/x/companies/{id}/addresses | addressType is Registered, Trading, or Correspondence. country is ISO-3166 alpha-2. mode is create, correct, or replace. line1, line2, city, provinceState, and postalCode are optional |
| GET, POST | /api/v1/x/companies/{id}/milestones | title and category. category is Product, Commercial, Operational, Financial, Team, Regulatory, Strategic, or ExitPreparation. targetDate is yyyy-MM-dd |
| PUT | /api/v1/x/companies/{id}/milestones/{milestoneId} | The same keys as create |
| GET, POST | /api/v1/x/companies/{id}/financials | periodLabel is required. periodDate is yyyy-MM-dd. revenue, arr, ebitda, currencyCode |
| PUT | /api/v1/x/companies/{id}/financials/{financialsId} | The same keys as create |
| GET | /api/v1/x/companies/{id}/industry-codes | The codes on the company |
| PUT | /api/v1/x/companies/{id}/industry-codes | { "codeIds": [] }. Ids come from the industry catalog. This replaces the list |
| GET, POST | /api/v1/x/companies/{id}/updates | title and content |
| PUT | /api/v1/x/companies/{id}/updates/{updateId} | The same keys as create |
| Method | Path | Body |
|---|---|---|
| GET, POST | /api/v1/x/deals/{id}/terms | instrumentType is OrdinaryShares, PreferenceShares, ConvertibleNote, Safe, Loan, ConvertibleLoan, MezzanineDebt, DebtFacility, Earnout, Warrants, Options, RevenueShare, or Other. Optional amount, stakePercent, preMoneyValuation, postMoneyValuation, currencyCode, notes, setActive |
| PUT | /api/v1/x/deals/{id}/terms/{termId} | The same keys as create |
| GET, POST | /api/v1/x/deals/{id}/next-ups | title |
| GET, POST | /api/v1/x/deals/{id}/ic-decision | decision is Approved, Rejected, ApprovedWithConditions, or Deferred. icDate is yyyy-MM-dd. Optional conditions. GET returns those three keys, or nulls when none is recorded |
The rest
Section titled “The rest”| Path | What it writes |
|---|---|
/api/v1/x/management-team, /roadmaps | Management team and roadmap lanes and items. Management list needs portfolioCompanyId. Roadmap list needs companyId |
/api/v1/x/shortlists/{id}/items, /comparable-sets/{id}/comparables | A person on a shortlist, or a comparable on a set that already exists |
/api/v1/x/esg-periods, /esg-submissions, /esg-submissions/{id}/answers | ESG reporting periods and the submission answers in the review queue |
/api/v1/x/metric-mappings | Field mappings between metrics |
/api/v1/x/projection-templates, /projection-models, /projection-models/{id}/cells | Projection templates, models, and the figures in a model |
/api/v1/x/scorecard-templates, /scorecards | Scorecards |
/api/v1/x/planner, /planner/{id}/slots | Portfolio planner scenarios |
/api/v1/x/ddq, /ddq/{id}/sections/{sectionId}/answers | DDQ answers |
/api/v1/x/form-instances, /form-responses, /form-responses/{id}/draft, /submit | Other forms a person fills |
/api/v1/x/board-events, /portfolio-requests | Board events and portfolio requests |
/api/v1/x/meetings/{id}, /meetings/{id}/body, /time-blocks | Meeting edits and calendar time blocks |
/api/v1/x/mailboxes/{id}/send, /messages/{messageId}/reply, /marketing-lists/{id}/subscribers | Composing or replying to an email, and subscribers on a marketing list |
/api/v1/x/experts/{id}/engagements | Expert engagements |
/api/v1/x/aml, /kyc/{id}/notes, /kyc/{id}/risk-tier | An AML case, and edits to a KYC record after it is created |
/api/v1/x/side-letters/{id}/provisions, /conflicts/{id}/parties, /restricted-lists/{id}/entries, /vendors/{id}/services | Extra lines on a legal record |
/api/v1/x/documents | Upload a document file. Multipart form with file, entityType, and entityId |
capsure addresses list <company-id>, capsure deals terms <deal-id>, capsure deals next-ups <deal-id>, capsure deals decision <deal-id>, capsure deals ic <deal-id> --file decision.json, capsure documents upload <file> --entity Company --id <entity-id>, and capsure form-responses draft <response-id> --file answers.json are the matching commands.