List Cash Balances

get

https://mock-api.carta.com/v1alpha1/investors/firms/{firmId}/funds/{fundId}/cashBalances

Scope(s): read_investor_cashbalances

Retrieve a list of cash balances for a given firm and fund. This endpoint also supports returning cash balances across all funds of a firm if the caller submits a - (dash) character for the fund identifier.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

firmId

string

required

The firm ID for which to retrieve cash balances.

fundId

string

required

The fund ID for which to retrieve cash balances. Use a - (dash) to retrieve metrics for all funds.

Query Params

asOfDateTime

date-time

The date and time as of which the data should be retrieved. Uses UTC and is specified in ISO 8601 format, i.e. 'YYYY-MM-DDThh:mm:ssZ'. If unspecified, defaults to the current date and time.

pageSize

int32

The maximum number of results to return. The service may return fewer than this value.

If unspecified, at most 25 items will be returned.

The maximum value is 50; values above 50 will be coerced to 50.

pageToken

string

A page token received as nextPageToken in a previous response. Provide this to retrieve the subsequent page.

When paginating, all other parameters must be kept consistent with those used in the request where the page token was obtained.

Responses

200A successful response.

400Returned if required fields are omitted or if provided fields fail validation.

401Returned if a valid Authorization header has not been included with the request.

403Returned when the user does not have permission to access the resource.

500Returned if an unexpected internal server error is encountered.

defaultAn unexpected error response.