Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• form_uuid string Required

Query parameters

• include string

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

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[created_after] string

  Date to filter when the record was created after.

• filter[created_before] string

  Date to filter when the record was created before.

• filter[stage] string

  Filter submissions by their stage. Valid options are draft,submitted,approved,changes_requested.

• filter[account] string

  Name of the account of who the submission was against.

• filter[account_uuids] string

  Filter by a comma separated list of accounts UUIDs of who the form was submitted against.

• filter[submitted_by_uuid] string

  Filter by a comma separated list of account UUIDs of who submitted the form.

• filter[circle_uuids] string

  Filter by a comma separated list of circle UUIDs belonging to accounts of who the form was submitted against.

• filter[hide_null_accounts] boolean

  Hide form submissions that are not linked to an account, this could be submissions on public forms.

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, stage]. 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
    • stage 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
      • 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
    • request object
      Hide request attributes Show request attributes object

      • uuid string
      • created_at string
      • updated_at string
      • description string
      • form string
      • has_submission boolean
      • submission string
    • form object
      Hide form attributes Show form attributes object

      • uuid string
      • created_at string
      • updated_at string
      • title string
      • description string
      • live boolean
      • visibility string
      • sections string
      • allowed_hosts array[string]
      • draft_submissions_count integer
      • submitted_submissions_count integer
      • create_client boolean
      • client_type string
    • answers array[object]
      Hide answers attributes Show answers attributes object

      • first_name string
      • last_name string