Headers

• X-PLANNR-ACCOUNT-UUID string

Query parameters

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[name] string

  Filter by name or display name. Partial filter.

• filter[is_published] boolean

  Filter by published status.

• filter[archived] string

  Filter archived templates. One of: exclude (default), only, include.

• filter[created_after] string

  Filter templates created on or after this date (Y-m-d).

• filter[created_before] string

  Filter templates created on or before this date (Y-m-d).

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, name, active_sessions_count]. 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
    • name string
    • display_name string
    • description string
    • opening_statement string
    • closing_statement string
    • is_published boolean
    • archived_at string
    • is_archived boolean
    • is_locked boolean
    • active_session_count integer
    • sections object
      Hide sections attributes Show sections attributes object

      • uuid string
      • created_at string
      • updated_at string
      • fact_find_template object
        Hide fact_find_template attributes Show fact_find_template 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.

        • name

          The internal reference name of the fact-find template.

        • display_name

          The client-facing name shown when the fact find is sent to a client.

        • description

          A brief description of the template.

        • opening_statement

          An opening statement shown at the start of the fact-find.

        • closing_statement

          A closing statement shown at the end of the fact-find.

        • is_published

          Whether the fact-find template is published and available for use.

        • archived_at

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

        • is_archived

          Denotes if the template has been archived. Archived templates are hidden from the default list and can no longer start new sessions.

        • is_locked

          Whether the template is locked from edits because at least one client has an in-flight session against it. Clone the template to make changes.

        • active_session_count

          Number of in-flight client sessions blocking edits to this template.

      • name string
      • introduction_html string
      • position integer
      • is_complete boolean
      • blocks object
        Hide blocks attributes Show blocks 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.

        • name

          The name of the fact find block.

        • introduction_html

          HTML introduction shown at the start of this block.

        • position

          The position/order of this block within the section.