Get Portfolio Note

GET /portfolio_notes/{id}

Returns a single portfolio note by ID.

Path parameters

  • id string(uuid) Required

    ID of the portfolio note

Responses

  • 200 application/json

    Successfully retrieved portfolio note

    Hide response attribute Show response attribute object
    • portfolio_note object
      Hide portfolio_note attributes Show portfolio_note attributes object
      • name string Required

        Name/title of the portfolio note

      • portfolio_company_profile_id string(uuid) Required

        ID of the associated portfolio company profile

      • plaintext_content string Required

        Plaintext content of the note

      • created_at string(date-time)

        When the portfolio note was created

  • 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

  • 404 application/json

    Not Found - The requested resource was not found

    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_notes/{id}
curl \
 --request GET 'https://api.visible.vc/portfolio_notes/{id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "portfolio_note": {
    "name": "A note",
    "created_at": "2025-02-01T22:08:21.175Z",
    "plaintext_content": "This is a note",
    "portfolio_company_profile_id": "ec5252fe-9abc-4096-85e9-1374e70a3182"
  }
}
Response examples (401)
{
  "errors": [
    {
      "type": "unauthorized"
    }
  ]
}
Response examples (403)
{
  "errors": [
    {
      "type": "forbidden"
    }
  ]
}
Response examples (404)
{
  "errors": [
    {
      "type": "record_missing"
    }
  ]
}
Response examples (429)
{
  "errors": [
    {
      "type": "rate_limit_exceeded"
    }
  ]
}