GET /portfolio_property_options
Bearer auth

Returns the list of options for a given portfolio property.

Options are used by select and multiselect portfolio properties to define the allowed values.

Query parameters

  • portfolio_property_id string(uuid) Required

    ID of the portfolio property whose options you want to list

  • label string

    Optional label to filter options by (case-insensitive match)

Responses

  • 200 application/json

    Successfully retrieved portfolio property options

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

        Unique identifier for the portfolio property option

      • label string Required

        Human-readable label for the option

      • portfolio_property_id string(uuid) Required

        ID of the portfolio property this option belongs to
  • 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_property_options 
curl \
 --request GET 'https://api.visible.vc/portfolio_property_options?portfolio_property_id=string' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "portfolio_property_options": [
    {
      "id": "ec5252fe-9abc-4096-85e9-1374e70a3182",
      "label": "Option A",
      "portfolio_property_id": "cad09a10-73e8-4205-ae67-4e6156f37be8"
    },
    {
      "id": "f1d234a8-2bcd-4567-89ef-3c45d6789012",
      "label": "Option B",
      "portfolio_property_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"
    }
  ]
}