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
    • created_at string
    • updated_at string
    • level integer
    • level_string string
    • completed_at string
    • completed_by object
      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
      • 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
      • 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
      • ownership_percentage integer
      • inactive_at string
      • custom_fields string
      • external_references string
    • risk_assessment_provider string
    • time_horizon string
    • time_horizon_set_at string
    • account object
      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