Headers

• X-PLANNR-ACCOUNT-UUID string

Query parameters

• include string

  Comma separated list of relationships to include in the response. Valid relationships are [accounts].

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[name] string

  Filter by name.

• filter[description] string

  Filter by description.

• filter[progress] string

  Filter by progress. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.

• filter[complete_goal_by] string

  Filter by Complete Goal By. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.

• filter[priority] string

  Filter by priority. Can use operands such as >=, <>, > and combine as a range by providing two values separated by comma.

• 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.

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, progress, complete_goal_by, priority]. 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
    • name string
    • description string
    • target_amount object
      Hide target_amount attributes Show target_amount attributes object

      • amount object
        Hide amount attributes Show amount attributes object

        • example string
        • description string
      • formatted object
        Hide formatted attributes Show formatted attributes object

        • example string
        • description string
      • currency object
        Hide currency attributes Show currency attributes object

        • example string
        • description string
    • progress string
    • timeframe string
    • complete_goal_by string
    • priority string
    • shared_owner_type string
    • shared_owner object
      Hide shared_owner attributes Show shared_owner 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