List Firms

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

pageSize
int32

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

If unspecified, at most 25 firms will be returned.

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

pageToken
string

The page token received in a previous List Firms response. Submit this token to retrieve the subsequent page.

When paginating, all other parameters provided to ListFirms must match the call that received the page token.

``200 A successful response.

object

The response from the List Firms endpoint.

firms

array of objects

The firms returned in the List Firms response.

firms

object

A firm.

id

string

length ≤ 50

The identifier of the investment firm.

name

string

length ≤ 1000

The name of the investment firm.

nextPageToken

string

Submit the nextPageToken string as pageToken in a subsequent List Firms request to retrieve the next page. If the List Firms 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.

Base URL
https://mock-api.carta.com/v1alpha1/investors/firms


xxxxxxxxxx

curl --request GET \
 
     --url https://mock-api.carta.com/v1alpha1/investors/firms \
 
     --header 'accept: application/json'

xxxxxxxxxx

{
  "firms": [
    {
      "id": "7af7123a-2ee9-4e31-a173-54b8f9159426",
      "name": "Krakatoa Ventures"
    }
  ],

"nextPageToken": "ODMxMw=="
}