List Portfolio Properties

GET /portfolio_properties
Bearer auth

Returns a paginated collection of portfolio properties for a company.

Portfolio properties define the custom fields that can be used to store data about portfolio companies. This endpoint also returns auto-calculated investment properties.

Query parameters

  • company_id string(uuid) Required

    ID of your company or fund

  • page integer

    Page number

    Minimum value is 1. Default value is 1.

Responses

  • 200 application/json

    Successfully retrieved portfolio properties

    Hide response attributes Show response attributes object
    • portfolio_properties array[object]
      Hide portfolio_properties attributes Show portfolio_properties attributes object
      • id string(uuid) Required

        Unique identifier for the portfolio property

      • name string Required

        Name of the portfolio property

      • data_type string Required

        Data type of the property

        Values are number, date, boolean, select, multiselect, string, text, or url.

      • company_id string(uuid) Required

        ID of the company or fund

    • meta object
      Hide meta attributes Show meta attributes object
      • total integer Required

        Total number of items across all pages

      • total_pages integer Required

        Total number of pages

      • page integer Required

        Current page number
  • 400 application/json

    Bad Request - The request is invalid or malformed

    Hide response attribute Show response attribute object
    • errors array[object] Required

      Single error item. Different error types can include different fields.

      Hide errors attributes Show errors attributes object
      • type string

        Machine-readable error type

      • field string

        The related field, if applicable

      • message string

        Human-readable error message
  • 401 application/json

    Unauthorized - Invalid or missing authentication token

    Hide response attribute Show response attribute object
    • errors array[object] Required

      Single error item. Different error types can include different fields.

      Hide errors attributes Show errors attributes object
      • type string

        Machine-readable error type

      • field string

        The related field, if applicable

      • message string

        Human-readable error message
  • 403 application/json

    Forbidden - The authenticated user does not have access to the requested resource

    Hide response attribute Show response attribute object
    • errors array[object] Required

      Single error item. Different error types can include different fields.

      Hide errors attributes Show errors attributes object
      • type string

        Machine-readable error type

      • field string

        The related field, if applicable

      • message string

        Human-readable error message
  • 429 application/json

    Too Many Requests - Rate limit exceeded

    Hide response attribute Show response attribute object
    • errors array[object] Required

      Single error item. Different error types can include different fields.

      Hide errors attributes Show errors attributes object
      • type string

        Machine-readable error type

      • field string

        The related field, if applicable

      • message string

        Human-readable error message
GET /portfolio_properties 
curl \
 --request GET 'https://api.visible.vc/portfolio_properties?company_id=string' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "meta": {
    "page": 1,
    "total": 3,
    "total_pages": 1
  },
  "portfolio_properties": [
    {
      "id": "ec5252fe-9abc-4096-85e9-1374e70a3182",
      "name": "Industry",
      "data_type": "select",
      "company_id": "cad09a10-73e8-4205-ae67-4e6156f37be8"
    },
    {
      "id": "f1d234a8-2bcd-4567-89ef-3c45d6789012",
      "name": "Employee Count",
      "data_type": "number",
      "company_id": "cad09a10-73e8-4205-ae67-4e6156f37be8"
    },
    {
      "id": "12345678-9abc-def0-1234-56789abcdef0",
      "name": "Total Invested",
      "data_type": "number",
      "company_id": "cad09a10-73e8-4205-ae67-4e6156f37be8"
    }
  ]
}
Response examples (400) 
{
  "errors": [
    {
      "type": "parameter_invalid",
      "field": "filter",
      "message": "must be an object"
    }
  ]
}
Response examples (401) 
{
  "errors": [
    {
      "type": "unauthorized"
    }
  ]
}
Response examples (403) 
{
  "errors": [
    {
      "type": "forbidden"
    }
  ]
}
Response examples (429) 
{
  "errors": [
    {
      "type": "rate_limit_exceeded"
    }
  ]
}