Deal dropdown lookups
/deals/lookupsReturns the deal dropdown catalogue so a UI or integration can populate the
structure and sub-structure selects and the structure-specific type_details
dropdowns without hardcoding enum values. It is an aggregate, so it is not
paginated. Each lookup is a list of { value, label }, where value is what
create and update accept and label is a humanised rendering of it. Lookup
keys map onto the type_details field names (e.g. sectors -> the sector
key, growth_stages -> growthStage).
The structures, sub_structures, sectors and sub_sectors values are the
ones GET /deals accepts in filter[structure], filter[sub_structure],
filter[sector] and filter[sub_sector].
Two of the keys are about status. statuses is the fixed publishing
lifecycle. custom_statuses is this organisation's own investor-facing
labels ("Live", "Closed", ...), whose value is a uuid rather than a
slug; those are what GET /deals?filter[custom_status]= filters on and what
POST /deals/{id}/actions/set-custom-status sets. An organisation that has
not configured any returns an empty list.
Lookups backed by rows rather than fixed values are not here: list locations
with GET /locations, deal tab types with GET /deal-tab-types and
currencies with GET /currencies.
Responses
{
"data": {
"structures": [
{
"value": "direct",
"label": "Direct"
},
{
"value": "fund",
"label": "Fund"
},
{
"value": "tradeable",
"label": "Tradeable"
}
],
"sub_structures": [
{
"value": "debt",
"label": "Debt"
},
{
"value": "equity",
"label": "Equity"
},
{
"value": "hybrid",
"label": "Hybrid"
},
{
"value": "multi_asset",
"label": "Multi Asset"
},
{
"value": "real_assets",
"label": "Real Assets"
},
{
"value": "real_estate",
"label": "Real Estate"
},
{
"value": "earthshot_solution",
"label": "Earthshot Solution"
}
],
"asset_classes": [
{
"value": "debt",
"label": "Debt"
},
{
"value": "equity",
"label": "Equity"
},
{
"value": "hybrid",
"label": "Hybrid"
},
{
"value": "multi_asset",
"label": "Multi Asset"
},
{
"value": "real_assets",
"label": "Real Assets"
},
{
"value": "real_estate",
"label": "Real Estate"
},
{
"value": "earthshot_solution",
"label": "Earthshot Solution"
}
],
"sectors": [
{
"value": "communication_services",
"label": "Communication Services"
},
{
"value": "consumer_discretionary",
"label": "Consumer Discretionary"
},
{
"value": "consumer_staples",
"label": "Consumer Staples"
},
{
"value": "energy",
"label": "Energy"
},
{
"value": "financials",
"label": "Financials"
},
{
"value": "healthcare",
"label": "Healthcare"
},
{
"value": "industrials",
"label": "Industrials"
},
{
"value": "information_technology",
"label": "Information Technology"
},
{
"value": "materials",
"label": "Materials"
},
{
"value": "real_estate",
"label": "Real Estate"
},
{
"value": "utilities",
"label": "Utilities"
}
],
"growth_stages": [
{
"value": "pre_seed",
"label": "Pre Seed"
},
{
"value": "seed",
"label": "Seed"
},
{
"value": "start_up",
"label": "Start Up"
},
{
"value": "early_stage_ventures",
"label": "Early Stage Ventures"
},
{
"value": "growth",
"label": "Growth"
},
{
"value": "pre_ipo",
"label": "Pre Ipo"
},
{
"value": "public",
"label": "Public"
},
{
"value": "distressed",
"label": "Distressed"
}
],
"tax_reliefs": [
{
"value": "vct",
"label": "Vct"
},
{
"value": "eis",
"label": "Eis"
},
{
"value": "seis",
"label": "Seis"
},
{
"value": "sitr",
"label": "Sitr"
},
{
"value": "aitd",
"label": "Aitd"
},
{
"value": "tax_shelter",
"label": "Tax Shelter"
},
{
"value": "tax_relief",
"label": "Tax Relief"
},
{
"value": "not_applicable",
"label": "Not Applicable"
}
],
"earthshot_prize_statuses": [
{
"value": "finalist",
"label": "Finalist"
},
{
"value": "nominee",
"label": "Nominee"
},
{
"value": "winner",
"label": "Winner"
}
],
"statuses": [
{
"value": "draft",
"label": "Draft"
},
{
"value": "awaiting_approval",
"label": "Awaiting Approval"
},
{
"value": "ready_to_publish",
"label": "Ready To Publish"
},
{
"value": "published",
"label": "Published"
},
{
"value": "retired",
"label": "Retired"
},
{
"value": "in_progress",
"label": "In Progress"
},
{
"value": "rejected",
"label": "Rejected"
}
],
"custom_statuses": [
{
"value": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
"label": "Closed"
}
]
}
}Authorization failed. error.code is one of org_disabled,
ip_blocked, missing_scope, scope_disabled, user_disabled.
Examples
curl https://your-org-domain/kong/core/api/v2/deals/lookups\
-H "Authorization: Bearer $HELM_API_KEY"\
-H "Content-Type: application/json"