Get a list of advice types

GET /api/v1/static/advice-types/{type}

Path parameters

  • type string Required

    Optional parameter. Type parameter is optional and defaults to income-reconciliation. Valid options are [income-reconciliation, new-business-events].

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • name string
      • value string
GET /api/v1/static/advice-types/{type}
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/static/advice-types/{"value"=>"", "summary"=>"When the value is omitted"}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "data": [
    {
      "name": "Advised",
      "value": "advised"
    },
    {
      "name": "Execution Only",
      "value": "execution_only"
    },
    {
      "name": "Insistent Investor",
      "value": "insistent_investor"
    },
    {
      "name": "Existing Provision",
      "value": "existing_provision"
    },
    {
      "name": "Direct Offer",
      "value": "direct_offer"
    },
    {
      "name": "Client Instruction",
      "value": "client_instruction"
    }
  ]
}