Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• client_id string Required

  The ID of the client.

Query parameters

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• sort string

  Field to sort by. Valid fields are [created_at, updated_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

      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.

    • status string

      The status of the fact-find request. Available options: in_progress,complete,approved,rejected

    • completed_at string

      The datetime when the fact-find request has been completed

    • invitation_text string

      The text that is used in the notification/email sent out to the client.

    • schema object

      The fact-find schema used for the fact-find request.

      Hide schema attributes Show schema attributes object

      • uuid string
      • created_at string
      • updated_at string
      • archived_at string
      • is_archived boolean
      • name string
      • introduction_html string
      • sections_count integer
      • public_url string
    • latest_file object

      The latest file that has been generated for the fact-find request.

      Hide latest_file attributes Show latest_file 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
    • account object

      The account that the fact-find request was sent to. Only visible when listing fact-find requests for a circle.

      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
    • invitation_url string

      The invitation URL sent to the client.

    • fact_find_passes object

      The fact find passes added to the fact-find request.

      Hide fact_find_passes attributes Show fact_find_passes attributes object

      • uuid string
      • created_at string
      • updated_at string
      • firm object
        Hide firm attributes Show firm attributes object

        • uuid string
        • name string
      • account string
      • circle object
        Hide circle attributes Show circle attributes object

        • uuid string
        • name string
      • expires_at string
      • progress integer
      • is_complete boolean
      • completed_sections integer