Query parameters

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[report_type_id] string

  Exact filter for type of report to return

• filter[created_by] string

  list of adviser uuids to filter reports created by these accounts

• sort string

  Field to sort by. Valid fields are [updated_at, created_at, name, report_type_id]. 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.

    • last_interaction_at string

      Last interaction date of an account associated with this report

    • last_login_at string

      Last login date of an account associated with this report

    • name string

      Name of the report

    • created_by object

      the account that created this report

      Hide created_by attributes Show created_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
    • report_type_id string

      report type id

    • status string

      Current status of report generation

    • progress integer

      Current progress of the report when generating

    • files array[object]

      Files generated for this report instance

      Hide files attributes Show files attributes object

      • uuid string
      • created_at string
      • original_created_at string
      • updated_at string
      • uploaded_at string
      • status string
      • filename string
      • name string
      • extension string
      • type string
      • size string
      • path string
      • last_modified string
      • progress string
      • download_url string
      • folder_name string
      • folder string
      • documentable_type string
      • documentable string
      • navigator object
        Hide navigator attributes Show navigator attributes object

        • model_type string
        • model_uuid string
      • firm string
      • account string
      • tags string
    • folder object

      Folder generated with the report. this is the default folder that all generated documents will be stored

      Hide folder attributes Show folder attributes object

      • uuid string
      • created_at string
      • updated_at string
      • name string
      • slug string
      • path string
      • clients_read boolean
      • clients_write boolean
      • show_client_permissions boolean
      • is_system_folder boolean
      • is_pseudo_folder boolean
      • is_root_folder boolean
      • documentable_type string
      • documentable_uuid string
      • documentable string
      • participants_count integer
      • participants string
      • folders_count integer
      • folders string
      • files_count integer
      • files string
      • parents string
      • ancestors string
      • children string
      • depth integer
      • owned boolean