Reference
Workspace
Tasks, approvals, notes, people, legal, documents, firms, and the rest of the product screens.
These routes cover the screens that are not a catalog record. The firm comes from the token. A tenantId you send is ignored or rejected. The same calls are on the CLI. capsure --help lists every command.
A token’s records:read and records:write cover this page.
Tasks, approvals, notes
Section titled “Tasks, approvals, notes”| Method | Path | What it does |
|---|---|---|
| GET, POST | /api/v1/x/tasks | List or create. A caller who cannot manage tasks sees only their own |
| GET | /api/v1/x/tasks/count | How many match |
| GET | /api/v1/x/tasks/{id} | One task |
| POST | /api/v1/x/tasks/{id}/start | Start |
| POST | /api/v1/x/tasks/{id}/complete | Complete. notes is optional |
| POST | /api/v1/x/tasks/{id}/cancel | Cancel. reason is required |
| POST | /api/v1/x/tasks/{id}/reassign | userId or queue |
| GET, POST | /api/v1/x/approvals | List or request |
| POST | /api/v1/x/approvals/{id}/steps/{stepId}/decide | decision is the step decision name |
| POST | /api/v1/x/approvals/{id}/withdraw | Withdraw |
| GET | /api/v1/x/notifications/inbox | The signed-in person’s inbox |
| POST | /api/v1/x/notifications/{id}/read | Mark one read |
| POST | /api/v1/x/notifications/read-all | Mark the inbox read |
| GET, POST | /api/v1/x/notes | Your notes, or create one |
| GET | /api/v1/x/notes/search | q is required |
| PUT | /api/v1/x/notes/{id}/content | Save the body |
| GET, POST | /api/v1/x/notes/{id}/comments | Read or add a comment |
capsure tasks list and capsure notes push note.json call these.
Creating, cancelling, or reassigning a task needs one of workflow.task.manage, investments.deal.manage, pm.portfolio_company.manage, or admin.users.manage.
People
Section titled “People”| Method | Path | What it does |
|---|---|---|
| GET, POST | /api/v1/x/users | List, or invite. The response includes whether the invitation email was sent |
| PUT | /api/v1/x/users/{id} | Update |
| POST, DELETE | /api/v1/x/users/{id}/roles/{roleId} | Assign or remove a role |
| POST | /api/v1/x/users/{id}/suspend and /reinstate | Suspend or reinstate |
| GET, POST | /api/v1/x/roles | List or create |
| PUT, DELETE | /api/v1/x/roles/{id} | Update or delete |
| POST, DELETE | /api/v1/x/roles/{id}/permissions/{permissionKey} | Grant or revoke |
A token cannot issue another API token.
Legal, documents, lists
Section titled “Legal, documents, lists”List, get, create, and update:
/legal-entities, /side-letters, /conflicts, /incidents, /obligations, /filings, /restricted-lists, /policies, /vendors, /matters.
KYC is list, get, and create. AML is list and get.
| Method | Path | What it does |
|---|---|---|
| GET | /api/v1/x/documents | entityType and entityId are required |
| GET | /api/v1/x/documents/{id}/download | A URL that expires in 15 minutes |
| DELETE | /api/v1/x/documents/{id} | Delete |
| GET, POST | /api/v1/x/datarooms | Datarooms you can open, or create one |
| POST | /api/v1/x/datarooms/{id}/close and /archive | Close or archive |
| GET, POST | /api/v1/x/frameworks | ESG frameworks. Optional type |
| GET | /api/v1/x/esg-periods | Reporting periods. Optional frameworkId |
| GET, POST, PUT, DELETE | /api/v1/x/mailing-lists | Mailing lists |
Uploading a file stays on the product documents route.
Firms and workflow
Section titled “Firms and workflow”| Method | Path | What it does |
|---|---|---|
| GET, POST | /api/v1/x/firms | List or create. Optional q |
| POST | /api/v1/x/firms/{id}/holdings | companyId or leadId, and optional theirStatus |
| GET | /api/v1/x/firms/{id}/public-book | from and to are yyyy-MM-dd |
| GET, POST | /api/v1/x/workflow-instances | Instances in flight, or start one |
| POST | /api/v1/x/workflow-instances/{id}/suspend, /resume, /cancel | Cancel needs reason |
| POST | /api/v1/x/workflow-instances/{id}/signal/{eventName} | Wake an event wait. data is optional |