List Portfolio Company Profiles

GET /portfolio_company_profiles
Bearer auth

Returns a paginated collection of portfolio company profiles.

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 company profiles

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

        Unique identifier for the portfolio company profile

      • name string Required

        Name of the portfolio company

      • created_at string(date-time) Required

        When the portfolio company profile was created

      • 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
  • 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_company_profiles 
curl \
 --request GET 'https://api.visible.vc/portfolio_company_profiles?company_id=cad09a10-73e8-4205-ae67-4e6156f37be8' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "meta": {
    "page": 1,
    "total": 2,
    "total_pages": 1
  },
  "portfolio_company_profiles": [
    {
      "id": "ec5252fe-9abc-4096-85e9-1374e70a3182",
      "name": "Portfolio company 1",
      "company_id": "cad09a10-73e8-4205-ae67-4e6156f37be8",
      "created_at": "2023-02-01T22:08:21.175Z"
    },
    {
      "id": "56a1bed4-9ac4-4bd1-8533-077f3ae465c3",
      "name": "Portfolio company 2",
      "company_id": "cad09a10-73e8-4205-ae67-4e6156f37be8",
      "created_at": "2022-02-01T22:08:21.175Z"
    }
  ]
}
Response examples (400) 
{
  "errors": [
    {
      "type": "parameter_invalid",
      "field": "filter",
      "message": "must be an object"
    }
  ]
}
Response examples (401) 
{
  "errors": [
    {
      "type": "unauthorized"
    }
  ]
}
Response examples (429) 
{
  "errors": [
    {
      "type": "rate_limit_exceeded"
    }
  ]
}