Headers

• X-PLANNR-ACCOUNT-UUID string

Query parameters

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[level] integer

  Filter by the numeric level value. Whole number between 1 and 1,000.

• filter[level_string] string

  Filter by the string/text version of risk level of the client.

• filter[completed_after] string

  Date (with optional time) to filter when the record was created after.

• filter[completed_before] string

  Date (with optional time) to filter when the record was created before.

• filter[risk_assessment_provider] string

  Filter by the name of provider for the risk assessment.

• filter[time_horizon_set_after] string

  Date (with optional time) to filter when the record was created after.

• filter[time_horizon_set_before] string

  Date (with optional time) to filter when the record was created before.

• filter[account_uuids] string

  Filter by a comma separated list of account UUIDs.

• filter[circle_uuids] string

  Filter by a comma separated list of circle UUIDs.

• include string

  Comma separated list of relationships to include in the response. Valid relationships are [account, completed_by].

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, level, level_string, completed_at, risk_assessment_provider, time_horizon_set_at]. Negative sign to denote DESC. Defaults to 'created_at'.

• per_page integer

  Number of results to return with pagination (Default 15. Max 500).

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • data array[object]
    Hide data attributes Show data attributes object

    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • level integer

      The risk level of the clients risk assessment. Cannot be set with level_string

    • level_string string

      The risk level of the client as a string/text. Cannot be set with level.

    • completed_at string

      Date of risk assessment completion.

    • completed_by object

      Account of the employee that completed the risk assessment

      Hide completed_by attributes Show completed_by attributes object

      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • business_unit string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object

        • firm:read array[string]
        • network:read array[string]
      • custom_fields string
      • external_references string
    • risk_assessment_provider string

      Name of the risk assessment provider.

    • time_horizon string

      How long the risk assessment will last for the client.

    • time_horizon_set_at string

      The date the time_horizon was set. Can be used as a reference point against time horizon for users.

    • account object

      The account who owns the Risk. This may not be included when viewing all risks. Refer to the documentation to include this field.

      Hide account attributes Show account attributes object

      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • external_references string