List Fund Investment Documents
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
portfolioId
string
required
The ID of the portfolio for which to retrieve fund investment documents.
pageToken
string
The page token received from a previous List Fund Documents call. Provide this token to retrieve the subsequent page.
When paginating, all other parameters provided to List Fund Documents must match the call that received the page token.
pageSize
int32
The maximum number of fund investment documents to return. The service may return fewer than this value.
If unspecified, at most 25 documents will be returned.
The maximum value is 50; values above 50 will be coerced to 50.
fundId
string
The ID of the fund for which to retrieve fund investment documents.
effectiveDateAfter
string
Return fund documents with effective dates on or after this date, specified as an ISO 8601 extended format calendar date, i.e. 'YYYY-MM-DD'.
effectiveDateBefore
string
Return fund documents with effective dates on or before this date, specified as an ISO 8601 extended format calendar date, i.e. 'YYYY-MM-DD'.
sharedDateAfter
string
Return fund documents with shared dates on or after this date, specified as an ISO 8601 extended format calendar date, i.e. 'YYYY-MM-DD'.
sharedDateBefore
string
Return fund documents with shared dates on or before this date, specified as an ISO 8601 extended format calendar date, i.e. 'YYYY-MM-DD'.
``200 A successful response.
object
The response for the ListFundInvestmentDocuments endpoint.
fundInvestmentDocuments
array of objects
The fund investment documents for the portfolio.
If this list is empty, then there are no fund investment documents for the portfolio, the user does not have access
to any fund investment documents for the portfolio, or the fund investment documents have been filtered out.
fundInvestmentDocuments
object
A document shared with limited partners to provide information about a fund investment held within a portfolio.
documentId
string
required
length between 1 and 50
The identifier of the document.
fundId
string
required
length between 1 and 50
The identifier of the fund that issued the document.
firmId
string
required
length between 1 and 50
The identifier of the firm managing the fund.
documentName
string
required
length ≥ 1
The name of the document.
fundName
string
required
length ≥ 1
The name of the fund.
firmName
string
required
length ≥ 1
The name of the firm managing the fund.
effectiveDate
object
required
The effective date of the document.
effectiveDate object
sharedDate
object
required
The date the document was shared.
sharedDate object
nextPageToken
string
Submit the nextPageToken string as pageToken in a subsequent request to retrieve the next page.
If the List Fund Investment Documents response omits nextPageToken, then there are no subsequent pages.
``400 Returned if required fields are omitted or if provided fields fail validation.
``401 Returned if a valid Authorization header has not been included with the request.
``403 Returned when the user does not have permission to access the resource.
``500 Returned if an unexpected internal server error is encountered.
``default An unexpected error response.
Updated about 2 months ago
ShellNodeRubyPHPPython
Bearer
Base URL
https://mock-api.carta.com/v1alpha1/portfolios/{portfolioId}/fundInvestmentDocuments
xxxxxxxxxx
curl --request GET \
--url https://mock-api.carta.com/v1alpha1/portfolios/portfolioId/fundInvestmentDocuments \
--header 'accept: application/json'
xxxxxxxxxx
{
"fundInvestmentDocuments": [\\
\\
{\\
\\
"documentId": "J8X32hD6yttzNJULdzeugV",\\
\\
"fundId": "09051fa3-fe71-4613-9bfb-e5bfa396cfea",\\
\\
"firmId": "7af7123a-2ee9-4e31-a173-54b8f9159426",\\
\\
"documentName": "Capital Call Notice",\\
\\
"fundName": "Krakatoa Ventures Fund I, L.P.",\\
\\
"firmName": "Krakatoa Ventures",\\
\\
"effectiveDate": {\\
\\
"value": "2024-01-01"\\
\\
},\\
\\
"sharedDate": {\\
\\
"value": "2024-01-02"\\
\\
}\\
\\
},\\
\\
{\\
\\
"documentId": "XHxXSp7VmgW6t1T99sXAjP",\\
\\
"fundId": "85d952d3-5076-4e02-8872-ea175ec5f90d",\\
\\
"firmId": "7af7123a-2ee9-4e31-a173-54b8f9159426",\\
\\
"documentName": "Capital Call Notice",\\
\\
"fundName": "Krakatoa Ventures Fund II, L.P.",\\
\\
"firmName": "Krakatoa Ventures",\\
\\
"effectiveDate": {\\
\\
"value": "2023-06-01"\\
\\
},\\
\\
"sharedDate": {\\
\\
"value": "2023-06-02"\\
\\
}\\
\\
}\\
\\
],
"nextPageToken": "ODMxMw=="
}