This route is used to get the history of a capital event (Capital Call / Distribution), given a set of search filters.
This endpoint returns paginated data. Up to 100 can be extracted per call.
This endpoint can be called by applications with access to scope "readCapitalEvent".
The number of rows being retrieved. Must be a positive integer.
The offset (i.e. row start index). Must be a positive integer (or 0).
The block number where the action was recorded on the ledger.
350The transaction id where the action was recorded on the ledger.
456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$The name of the channel where the action was recorded on the ledger.
OG123Pattern: ^[a-zA-Z0-9-]*$The comma delimited list of capital event correlation ids to filter the capital event history records. Up to 100 records can be provided. Each record should not exceed 100 characters.
USCCWSF01I00,USCCWSF01I01The organization identifier linked to the correlation ids provided in the "capitalEventCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.
The comma delimited list of capital event ids to filter the capital event history records. Up to 100 records can be provided. Each record should not exceed 12 characters.
USCCWSF01I00,USCCWSF01I01GET /external/v1/capital-events/history HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"signerData": {
"name": "John Doe",
"email": "[email protected]"
},
"timestamp": "2024-09-12T00:00:00.000Z",
"blockNumber": 350,
"transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
"channelName": "OG123",
"organization": {
"name": "Test Organization",
"orgId": "TEST1234"
},
"event": "Created",
"update": {
"type": "capitalCall",
"endDate": "2024-09-12T00:00:00.000Z",
"amountCalled": 100000,
"expenses": 2000,
"organization": {
"orgId": "TEST1234",
"name": "Test Organization"
},
"breakdown": [
{
"categoryId": "USS3JKS01I00",
"amount": 9000
},
{
"categoryId": "USS3JKS01I01",
"amount": 10000
},
{
"categoryId": "USS3JKS01I02",
"amount": 2000,
"extraData": {
"other": "Fund Level Information"
}
}
],
"status": "draft",
"capitalEventId": "US9QIMAOAS1Q",
"securityId": "USS3JKS01I00"
}
}
]