Returns metadata about the authenticated API key, the user it belongs to, the account it is scoped to, the key-level permissions, and (for regular user keys) the user's account_user role flags and accessible pipeline IDs. Useful for agents and integrations to introspect their own capabilities before making other calls. account is the account this request acted in (the one named by X-Account-Id, or the key's default account); token.cross_account says whether this is a user key that can act in any of its user's accounts, and token.default_account_id is the account it acts in when no header is sent. Legacy API keys are rejected with a 403.

Returns every account the key's user is a member of, with the roles the user holds in each, except accounts whose admins have blocked the user's keys from other accounts (the key's own default account is always listed). A user API key acts in its default account (the one it was created in) unless a request sends the X-Account-Id header; the id of any row here is a valid value for that header. The list is the same whichever account the request runs in. A key that stays in one account (issued through "Sign in with Hub", or carrying a privileged permission) ignores the header and is listed only that account.

Admin-only. Returns the Decile Hub accounts the calling admin user can reach — accounts that have opted in to decile-admin access plus any account the admin is directly a member of. Results are sorted by name and capped at 100 rows; pass search to filter by name or subdomain when the admin has access to many accounts. Non-admin keys receive 403. Requires X-Account-Id header set to any account this admin can access; the response then enumerates the full set including that seed account.

Returns the current account's basic information

Returns the AccountUsers belonging to the authenticated API key's account.
Use to discover the assigned_id value for PATCH /api/v1/pipeline_prospects and
PATCH /api/v1/pipeline_prospects/{id} (the prospect-owner field).

id is the membership id. user_id is the user id — the value POST /api/v1/tasks
expects as assignee_id.

is_you marks the row for whoever this call is being made on behalf of, so
"assign it to me" needs no name-guessing. At most one row has it. When every
row is false the caller could not be identified (an unattended run, for
example) — ask who is meant rather than picking the likeliest person.

Pagination is zero-indexed; page size is 100.

Returns the activity feed for the current account, newest first. Filter by
subject (entity), event type, actor, date range, or form.

Pagination is keyset — pass pagination.next_page_token from a response back
as page_token= to fetch the next page.

Returns one activity entry plus the full per-type entryable body —
audit change diffs, full email bodies and recipients, note bodies,
AML/KYC status, chat summaries, and so on. The list endpoint omits this detail.

Returns a paginated list of the firm-admin entities (funds, SPVs,
holdings, management companies, general partnerships) under the
authenticated API key's account. Identity-only payload — fund-specific
configuration (cutover dates, GP carry %, logo URL) is returned by
GET /api/v1/entities/{id} instead.

Pagination is 1-indexed (page 1 is the first page). per_page is
capped at 100; values <= 0 fall back to the default of 50.

Creates a new AccountOrganization plus a fresh Organization and (for
fund kinds) a FundDetail under the authenticated account.

Onboarding side effects are suppressed for API-created entities —
no LP closing pipeline is generated, no AccountOrganizationUser is
attached for the account owner, and no Accelerator client_product
touch fires. Callers that want the full onboarding workflow should
continue to use the firm-admin UI.

POST is not idempotent. To retry safely, GET /api/v1/entities and
check whether the desired entity already exists before retrying.

Requires a caller who is a full_access_account_admin? of the target account.

Returns identity + a details block for one entity. The details
block always includes currency, currency_symbol, fiscal_year_end,
entity_name, logo_url, is_active, and kind. When the entity is a fund
(kind=fund, spv, or holding) the details block additionally
includes gp_carry, new_management_fee_system_cutover_date, and
new_carry_system_cutover_date. For non-fund entities those keys are
omitted entirely.

For funds, details.minimum_investment is the LP minimum the GP
configured (null when none is set; Hub's own type floor is never
reported here). details.management_fee states the fund's fee terms
(frequency plus a tiers array) only when its single active
schedule can be stated without losing anything; otherwise it is null
and details.management_fee_unavailable_reason says why. Treat a null
management_fee as "not stated", never as "no fee": a fee that exists
but cannot be stated here (several schedules, conditions such as a fee
holiday, per-class rates, flat or one-time charges, date bands, an
amended or ended schedule, an unresolved rate) must not be inferred or filled in from elsewhere.

Pass ?include=team to embed a team array of the people the account
shows on its team page, in page order (name, title, position,
gp_signatory). Funds only; non-fund entities get an empty array.

Pass ?include=calculations to embed a calculations block of
fund-level dashboard values. ?window=now (default) returns
as-of-today values and includes capital_activity.invested plus
fees.reserved_for_fees; ?window=lifetime returns forecast values
and omits those two fields entirely. calculations is only supported
on fund-kind entities (kind=fund, spv, or holding); requesting
it on a non-fund entity returns 404. Numeric values serialize as
2-decimal-place decimal strings (currency) or 4-decimal-place
decimal strings (ratios such as performance.net_irr); investor
counts are integers.

ALWAYS branch on calculations.available rather than assuming the
figure groups are present. It is false, with reason and message
and no figure groups, for SPV entities whose computed fund-level figures
do not reconcile with their actual deal economics; those entities return
200, not 404. No computed fund-level figure is reported for such an
entity, and none may be estimated or reconstructed from other endpoints
and presented as one. The details block is unaffected by this
suppression and still carries that entity's own configured values,
including target_fund_size, gp_carry, fund_life_years and
first_close_date — those are reported inputs, not computed figures, so
they may be quoted as what they are (a target, a rate, a date) and must
never be presented as this entity's ACTUAL capital, performance or fee
figures. Every entity of kind=spv is suppressed — both legacy SPVs and
Start SPVs — so a kind=spv entity never carries computed fund-level
figures. Still branch on the flag rather than on kind; the flag is the
contract.

Fee semantics, read fees.note and fees.basis in the response before
answering any fee question. Nothing in the fees group is cash: no
value there is money disbursed to the GP. fees.basis gives each
field's recognition basis SEPARATELY (it is an object, not one label),
and ONLY fields marked accrued_to_date are expense already incurred;
forecast_lifetime, next_12_months_fee_reserve and
projected_lifetime_other_fees are forward-looking projections or
reserves and must never be described as fees charged, recognized, or
owed. On a start fund with window=now, management_fees and
admin_fees are lifetime forecasts while other_fees is to date, and
fees.basis.total_fees is then mixed. There is no
accrued-but-unpaid (GP payable) amount and no fees-paid-to-date amount
anywhere in this payload, so an outstanding or unpaid fee balance
cannot be derived from it and must never be presented as if it could.
fees.reserved_for_fees is a forward-looking reserve, never an amount
owed or unpaid, and is excluded from fees.total_fees;
fees.basis.reserved_for_fees says what it measures for this fund
(next 12 months of fees on a standard fund, a projected lifetime
other-fees figure on a start fund).
fees.total_fees covers management plus admin plus other fees, so a
management-fee-only figure must be compared against
fees.management_fees, not against fees.total_fees.

Returns 404 (not 403) when the id refers to an entity in a different
account.

Updates writable fields on an existing entity within the authenticated
account. All fields optional — only sent fields are applied.

kind is immutable. Sending a matching kind is a no-op; sending a
differing kind returns 422.

Renaming guard: if the entity's Organization is shared with sibling
AccountOrganization rows (an edge case for entities created before this
endpoint existed, or via paths that don't use the API's two-step create),
PATCH refuses with 409 organization_shared_with_siblings and includes
the sibling entity ids in error.details.sibling_entity_ids so callers
can fall back to the firm-admin UI.

Additional rename guard at the model level:
Organization#prevent_name_change_if_accounting_transactions_exist
returns 422 if the Organization has associated accounting transactions.

PATCH is_active=false is the v1 stopgap for hiding an entity, since
DELETE is not yet supported.

Requires a caller who is a full_access_account_admin? of the target account.

Returns the same canonical Schedule of Investments calculations used by
Hub's CSV, XLSX, PDF, and UI reporting as machine-readable JSON. The
response groups positions by portfolio company and includes position
marks, security and funding-round details, valuation provenance,
company subtotals, and report-wide totals.

This is a synchronous, read-only reconciliation endpoint. Use
generate_financial_report when a downloadable report file is needed.
Pagination applies to company groups; metadata and grand totals always
describe the complete report.

Fund-level capital figures for one entity, summed across its capital
accounts. Returns NO per-capital-account rows and NO performance ratios.

nav is the sum of ending balances across the entity's capital
accounts, i.e. the fund's partners' capital (assets less liabilities).
ending_capital_balance carries the identical figure under the other
name. Quote either verbatim.

partner_type is REQUIRED and has no default: limited_partner,
general_partner, or all. An unfiltered blend of GP and LP capital
overstates the LP figure, so the caller must say which one it wants.
LP-only and GP-only NAV are both meaningful and both supported.

capital_accounts_counted vs capital_accounts_in_entity tells you
whether these totals span the whole fund. Fund-wide amounts (unrealized
and realized gain, fees) are allocated to each capital account by its
commitment share, so a filtered set carries only that set's slice. When
the two counts differ, say so rather than presenting a subset as the
fund total.

IRR, TVPI, DPI, RVPI and MOIC are deliberately absent and are not
available from any agent-reachable endpoint. Do not compute them from
these figures.

Identity-plus-commitments list. Each row is the shared identity
block plus committed_capital — the account's commitment tranches
summed as a decimal string ("0.0" when it has none). Other
per-account calculation values (contributions, balances) are
intentionally NOT included here — they come from the per-record
/calculations endpoint and the bulk
/entities/{entity_id}/capital_accounts/calculations endpoint.
The response's top-level total_committed_capital_all_matches
sums commitment tranches across EVERY account matching the
current filters (not just the page), so commitment totals are
answerable without paging.

Optional filters: fuzzy q (LP name, fund entity name, or primary
contact email), partner_type, boolean flags
(kyc_passed/aml_passed/transferred), an admitted_on window
(admitted_after/admitted_before), and a total-commitment range
(min_total_commitment/max_total_commitment). Sort with
sort_by/sort_order (default: ascending id).

Returns 404 when entity_id resolves to an entity in a different
account (cross-account requests are not distinguished from missing).

Identity block + commitments + primary_contact + contacts + entity
ref. contacts is the full list of contacts on the capital account
(joint signatories, spouses, trustees, entity owners/signatories,
trust beneficiaries); each entry carries role flags plus
contact_status_type (none/primary/additional). Returns 404
when the capital account belongs to a different account. Use
?include=transfers to embed an ordered list of capital-account
transfers oriented at the requested CA (kind=outbound when the
requested CA is the from_capital_account, inbound otherwise);
effective_at is aliased from the underlying transferred_at
column.

Computes a single capital account's period figures. Response groups:

- commitments — 12 commitment + paid-in fields.
- period_activity — 15 ledger movements within the window.
- performance — dpi, rvpi, tvpi.
- meta — period_start, period_end, currency,
management_fee_system, carry_system, cutover_dates. The
*_system keys are legacy (window ends before the cutover),
new (window starts on/after the cutover), or hybrid (window
straddles the cutover).

All numeric values are returned as decimal strings (currency 2
decimal places, ratios 4 decimal places). Nil values are returned
as null. Returning decimal strings is intentional so callers
don't lose precision via JS number parsing.

Period semantics: pass both period_start and period_end (ISO
YYYY-MM-DD). Both are required together — supplying one without
the other returns a 400. period_end must be on or after
period_start. When neither is supplied, the window defaults to
the current fiscal-year-to-date for the parent entity.

In a hybrid window the API uses the new-system carry calculation
directly even for GP-carry capital accounts, which can differ from
calculating each side of the cutover separately. Request explicit
pre/post cutover windows if you need each side calculated on its own.

Returns side_letter — the LP's live (not withdrawn) side letter, or
null when they have none — together with standard_terms, the fund
terms a letter may undercut.

standard_terms.fee_bands is the read to make BEFORE
start_side_letter: its position values are the keys of that
operation's fee_rates, and fund_rate_percent is the ceiling for
each band (a negotiated rate above the fund's own is refused). A
management_fee_schedule of null means the fund has no active
tiered schedule, so it cannot offer fee terms at all.

All percentages are decimal strings ("1.5" is 1.5%, not 150%).
stage tracks progress through signing: awaiting_lp,
awaiting_countersignature, awaiting_approval, executed,
withdrawn. Returns 404 when the capital account belongs to a
different account, or to a management company or general partnership
rather than a fund.

Requires an account admin of the fund's account (or a permitted Decile
admin) and the side letters feature enabled for the account; otherwise
403. Side letters are offered on SPVs (an SPV or a Start SPV) only for
now: this read answers for any fund, but start_side_letter refuses an
LP of a traditional fund, a Start Fund or a fund of funds.

Offers this LP a side letter: records the negotiated carry, writes the
negotiated fee bands as an own-rate management fee schedule assigned to
them, opens their side letter questionnaire with the terms prefilled,
and adds the row to their onboarding checklist. Set carry_percentage,
fee_rates, or both.

carry_percentage is a percent string ("15" is 15%) at or below
standard_terms.carry_percentage from get_side_letter. It is booked
on the fund's carry schedule as this LP's promote override once legal
ops execute the letter, so the fund needs a standard carry and an
active carry schedule before a carry term is accepted.

fee_rates is keyed by the position values of
standard_terms.fee_bands from get_side_letter, whose
fund_rate_percent is each band's ceiling. Values are percent
strings ("1.5" is 1.5%). Bands left out keep the fund rate. Read
get_side_letter first: the positions and ceilings are fund state
and cannot be guessed.

send_email defaults to FALSE, so the letter waits on the LP's
onboarding checklist and no mail goes out. Pass true only when the
LP is meant to receive the signing link now — that email cannot be
unsent.

Returns 422 when the LP has withdrawn or is withdrawing from the fund,
when the LP already has a live side letter, when neither a carry nor a
band rate was set, when a rate is above the fund's own, when the fund
has no active tiered fee schedule, no standard carry or no active
carry schedule for the term offered, or when send_email is true and
the LP has no contact email.
Side letters are offered on SPVs (an SPV or a Start SPV) only for now.
An LP of a traditional fund, a Start Fund or a fund of funds gets 403:
tell the user side letters are not available for that fund yet, not
that they lack permission.

Takes the offer back before legal ops approve it: the questionnaire
link stops resolving, the onboarding checklist row goes, and the LP
returns to the fund's standard fee terms. The cancelled record stays
for the audit trail and does not block a fresh offer.

Returns 422 for a letter legal ops already approved — an executed
side letter is a signed agreement and cannot be withdrawn through the
API. Returns 404 when the LP has no live side letter. Like the other
side letter operations, it is refused with 403 while the side letters
feature is not enabled for the account.

Adds a Person in this account as a contact on the capital account, as
the Hub capital account Contacts tab does: joint signatories, spouses,
trustees, trust beneficiaries, entity owners and signatories, or plain
CC contacts.

contact_status_type sets the mailing role: primary (the one primary
contact; the previous primary becomes additional), additional
(CC'd) or none (not contacted). Left out, the contact is primary
when the account has none yet, otherwise additional. The is_*
flags set the legal role; is_primary_individual and is_spouse are
each allowed on one contact per account and never together. Adding a
signer, owner, trustee or beneficiary who has not been verified can
reopen the LP's KYC check.

Returns the new contact and the account's full contacts list,
since the write can change another contact's contact_status_type.
Requires an account admin of the fund's account (or a permitted Decile
admin); otherwise 403.

Changes the fields given and leaves the rest. id is a
contacts[].id from the capital account read, not a person id. The
person cannot be changed: remove the contact and add the other person.
contact_status_type: primary demotes the previous primary to
additional. A blank title clears it. Returns the contact and the
account's full contacts list.

Takes the contact off the capital account; the Person record is kept.
Removing the primary contact promotes the next additional contact to
primary. Returns the remaining contacts.

Returns commitment_increase: where this LP stands on increasing their
commitment, as the fund manager's capital account slideover shows it.

state is available (the LP could be asked now), underway (an
increase is mid-signature) or blocked (a check fails). can_request
is true only when the state is available AND the caller may request
(a read-only key never may).
reasons says why not in plain English; checks lists every fund and
LP gate with passed, label, detail and scope (fund or
capital_account). current_commitment is the LP's commitment today
(decimal string), increase_bounds the min and max the increase
must fall within (whole currency units), and latest_increase the
newest increase response (amounts, signatories, signatures_outstanding,
complete) or null when the LP never started one.

Read this before request_commitment_increase. A GP commitment reads
as blocked (not_gp fails) rather than 403, so the caller learns why.
Returns 404 when the capital account belongs to a different account, or
to a management company or general partnership rather than a fund.

Requires an account admin of the fund's account (or a permitted Decile
admin) and the commitment increase requests feature enabled for the
account; otherwise 403.

Asks this LP to increase their commitment, as the Hub "Request increase"
button does: opens the fund's commitment increase questionnaire for the
LP with the amounts prefilled and EMAILS the LP a link to it at once,
with replies going to the caller. The email cannot be unsent, so confirm
the LP, the amount and the note with the user first.

increase_amount is a whole number of the fund's currency, added to
the current commitment; it must fall within the increase_bounds that
get_commitment_increase reports (5,000 to 10,000,000). message is
an optional personal note of at most 2000 characters, shown in the
email above the link.

Offered only to an LP who could start the increase themselves. Returns
422 when a check fails (details names them), when an increase is
already in progress, when the LP has no email, when the fund has no
commitment increase questionnaire, or when the amount is out of bounds.
400 for an amount that is not a whole number, an over-long message or
an unknown field. 403 for a GP commitment, a caller who is not an
account admin, a read-only token, or the feature off for the account.

Returns 201 with the same commitment_increase payload as the read,
now with state underway and latest_increase set.

Lists every limited partner of the fund with where each stands on a
commitment increase, as the Investor Agreements "Request commitment
increase" picker lists them. GP capital accounts are never listed.

The fund's own gates come first: fund_enabled false means no LP can
be asked right now, fund_checks says which gate fails, and
capital_accounts is empty with total 0. Otherwise each row carries
state (available / underway / blocked), reasons in the
picker's words, committed_capital (decimal string), email,
admitted_on and latest_increase. Use it to find who can be asked,
then get_commitment_increase or request_commitment_increase on one
LP.

Paginated in name order (page, per_page max 100). Returns 404 for
an entity outside the account, or one that is not a fund. Requires an
account admin of the fund's account (or a permitted Decile admin) and
the commitment increase requests feature enabled for the account;
otherwise 403.

Paginated bulk variant of the single-CA calculations endpoint.
Each row in capital_accounts is the same shape as the single-CA
response (commitments/period_activity/performance/meta groups) but
with id+name pulled out of identity for easier table rendering.
Adds a fund-level totals block aggregated across the filtered
scope (NOT only the current page).

Totals semantics:
- Currency fields are summed across the filtered scope.
- Per-CA ratio fields (percentage_of_total_commitments,
percentage_of_lp_commitments, percentage_of_funds_called,
amount_paid_in_for_capital_accounts_percentage) are null in
totals — per-account ratios do not sum into a fund-level figure.
- Performance ratios (dpi, rvpi, tvpi) are null in totals
for the same reason.
- total_committed_capital, lp_committed_capital,
gp_committed_capital are fund-wide regardless of filters — the
per-row total_committed_capital denominator is a fund-level
value, not "total of the filtered list." These fund-wide fields
count commitment tranches whose capital account had a signed LPA
(timestamped by period_end, or carrying the Cornerstone signed flag
when no timestamp exists) or was enabled and admitted by period_end;
PACT-only and unconfirmed prospects remain available as separate rows
with active=all.

Keep fundraising stages separate. From /pipelines?kind=investor, collect
every row whose entity_id exactly matches the requested entity, then
pass each matching row's id as /pacts pipeline_id with
signed_before=period_end; an entity can have multiple investor
pipelines. Each total_pledged_amount_reportable is the gross reportable soft-
commitment total for one pipeline and must not be added to committed
capital. Reporting status alone does not remove PACT signers who later
signed an LPA or were admitted, so an outstanding non-binding PACT total
requires fetching every PACT page for every matching pipeline, retaining
only ignore_for_reporting=false rows, combining them, and calling the capital-account show
endpoint, and reconciling PACT person_id values against contact
person_id values before excluding overlaps. A null PACT person_id
cannot be reconciled deterministically from these APIs; resolve it
manually or report that an exact outstanding total is unavailable.
To split binding capital into signed-not-closed and closed/admitted,
fetch every page of /entities/{entity_id}/capital_accounts?active=all
for identity and every page of this calculation endpoint with
active=all for period-bounded amounts, then join by capital-account
id. Do not use the identity-list row's all-time committed_capital
for a historical window. Define signed_by_period as
lp_signature_at <= period_end, plus undated rows where lpa_signed
is true; define admitted_by_period as admitted_on <= period_end.
Binding rows satisfy signed_by_period OR (enabled AND admitted_by_period).
Split those rows into closed/admitted when admitted_by_period is true
and signed-not-closed otherwise; a currently disabled but signed/admitted
account remains in the closed bucket. Sum the joined calculation row's committed_capital for
each category, and use the complete identity set when reconciling PACT
overlaps. Capital currently
available to deploy comes from /entities/{entity_id}?include=calculations&window=now
as calculations.investable_capital; do not derive it by applying a
fixed percentage to committed capital. Branch on calculations.available
there: on an SPV it is false and investable_capital is absent
entirely, so no SPV has a computed fund-level investable-capital figure —
say so rather than falling back to a percentage of committed capital or
any other derived estimate. This holds for every kind=spv entity, both
legacy SPVs and Start SPVs; still read the flag rather than inferring the
outcome from the entity's kind.

Period and decimal-string semantics are identical to the single-CA
endpoint.

fields= projection: comma-separated whitelist of calculation
field names. When supplied, rows AND totals are narrowed to just
the requested fields. If zero requested fields fall within a
group, that entire group key is dropped from both rows and totals.
id and name are always present on each row. Unknown field
names are silently dropped.

Read-only discovery of imported bank transactions. The privacy-safe
response omits sensitive provider metadata, account and routing data,
external identifiers, GL preassignments, counterparties, and
supersession identifiers. Discarded records are excluded. This endpoint
cannot create, import, sync, update, reconcile, discard, or delete data.
Unknown and cross-account entity ids both return 404.

Read-only lookup using the same privacy-safe allowlist as the list
endpoint. Sensitive provider metadata, bank identifiers, and internal
matching fields are omitted. This endpoint performs no writes, imports,
synchronization, reconciliation, updates, discards, or deletion.
Unknown, discarded, and cross-account ids all return 404.

Returns the journal entries (general-ledger / accounting transactions —
double-entry GL postings) recorded under the given entity. Each row
carries the transaction date/amount, reconciled/pending flags, comment,
the debit and credit ledger accounts (code + name), and the polymorphic
counterparty (type, id, name; null when absent). Discarded entries are
excluded.

Filters (all optional): a transaction_at window via
transaction_at_start/transaction_at_end; debit_code/credit_code
(GL account codes — an unknown code returns no rows); reconciled and
pending (true/false); min_amount/max_amount; and
counterparty_type (+ optional counterparty_id).

Returns 404 when entity_id resolves to an entity in a different
account (cross-account requests are not distinguished from missing).

Creates a single journal entry (general-ledger / accounting transaction —
a double-entry GL posting) under the given entity. Posts one debit/credit
pair for the supplied amount and date. The entry is created unreconciled
(reconciled false, pending false). debit_code and credit_code are
GL account codes (see the chart-of-accounts endpoint) — they must differ
and both must resolve to a known accounting account. amount must be
numeric and greater than 0. transaction_at is an ISO date (YYYY-MM-DD).
An optional counterparty can be attached via counterparty_type +
counterparty_id; the counterparty must belong to the same account.

Returns 422 on invalid input (unknown code, equal debit/credit codes,
non-positive or non-numeric amount, malformed date, or a cross-account
counterparty), 403 for a read-only key, and 404 when entity_id
resolves to an entity in a different account.

Creates many journal entries (general-ledger / accounting transactions —
double-entry GL postings) under the given entity in a single atomic,
all-or-nothing batch. Each row in journal_entries is a full independent
entry validated by the same rules as the single-create endpoint:
debit_code and credit_code are GL account codes (see the
chart-of-accounts endpoint) that must differ and both resolve to a known
account, amount is numeric and greater than 0, transaction_at is an
ISO date (YYYY-MM-DD), and an optional counterparty may be attached via
counterparty_type + counterparty_id (same account).

Provide between 1 and 100 rows. EVERY row is validated first; if ANY row
is invalid the entire batch is rejected with 422 and a per-row errors
array ({index, field, message}) and NOTHING is created. When all rows
are valid they are created together inside one database transaction; any
unexpected failure rolls the whole batch back (never a partial commit).
All entries are created unreconciled (reconciled false, pending
false). Idempotency is the caller's responsibility — re-sending a batch
posts it again.

Returns 422 on validation failure or an out-of-range batch (empty or more
than 100 rows), 403 for a read-only key, and 404 when entity_id
resolves to an entity in a different account.

Returns a single journal entry (general-ledger / accounting transaction —
a double-entry GL posting): transaction date/amount, reconciled/pending
flags, comment, the debit and credit ledger accounts (code + name), and
the polymorphic counterparty (type, id, name; null when absent). Returns
404 when the entry is unknown, discarded, or belongs to a different
account (cross-account requests are not distinguished from missing).

Returns the chart of accounts (GL account codes) shared across the
account. Use this to discover valid account codes before posting
journal entries. Codes follow standard GL ranges: 1xxx=assets,
2xxx=liabilities, 3xxx=equity, 4xxx=revenue, 6xxx/7xxx=expenses. All
filters are optional and combine with AND. Results are paginated and
ordered by code.

Returns a single chart-of-accounts entry (GL account code) by its
integer id. Use after list_accounting_accounts to confirm a code
before posting a journal entry.

Returns the capital calls (draft/open/closed) issued from the given
entity's fund. Each row carries header fields: id, name, status,
percentage_to_call, notes, amount_being_called (sum of per-LP details),
created_at, closed_at, due_date, and the parent entity ref.

Filter by status and a date window via period_start /
period_end (both ISO dates; supply together). The window bounds
created_at by default; pass date_field=closed_at to bound close
dates instead (draft/open calls have no closed_at and drop out).

Per-LP wire line items: pass lp_query (partial LP name) to keep
ONLY calls containing a matching LP — the filter applies before
pagination, so an older matching call is never crowded out by newer
non-matching calls — and each returned row embeds lp_details for
the matching LPs (amount called, wired amount, wire date, variance,
payment_status). include_lp_details=true embeds lp_details for
every returned call without filtering. Embedded line items cap at 25
per call; use /api/v1/capital_calls/{id}/details for full per-LP
paging.

Ordering is deterministic: calls come back newest first
(created_at DESC, id DESC) and lp_details rows by id — both
total orders, so identical arguments always return identical rows in
an identical sequence.

The header money figures (amount_being_called, total_wired,
total_outstanding, total_variance, percentage_funded) ALWAYS
cover every LP on the call. They are NOT narrowed by lp_query and
NOT shrunk by the 25-row cap, so summing lp_details will not
reproduce them whenever the roster is filtered or truncated. Each row
carrying lp_details also carries lp_details_coverage
(returned, matched, call_total, truncated,
filtered_by_lp_query, totals_basis) which states exactly that
relationship — read it before describing the roster.

Returns 404 when entity_id belongs to a different account or is
not a fund/SPV.

Returns the header block for a single capital call. Use
/api/v1/capital_calls/{id}/details for per-LP rows.

Returns the per-capital-account line items (LPs/GPs) attached to a
capital call: amount called, the LP's committed capital, wired amount
and wire date (from reconciled wire transactions on the period),
variance (wired − called) and a derived payment_status
(fully_paid/underpaid/overpaid/unpaid/prepaid/over_commitment/
any_variance/unknown).

Returns a paginated list of financial report generation jobs that belong to the authenticated API key's account, regardless of which API key within that account created them. Sorted by created_at descending. Successful jobs include download URLs for the generated files.

Queues an asynchronous financial report generation job. The job includes every entity of the requested entity_type within the API key's account. Use the returned status_url to poll job status and download generated files after the job succeeds.

Returns the current status for a financial report generation job created by the authenticated API key. Successful jobs include download URLs for the generated files.

Gets a paginated list of Events in your account. The response will have a data array with the events and a pagination object with the total count, current page, and total pages. Pages are 0-indexed, so the first page is page 0. The Events returned can be filtered and ordered. Order direction is ascending by default. The default Event shape is compact. Use fields= to request other editable fields and include=hosts or include=guests for nested records.

Creates a new Event in your account. A successful request will return the created event data with success status. The event will automatically have an associated pipeline and questionnaire created for guest management. Events start public: send access_type=private_access ONLY when the user asks for a private or password-protected Event. A private Event is gated by its registration_code, which the response returns - after creating one, tell the user the registration code so they can share it.

Get a single Event by ID or unique_event_id. The default response contains the full editable Event contract and its hosts. The optional include= replaces the default host include with guests, hosts, or both. fields= narrows top-level fields. include_guests=true is preserved as a backwards-compatible alias for include=guests.

Update an existing Event. Only the provided fields will be updated. Events start public: send access_type=private_access ONLY when the user asks for a private or password-protected Event. After making one private, read the registration_code from the response back to the user - that code is the Event password.

Delete an Event and all associated data including pipeline and questionnaire.

Get the account defaults used for new Events.

Update the account defaults used for new Events.

Get a paginated list of guests for an event with their RSVP status and pipeline stage information. Results can be filtered by email or pipeline stage.

Add multiple guests to an event. Guests will be created as People if they don't exist and added to the event pipeline. The response includes arrays of added, duplicate, and error results for processing feedback.

Change the pipeline, RSVP, or attendance state for an Event guest.

Remove a guest and their RSVP from an Event.

List Event guests who are waiting for an invitation.

Queue invitations for Event guests who are waiting to be invited.

Download Event registrations and questionnaire answers as CSV.

Return bounded aggregate metrics for one Event. Page views count distinct tracking rows in both legacy and current formats and are zero for an unpublished Event. Guestlist and attended count current kept prospects in those exact pipeline stages. Invited counts current kept prospects in the Invited, Clicked, and RSVP-No stages. Capacity uses RSVP-Yes as occupied seats. Registration total is the sum of current yes, no, and waiting-list RSVP records; questionnaire responses count distinct respondents.

Update a guest's RSVP status for an event. This will also update the guest's pipeline stage accordingly.

Gets a paginated list of Files in your Files. The response will have a data array with the files and a pagination object with the total count, current page, and total pages. Pages are 0-indexed, so the first page is page 0. The Files returned can be filtered and ordered. Order direction is ascending by default. With folder_id, only current versions are returned. Each file's data_room_folder_files includes id, folder_id, version_group_id and new_version_id. Match version_group_id within the folder to track a document across byte replacements; the enclosing file id identifies the current bytes.

Uploads a new file, either from bytes or by copying a file that already
lives in Hub.

Request format

Send multipart/form-data with file params nested under the file
key, or, when there is no upload, a JSON body with top-level
hub_source_url and folder_id (this is what the agent runtime sends):

- file[file] — the upload
- file[hub_source_url] — the URL of a Hub file the caller can already
read: a Base attachment download URL
(/api/v1/base/attachments/{id}), a data room file download URL
(/api/v1/files/{id}/download) or a pipeline prospect attachment
download URL. The server resolves the URL on its own routes (no
outbound request), applies the same read authorization as that
endpoint, and copies the bytes into a new file. A non-Hub host is
400; a Hub URL that is not a file is 404; a file the caller may
not read is 403.
- Exactly one of file[file] or file[hub_source_url] is required;
both or neither is 400.
- file[name] — optional custom name
- file[description] — optional description
- folder_id — optional, top-level (not under file[]). If omitted,
the file is placed in the account's default folder.
- file[attachable_type] and file[attachable_id] — optional pair. When
both are provided, the upload is *also* attached to the given record so
it appears in that record's attachment list (in addition to landing in
the data room). Allowed attachable_type values: Person,
Organization, PipelineProspect. For PipelineProspect, the
attachment is routed to the prospect's underlying prospectable
(Person or Organization) — this matches UI behavior.

Supported extensions

.ppt, .pptx, .key, .doc, .docx, .xlsx, .mov, .mp4, .ogg,
.pdf, .png, .jpg, .jpeg. To save rows as a CSV, use
POST /api/v1/files/save_csv_to_folder.

Idempotent copies

With file[hub_source_url], a target folder that already holds a file
with the same checksum answers 200 with that existing file and
status: unchanged instead of creating a duplicate.

Example

``
curl -X POST https://decilehub.com/api/v1/files \
-H "Authorization: Bearer $TOKEN" \
-F "file[file]=@./doc.pdf" \
-F "file[name]=My Doc" \
-F "folder_id=123"

curl -X POST https://decilehub.com/api/v1/files \
-H "Authorization: Bearer $TOKEN" \
-F "file[hub_source_url]=https://acme.decilehub.com/api/v1/base/attachments/<signed_id>" \
-F "folder_id=123"
``

Gets details for a specific file, including metadata and associated folders. Each data_room_folder_files entry includes id, folder_id, version_group_id (stable across byte replacements) and new_version_id (the next placement ID, not a file ID). Historical file IDs remain readable. List files with folder_id and match version_group_id to find the current file ID. A file can have independent version groups in multiple folders; legacy groups may be null.

Updates a file. You can update just the metadata (name/description),
or upload a new version of the file — uploading a new file creates a new
version while maintaining history. The returned data.id is the new file
version's ID. data.data_room_folder_files[].version_group_id is the stable
pointer shared by that placement's versions. List files with its folder_id
and match version_group_id to find the current file ID for later operations.
Metadata-only updates keep the same file ID.

Request format

Must be sent as multipart/form-data with params nested under the
file key. All fields are optional:

- file[name] — updated name
- file[description] — updated description
- file[file] — new file upload (creates a new version)

Recoverably deletes a Data Room file and removes all its folder placements
and their version history from folders. Stored bytes are retained; other
file-version records are not deleted. Uses the existing file deletion policy.
Intake/questionnaire attachment IDs are not supported.

Downloads a file from your Files. Returns the file content with appropriate headers for download. A file over 100 MB answers 302 with a Location that is a signed storage URL, valid for five minutes.

Saves an in-message file (an Attachment) into a data room folder so it is
durably stored and visible to the folder's audience.

The {id} path parameter is the Attachment id. The target folder is given
by the required top-level folder_id in the JSON body.

The operation is idempotent on the pair of (file content, folder): if the
same file content already exists in the folder, no new placement is created
and the existing one is returned with status: unchanged. Otherwise a new
placement is created and returned with status: created.

The response includes folder_path (a breadcrumb such as "Parent > Child")
and audience (a human readable phrase describing who can see the file),
which the agent uses to compose its success message.

Serializes a structured {headers, rows} payload into a CSV file
server-side (Ruby CSV, correct quoting) and places it in a data room
folder. Built for the agent "export this list as a CSV" flow: the agent
passes rows it produced with other tools; no file bytes or base64 travel
through the request.

Every row must be exactly as long as headers, cells must be scalars
(string, number, boolean, or null), and the whole payload is capped at
5,000 cells including the header row. filename is sanitized (path
segments stripped) and .csv is appended server-side.

The response mirrors save_to_folder (folder_path, audience) and adds
file_name plus file_url, a deep link to the saved file the agent can
hand to the user.

Generates a personalized data room preview link that grants a specific
person or pipeline prospect direct access to a file or folder. External
services use this to hand a recipient a ready-to-open link on behalf of a
prospect: the returned url carries the recipient's access code, so
opening it establishes their data room session without a login.

Provide exactly one recipient (person_id or pipeline_prospect_id) and
exactly one target (folder_id or file_id). When a file_id is given,
the link resolves the file's current folder placement and deep-links to the
file's preview within the personalized folder context.

A prospect must resolve to a contact person (a Person prospect, or an
Organization prospect with a primary contact); otherwise the request is
rejected with 400 bad_request.

Gets a paginated list of Folders in your Files. The response will have a data array with the folders and a pagination object with the total count, current page, and total pages. Pages are 0-indexed, so the first page is page 0. The Folders returned can be filtered and ordered. Order direction is ascending by default.

Creates a new folder in your Files. You can optionally specify a parent folder by providing a parent_id. Folder names must be unique within the same parent folder.

Gets details for a specific folder, including optional child folders and files. Use the contents parameter to specify what to include: "folders", "files", or "folders,files". Default includes both folders and files.

Searches data room folders by name to help disambiguate a user's folder
reference (for example "save it to Acme") into folder ids.

Only folders in your account that you can read are returned. The match is
case insensitive on the folder name and is capped at 50 results. Each match
includes the folder id, name, a breadcrumb path (for example "Parent > Child"),
and an audience phrase describing who can see files saved to that folder. The
agent uses these to compose its confirmation request.

The q parameter is required (a missing or blank q returns 400). A query
that matches no folders returns an empty matches array.

Gets a paginated list of Organizations in your Organizations Directory. The response will have a data array with the organizations and a pagination object with the total count, current page, and total pages.Pages are 0-indexed, so the first page is page 0.The Organizations returned can be filtered and ordered. Order direction is ascending by default. The default response shape is unchanged from prior versions and embeds notes, people, and submit_your_company_response_data. The optional include= parameter is purely opt-in - when supplied it replaces the default include set with a caller-specified subset; absent the parameter, the legacy default is returned verbatim. fields= narrows top-level columns when supplied. In the Decile Partners account each organization also carries hub_account_id, hub_account_unlinked (true when a Decile admin recorded "no Hub account") and hub_account ({id, name, subdomain}, or null).