API Endpoints
Generated from crates/corp-server/src/routes/ in the v2 codebase.
| Method | Path | Handler | Summary |
|---|---|---|---|
GET | /api-keys | list_api_keys | GET /api-keys — list all API keys in the caller’s workspace. |
POST | /api-keys | create_api_key | POST /api-keys — generate a new API key. |
POST | /api-keys/{key_id}/revoke | revoke_api_key | POST /api-keys/{key_id}/revoke — soft-delete an API key. |
GET | /workspaces | list_workspaces | GET /workspaces — list all workspaces known to this deployment. |
GET | /workspaces/{workspace_id}/entities | list_workspace_entities | GET /workspaces/{workspace_id}/entities — list all entities in a workspace. |
agents
Section titled “agents”| Method | Path | Handler | Summary |
|---|---|---|---|
GET | /agents | list_agents | List Agents |
POST | /agents | create_agent | Create Agent |
DELETE | /agents/{agent_id} | delete_agent | Delete Agent |
GET | /agents/{agent_id} | get_agent | Get Agent |
PATCH | /agents/{agent_id} | update_agent | Update Agent |
POST | /agents/{agent_id}/pause | pause_agent | Pause Agent |
POST | /agents/{agent_id}/resume | resume_agent | Resume Agent |
POST | /agents/{agent_id}/skills | add_skill | Add Skill |
DELETE | /agents/{agent_id}/skills/{name} | remove_skill | Remove Skill |
contacts
Section titled “contacts”| Method | Path | Handler | Summary |
|---|---|---|---|
GET | /entities/{entity_id}/contacts | list_contacts | List Contacts |
POST | /entities/{entity_id}/contacts | create_contact | Create Contact |
GET | /entities/{entity_id}/contacts/{contact_id} | get_contact | Get Contact |
PATCH | /entities/{entity_id}/contacts/{contact_id} | update_contact | Update Contact |
POST | /entities/{entity_id}/contacts/{contact_id}/deactivate | deactivate_contact | Deactivate Contact |
equity
Section titled “equity”| Method | Path | Handler | Summary |
|---|---|---|---|
GET | /entities/{entity_id}/cap-table | get_cap_table | Get Cap Table |
POST | /entities/{entity_id}/cap-table | create_cap_table | Create Cap Table |
GET | /entities/{entity_id}/control-links | list_control_links | List Control Links |
POST | /entities/{entity_id}/control-links | create_control_link | Create Control Link |
GET | /entities/{entity_id}/grants | list_grants | List Grants |
POST | /entities/{entity_id}/grants | create_grant | Create Grant |
GET | /entities/{entity_id}/grants/{grant_id} | get_grant | Get Grant |
POST | /entities/{entity_id}/grants/{grant_id}/exercise | exercise_option | Exercise Option |
GET | /entities/{entity_id}/holders | list_holders | List Holders |
POST | /entities/{entity_id}/holders | create_holder | Create Holder |
GET | /entities/{entity_id}/holders/{holder_id} | get_holder | Get Holder |
GET | /entities/{entity_id}/instruments | list_instruments | List Instruments |
POST | /entities/{entity_id}/instruments | create_instrument | Create Instrument |
GET | /entities/{entity_id}/instruments/{instrument_id} | get_instrument | Get Instrument |
GET | /entities/{entity_id}/investor-ledger | list_investor_ledger | List Investor Ledger |
POST | /entities/{entity_id}/investor-ledger | create_ledger_entry | Create Ledger Entry |
GET | /entities/{entity_id}/legal-entities | list_legal_entities | List Legal Entities |
POST | /entities/{entity_id}/legal-entities | create_legal_entity | Create Legal Entity |
GET | /entities/{entity_id}/legal-entities/{le_id} | get_legal_entity | Get Legal Entity |
GET | /entities/{entity_id}/positions | list_positions | List Positions |
POST | /entities/{entity_id}/positions | create_position | Create Position |
GET | /entities/{entity_id}/positions/{position_id} | get_position | Get Position |
POST | /entities/{entity_id}/positions/{position_id}/delta | apply_position_delta | Apply Position Delta |
GET | /entities/{entity_id}/repurchase-rights | list_repurchase_rights | List Repurchase Rights |
POST | /entities/{entity_id}/repurchase-rights | create_repurchase_right | Create Repurchase Right |
POST | /entities/{entity_id}/repurchase-rights/{rr_id}/activate | activate_repurchase | Activate Repurchase |
POST | /entities/{entity_id}/repurchase-rights/{rr_id}/close | close_repurchase | Close Repurchase |
POST | /entities/{entity_id}/repurchase-rights/{rr_id}/waive | waive_repurchase | Waive Repurchase |
GET | /entities/{entity_id}/rounds | list_rounds | List Rounds |
POST | /entities/{entity_id}/rounds | create_round | Create Round |
GET | /entities/{entity_id}/rounds/{round_id} | get_round | Get Round |
POST | /entities/{entity_id}/rounds/{round_id}/advance | advance_round | Advance Round |
POST | /entities/{entity_id}/rounds/{round_id}/close | close_round | Close Round |
GET | /entities/{entity_id}/safes | list_safes | List Safes |
POST | /entities/{entity_id}/safes | issue_safe | Issue Safe |
GET | /entities/{entity_id}/safes/{safe_id} | get_safe | Get Safe |
POST | /entities/{entity_id}/safes/{safe_id}/cancel | cancel_safe | Cancel Safe |
POST | /entities/{entity_id}/safes/{safe_id}/convert | convert_safe | Convert a SAFE note into equity. |
GET | /entities/{entity_id}/transfers | list_transfers | List Transfers |
POST | /entities/{entity_id}/transfers | create_transfer | Create Transfer |
GET | /entities/{entity_id}/transfers/{transfer_id} | get_transfer | Get Transfer |
POST | /entities/{entity_id}/transfers/{transfer_id}/approve | approve_transfer | Approve Transfer |
POST | /entities/{entity_id}/transfers/{transfer_id}/cancel | cancel_transfer | Cancel Transfer |
POST | /entities/{entity_id}/transfers/{transfer_id}/deny | deny_transfer | Deny Transfer |
POST | /entities/{entity_id}/transfers/{transfer_id}/execute | execute_transfer | Execute an approved transfer. |
GET | /entities/{entity_id}/valuations | list_valuations | List Valuations |
POST | /entities/{entity_id}/valuations | create_valuation | Create Valuation |
GET | /entities/{entity_id}/valuations/{valuation_id} | get_valuation | Get Valuation |
POST | /entities/{entity_id}/valuations/{valuation_id}/approve | approve_valuation | Approve Valuation |
POST | /entities/{entity_id}/valuations/{valuation_id}/expire | expire_valuation | Expire Valuation |
POST | /entities/{entity_id}/valuations/{valuation_id}/submit | submit_valuation | Submit Valuation |
POST | /entities/{entity_id}/valuations/{valuation_id}/supersede | supersede_valuation | Supersede Valuation |
GET | /entities/{entity_id}/vesting-events | list_vesting_events | List Vesting Events |
POST | /entities/{entity_id}/vesting-events/{event_id}/forfeit | forfeit_event | Forfeit Event |
POST | /entities/{entity_id}/vesting-events/{event_id}/vest | vest_event | Vest Event |
GET | /entities/{entity_id}/vesting-schedules | list_vesting_schedules | List Vesting Schedules |
POST | /entities/{entity_id}/vesting-schedules | create_vesting_schedule | Create Vesting Schedule |
GET | /entities/{entity_id}/vesting-schedules/{schedule_id} | get_vesting_schedule | Get Vesting Schedule |
POST | /entities/{entity_id}/vesting-schedules/{schedule_id}/materialize | materialize_events | Materialize Events |
POST | /entities/{entity_id}/vesting-schedules/{schedule_id}/terminate | terminate_vesting | Terminate Vesting |
POST | /entities/{entity_id}/vesting-schedules/{schedule_id}/vest-due | vest_due_events | Vest all scheduled events for a schedule whose vest_date is on or before today. |
execution
Section titled “execution”| Method | Path | Handler | Summary |
|---|---|---|---|
GET | /entities/{entity_id}/intents | list_intents | List Intents |
POST | /entities/{entity_id}/intents | create_intent | Create Intent |
GET | /entities/{entity_id}/intents/{intent_id} | get_intent | Get Intent |
PATCH | /entities/{entity_id}/intents/{intent_id} | update_intent | Update Intent |
POST | /entities/{entity_id}/intents/{intent_id}/authorize | authorize_intent | Authorize Intent |
POST | /entities/{entity_id}/intents/{intent_id}/cancel | cancel_intent | Cancel Intent |
POST | /entities/{entity_id}/intents/{intent_id}/evaluate | evaluate_intent | Evaluate Intent |
POST | /entities/{entity_id}/intents/{intent_id}/execute | execute_intent | Execute Intent |
POST | /entities/{entity_id}/intents/{intent_id}/fail | fail_intent | Fail Intent |
GET | /entities/{entity_id}/obligations | list_obligations | List Obligations |
POST | /entities/{entity_id}/obligations | create_obligation | Create Obligation |
GET | /entities/{entity_id}/obligations/{obligation_id} | get_obligation | Get Obligation |
PATCH | /entities/{entity_id}/obligations/{obligation_id} | update_obligation | Update Obligation |
POST | /entities/{entity_id}/obligations/{obligation_id}/expire | expire_obligation | Expire Obligation |
POST | /entities/{entity_id}/obligations/{obligation_id}/fulfill | fulfill_obligation | Fulfill Obligation |
POST | /entities/{entity_id}/obligations/{obligation_id}/start | start_obligation | Start Obligation |
POST | /entities/{entity_id}/obligations/{obligation_id}/waive | waive_obligation | Waive Obligation |
GET | /entities/{entity_id}/receipts | list_receipts | List Receipts |
POST | /entities/{entity_id}/receipts | create_receipt | Create Receipt |
GET | /entities/{entity_id}/receipts/{receipt_id} | get_receipt | Get Receipt |
formation
Section titled “formation”| Method | Path | Handler | Summary |
|---|---|---|---|
POST | /documents/{document_id}/sign | sign_document | POST /documents/{document_id}/sign — apply a signature to a document. |
GET | /entities | list_entities | GET /entities — list all entities in the caller’s workspace. |
POST | /entities | create_entity | POST /entities — create a new legal entity. |
GET | /entities/{entity_id} | get_entity | GET /entities/{entity_id} — fetch a single entity by ID. |
POST | /entities/{entity_id}/dissolve | dissolve_entity | POST /entities/{entity_id}/dissolve — dissolve a legal entity. |
POST | /formations/{entity_id}/advance | advance_formation | POST /formations/{entity_id}/advance — advance the entity’s formation status. |
GET | /formations/{entity_id}/documents | list_documents | GET /formations/{entity_id}/documents — list all documents for an entity. |
GET | /formations/{entity_id}/documents/{document_id} | get_document | GET /formations/{entity_id}/documents/{document_id} — fetch a single document. |
GET | /formations/{entity_id}/documents/{document_id}/html | render_document_html | GET /formations/{entity_id}/documents/{document_id}/html — render document as HTML. |
GET | /formations/{entity_id}/filing | get_filing | GET /formations/{entity_id}/filing — fetch the filing record for an entity. |
POST | /formations/{entity_id}/filing/confirm | confirm_filing | POST /formations/{entity_id}/filing/confirm — confirm state acceptance of the filing. |
GET | /formations/{entity_id}/tax | get_tax_profile | GET /formations/{entity_id}/tax — fetch the tax profile for an entity. |
POST | /formations/{entity_id}/tax/confirm-ein | confirm_ein | POST /formations/{entity_id}/tax/confirm-ein — record an IRS-assigned EIN. |
governance
Section titled “governance”| Method | Path | Handler | Summary |
|---|---|---|---|
GET | /entities/{entity_id}/governance/bodies | list_bodies | GET /entities/{entity_id}/governance/bodies |
POST | /entities/{entity_id}/governance/bodies | create_body | POST /entities/{entity_id}/governance/bodies |
GET | /entities/{entity_id}/governance/bodies/{body_id} | get_body | GET /entities/{entity_id}/governance/bodies/{body_id} |
POST | /entities/{entity_id}/governance/bodies/{body_id}/deactivate | deactivate_body | POST /entities/{entity_id}/governance/bodies/{body_id}/deactivate |
GET | /entities/{entity_id}/governance/meetings | list_meetings | GET /entities/{entity_id}/governance/meetings |
POST | /entities/{entity_id}/governance/meetings | create_meeting | POST /entities/{entity_id}/governance/meetings |
GET | /entities/{entity_id}/governance/meetings/{meeting_id} | get_meeting | GET /entities/{entity_id}/governance/meetings/{meeting_id} |
POST | /entities/{entity_id}/governance/meetings/{meeting_id}/adjourn | adjourn_meeting | POST /entities/{entity_id}/governance/meetings/{meeting_id}/adjourn |
POST | /entities/{entity_id}/governance/meetings/{meeting_id}/attendance | record_attendance | POST /entities/{entity_id}/governance/meetings/{meeting_id}/attendance |
POST | /entities/{entity_id}/governance/meetings/{meeting_id}/cancel | cancel_meeting | POST /entities/{entity_id}/governance/meetings/{meeting_id}/cancel |
POST | /entities/{entity_id}/governance/meetings/{meeting_id}/convene | convene_meeting | POST /entities/{entity_id}/governance/meetings/{meeting_id}/convene |
GET | /entities/{entity_id}/governance/meetings/{meeting_id}/items | list_agenda_items | GET /entities/{entity_id}/governance/meetings/{meeting_id}/items |
POST | /entities/{entity_id}/governance/meetings/{meeting_id}/items | create_agenda_item | POST /entities/{entity_id}/governance/meetings/{meeting_id}/items |
POST | /entities/{entity_id}/governance/meetings/{meeting_id}/items/{item_id}/resolve | resolve_item | POST /entities/{entity_id}/governance/meetings/{meeting_id}/items/{item_id}/resolve |
POST | /entities/{entity_id}/governance/meetings/{meeting_id}/notice | send_notice | POST /entities/{entity_id}/governance/meetings/{meeting_id}/notice |
POST | /entities/{entity_id}/governance/meetings/{meeting_id}/reopen | reopen_meeting | POST /entities/{entity_id}/governance/meetings/{meeting_id}/reopen |
GET | /entities/{entity_id}/governance/meetings/{meeting_id}/resolutions | list_resolutions | GET /entities/{entity_id}/governance/meetings/{meeting_id}/resolutions |
GET | /entities/{entity_id}/governance/meetings/{meeting_id}/votes | list_votes | GET /entities/{entity_id}/governance/meetings/{meeting_id}/votes |
POST | /entities/{entity_id}/governance/meetings/{meeting_id}/votes | cast_vote | POST /entities/{entity_id}/governance/meetings/{meeting_id}/votes |
GET | /entities/{entity_id}/governance/profile | get_profile | GET /entities/{entity_id}/governance/profile |
PUT | /entities/{entity_id}/governance/profile | update_profile | PUT /entities/{entity_id}/governance/profile |
POST | /entities/{entity_id}/governance/quick-approve | quick_approve | POST /entities/{entity_id}/governance/quick-approve |
GET | /entities/{entity_id}/governance/seats | list_seats | GET /entities/{entity_id}/governance/seats |
POST | /entities/{entity_id}/governance/seats | create_seat | POST /entities/{entity_id}/governance/seats |
GET | /entities/{entity_id}/governance/seats/{seat_id} | get_seat | GET /entities/{entity_id}/governance/seats/{seat_id} |
POST | /entities/{entity_id}/governance/seats/{seat_id}/resign | resign_seat | POST /entities/{entity_id}/governance/seats/{seat_id}/resign |
POST | /entities/{entity_id}/governance/written-consent | create_written_consent | POST /entities/{entity_id}/governance/written-consent |
manifest
Section titled “manifest”| Method | Path | Handler | Summary |
|---|---|---|---|
GET | /cli/manifest | manifest | GET /cli/manifest — return the complete command manifest. |
next_steps
Section titled “next_steps”| Method | Path | Handler | Summary |
|---|---|---|---|
GET | /entities/{entity_id}/next-steps | entity_next_steps | Entity Next Steps |
services
Section titled “services”| Method | Path | Handler | Summary |
|---|---|---|---|
GET | /entities/{entity_id}/service-requests | list_service_requests | List Service Requests |
POST | /entities/{entity_id}/service-requests | create_service_request | Create Service Request |
GET | /entities/{entity_id}/service-requests/{request_id} | get_service_request | Get Service Request |
POST | /entities/{entity_id}/service-requests/{request_id}/checkout | begin_checkout | Begin Checkout |
POST | /entities/{entity_id}/service-requests/{request_id}/fulfill | fulfill_service_request | Fulfill Service Request |
POST | /entities/{entity_id}/service-requests/{request_id}/pay | mark_paid | Mark Paid |
treasury
Section titled “treasury”| Method | Path | Handler | Summary |
|---|---|---|---|
GET | /entities/{entity_id}/accounts | list_accounts | List Accounts |
POST | /entities/{entity_id}/accounts | create_account | Create Account |
POST | /entities/{entity_id}/accounts/{account_id}/deactivate | deactivate_account | POST /entities/{entity_id}/accounts/{account_id}/deactivate |
GET | /entities/{entity_id}/bank-accounts | list_bank_accounts | List Bank Accounts |
POST | /entities/{entity_id}/bank-accounts | create_bank_account | Create Bank Account |
POST | /entities/{entity_id}/bank-accounts/{bank_id}/activate | activate_bank_account | POST /entities/{entity_id}/bank-accounts/{bank_id}/activate |
POST | /entities/{entity_id}/bank-accounts/{bank_id}/close | close_bank_account | POST /entities/{entity_id}/bank-accounts/{bank_id}/close |
GET | /entities/{entity_id}/invoices | list_invoices | List Invoices |
POST | /entities/{entity_id}/invoices | create_invoice | Create Invoice |
POST | /entities/{entity_id}/invoices/{invoice_id}/pay | pay_invoice | POST /entities/{entity_id}/invoices/{invoice_id}/pay |
POST | /entities/{entity_id}/invoices/{invoice_id}/send | send_invoice | POST /entities/{entity_id}/invoices/{invoice_id}/send |
POST | /entities/{entity_id}/invoices/{invoice_id}/void | void_invoice | POST /entities/{entity_id}/invoices/{invoice_id}/void |
GET | /entities/{entity_id}/journal-entries | list_journal_entries | List Journal Entries |
POST | /entities/{entity_id}/journal-entries | create_journal_entry | Create Journal Entry |
POST | /entities/{entity_id}/journal-entries/{entry_id}/post | post_journal_entry | POST /entities/{entity_id}/journal-entries/{entry_id}/post |
POST | /entities/{entity_id}/journal-entries/{entry_id}/void | void_journal_entry | POST /entities/{entity_id}/journal-entries/{entry_id}/void |
GET | /entities/{entity_id}/payments | list_payments | List Payments |
POST | /entities/{entity_id}/payments | create_payment | Create Payment |
GET | /entities/{entity_id}/payroll-runs | list_payroll_runs | List Payroll Runs |
POST | /entities/{entity_id}/payroll-runs | create_payroll_run | Create Payroll Run |
POST | /entities/{entity_id}/payroll-runs/{run_id}/approve | approve_payroll_run | POST /entities/{entity_id}/payroll-runs/{run_id}/approve |
POST | /entities/{entity_id}/payroll-runs/{run_id}/process | process_payroll_run | POST /entities/{entity_id}/payroll-runs/{run_id}/process |
GET | /entities/{entity_id}/reconciliations | list_reconciliations | List Reconciliations |
POST | /entities/{entity_id}/reconciliations | create_reconciliation | Create Reconciliation |
POST | /entities/{entity_id}/reconciliations/{reconciliation_id}/reconcile | reconcile | POST /entities/{entity_id}/reconciliations/{reconciliation_id}/reconcile |
work_items
Section titled “work_items”| Method | Path | Handler | Summary |
|---|---|---|---|
GET | /entities/{entity_id}/work-items | list_work_items | List Work Items |
POST | /entities/{entity_id}/work-items | create_work_item | Create Work Item |
GET | /entities/{entity_id}/work-items/{item_id} | get_work_item | Get Work Item |
POST | /entities/{entity_id}/work-items/{item_id}/cancel | cancel_work_item | Cancel Work Item |
POST | /entities/{entity_id}/work-items/{item_id}/claim | claim_work_item | Claim Work Item |
POST | /entities/{entity_id}/work-items/{item_id}/complete | complete_work_item | Complete Work Item |
POST | /entities/{entity_id}/work-items/{item_id}/release | release_work_item | Release Work Item |