GuidesRecipesAPI Reference
Log In
Guides

Retrieve a fund vehicle entity

Retrieves the details of a single fund vehicle

These endpoints return fund vehicle information with a full list of fields and require the integer and string fund vehicle ID respectively as identifying parameter

Fetching with integer ID

Value
HTTP MethodGET
Path​/api​/entities​/fundvehicle​/{scopeId}​/{fundVehicleId}
Request parametersScope ID: A scope ID in which you want to retrieve investor entity information.

Fund vehicle ID
Reference[getsinglefundvehicle]

Request example

curl --request GET \
     --url https://quantiumfundwebapi.azurewebsites.net/api/entities/fundvehicle/scopeId/{fundVehicleId} \
     --header 'Authorization: Bearer eyJhbGciOiJSUzI1N...'

Parsing fund vehicle response

The return result of the fund entity list API is in an array of fund entity objects. Fund objects returned from the list API have standard fieldsets which were described on the Fund Vehicle Entity page

{
  "id": 6,
  "typeId": 1,
  "type": "Main fund",
  "name": "USD Fund I",
  "currencyCode": "USD",
  "legalName": "USD Fund I Limited",
  "chineseName": "",
  "managementCompanyName": "",
  "vintageYear": "",
  "placeOfIncorporationId": 0,
  "placeOfIncorporation": "",
  "dateOfIncorporation": "",
  "firstOfClosing": "2019-01-01",
  "finalClosing": "",
  "terminationDate": "",
  "financingCategory": null,
  "strategyDescription": null,  
 }

Fetching with string ID

Value
HTTP MethodGET
Path/api/entities/fundvehicle/{scopeId}/{fundVehicleInternalId}
Request parametersScope ID: A scope ID in which you want to retrieve investor entity information.

Fund vehicle ID
ReferenceLink

Request example

curl --request GET \
     --url https://quantiumfundwebapi.azurewebsites.net/api/entities/fundvehicle/scopeId/{fundVehicleInternalId} \
     --header 'Authorization: Bearer eyJhbGciOiJSUzI1N...'