Headers

• X-PLANNR-ACCOUNT-UUID string

Query parameters

• include string

  Comma separated list of relationships to include in the response. Valid relationships are [participants, participants_count, type, status, tags, plans, custom_fields,groups,assigned_to].

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[completed] boolean

  Filter cases by which have been completed

• filter[in_progress] boolean

  Filter cases by which are still in progress

• filter[type] string

  Comma separated list of case type UUIDs. Example fc4e2fad-d4f1-5c56-a869-60edc441ae16,add547bc-6097-5339-aaba-cbea59e79ee1

• filter[status] string

  Comma separated string of statuses to filter by

• filter[tags] string

  Comma separated string of tags to filter by

• filter[plan_uuid] string

  Comma separated string of plan UUIDs to filter by.

• filter[account_uuids] string

  Comma separated string of account UUIDs to filter by.

• filter[circle_uuids] string

  Comma separated string of circle UUIDs to filter by.

• filter[employee_account_uuids] string

  Comma separated string of employee accounts UUIDs to filter by.

• filter[completed_after] string

  Filter cases which have a completed at date after.

• filter[completed_before] string

  Filter cases which have a completed at date before.

• filter[review_at_after] string

  Filter cases which have a review at date after.

• filter[review_at_before] string

  Filter cases which have a review at date before.

• per_page integer

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

• sort string

  Field to sort by. Valid fields are [created_at, name, status_position, value, completed_at, review_at]. Negative sign to denote DESC. Defaults to 'name'.

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.

    • name string

      Name of the case

    • slug string

      Slug of the case

    • status object

      Case status

      Hide status attributes Show status attributes object

      • uuid string
      • created_at string
      • updated_at string
      • name string
      • colour string
      • position integer
      • is_type_completed boolean
    • type object

      Case type

      Hide type attributes Show type attributes object

      • uuid string
      • name string
      • created_at string
      • updated_at string
    • review_at string

      Timestamp of when the case should be reviewed

    • assigned_to_uuids array[string]

      UUIDs of accounts that will be assigned to the case when it is created.

    • group_uuids array[string]

      UUIDs of groups that will be assigned when the case is created.

    • completed_at string

      Timestamp of when the case was completed

    • value object

      Expected value of this case

      Hide value attributes Show value 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
    • status_position integer

      The case status's position on the status list. Starting from 1. Only used if you are formatting cases in a kanban layout.

    • participants_count integer

      The number of participants on the case

    • participants object

      Participants on this case (if included)

      Hide participants attributes Show participants 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
    • task_board_uuid string

      UUID of the task board

    • plans object

      Plans in this case (if included)

      Hide plans attributes Show plans attributes object

      • uuid string
      • created_at string
      • updated_at string
      • opened_at string
      • name string
      • type string
      • sub_type string
      • abstract_type string
      • policy_number string
      • proposal_reference string
      • status string
      • inactive_at string
      • inactive_reason string
      • agency_in_your_name boolean
      • agency_in_your_name_from string
      • originally_sold_by_firm boolean
      • under_advice boolean
      • visible_on_client_portal boolean
      • include_in_client_valuation boolean
      • show_on_joint boolean
      • shown_on_circles boolean
      • review_date string
      • on_panel boolean
      • is_group_scheme boolean
      • is_sub_group_scheme boolean
      • is_group_scheme_member boolean
      • advice_area string
      • main_account string
      • sub_accounts string
      • provider string
      • covers string
      • claims string
      • total_benefit_amount object
        Hide total_benefit_amount attributes Show total_benefit_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
      • total_benefits object
        Hide total_benefits attributes Show total_benefits attributes object

        • critical_illness object
          Hide critical_illness attributes Show critical_illness 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
        • family_income_benefit object
          Hide family_income_benefit attributes Show family_income_benefit 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
      • latest_valuations string
      • value object
        Hide value attributes Show value 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
      • valued_at string
      • original_valued_at string
      • client string
      • accounts string
      • seller string
      • linked_owners string
      • linked_plans string
      • visible_to_circles string
      • statistics object
        Hide statistics attribute Show statistics attribute object

        • recent_growth integer
      • cases string
      • tags string
      • is_wrap_product boolean
      • is_wrap_child boolean
      • wrap string
      • wrap_children string
      • linked_policy_numbers string
      • can_be_deleted string
      • contract_enquiry_account string
      • custom_fields string
      • external_references string
    • custom_fields array[object]

      Any custom fields on the model.

      Hide custom_fields attributes Show custom_fields attributes object

      • uuid string
      • created_at string
      • updated_at string
      • type string
      • name string
      • reference string
      • is_required boolean
      • value string
      • selection_options array[string]
      • help_text string