Headers

• X-PLANNR-ACCOUNT-UUID string

Query parameters

• filter[completed] string

  affects whether to include actions which have been completed. Valid options are "exclude", "include", "only". (default: "exclude")

• 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
    • title string
    • description string
    • type string
    • is_completed string
    • resource object
      Hide resource attributes Show resource attributes object

      • uuid string
      • created_at string
      • updated_at string
      • status string
      • completed_at string
      • invitation_text string
      • schema object
        Hide schema attributes Show schema attributes object

        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • archived_at

          If the schema has been archived, the datetime of when it was archived.

        • is_archived

          Denotes if the schema has been archived.

        • name

          The name of the fact find schema.

        • introduction_html

          The name of the fact find schema. Must be unique.

        • sections_count

          The number of sections inside of a fact find schema.

        • public_url

          The public URL of the fact find schema.

      • latest_file object
        Hide latest_file attributes Show latest_file attributes object

        • uuid

          UUID of the file

        • created_at

          The timestamp of when the resource was created.

        • original_created_at

          Timestamp of when the file was originally created

        • updated_at

          The timestamp of when the resource was updated.

        • uploaded_at

          Timestamp of when the file was uploaded

        • status

          Current status of the uploading progress

        • filename

          The filename including extension

        • name

          The name of the file without extension

        • extension

          The extension of the file

        • type

          The MIME type of the file

        • size

          The size of the file in bytes

        • path

          The path of the file

        • last_modified

          Timestamp of when the file was last modified before uploading

        • progress

          The progress of the uploaded file as a percentage between 0 and 100

        • download_url

          The download URL of the file

        • folder_name

          The name of the folder the file is located in

        • documentable_type

          The documentable type such as account/plan/case/etc the file was uploaded to

        • documentable

          The documentable the file was uploaded to

        • navigator

          The documentable type and its UUID in order to navigator to the correct resource

      • account object
        Hide account attributes Show account attributes object

        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • type

          Account type

        • role

          Account role

        • first_name

          First name

        • last_name

          Last name

        • name

          Name

        • email

          (Deprecated - Please use the primary email of the account instead). The email of the account.

        • photo_url

          The photo URL of the client

      • invitation_url string
      • fact_find_passes object
        Hide fact_find_passes attributes Show fact_find_passes attributes object

        • uuid

          The UUID of the resource.

        • created_at

          The timestamp of when the resource was created.

        • updated_at

          The timestamp of when the resource was updated.

        • firm

          The name of the firm the fact find pass is for.

        • circle

          The circle the fact find is for.

        • expires_at

          The expiry date of the fact find pass. When blank, the fact find pass will not expire.

        • progress

          The progress of the fact find pass on the fact find.

        • is_complete

          Determines if the fact find pass has completed the fact find.

        • completed_sections

          The number of sections the fact find pass has completed on the fact find.

    • created_at string
• 422 application/json

  Validation error

  Hide response attributes Show response attributes object

  • message string Required

    A human-readable description of the error.

  • errors object

    Validation messages keyed by the field that failed.

    Hide errors attribute Show errors attribute object

    • * array[string] Additional properties