Fieldmotion API Getting started

Forms

List report-document snippets

POST /a/Forms_listSnippets

Enumerate the server-installed HTML building blocks available to the report-document editor.

When to use this endpoint

Use this when constructing the report-document snippet palette. These are global deployment files, not tenant form records.

Authentication and permissions

The request must authenticate with signed API-key fields or a logged-in CRM session and is scoped to the authenticated tenant.

The handler performs no form, department, owner, or page-permission check unless the page below says otherwise. CRM navigation may impose additional UI-only access rules.

Parameters

This endpoint has no operation-specific parameters.

Example request

$snippets = FM_api('Forms_listSnippets');

Example response

[
  "/Checklists/Single Header Checklists/Numbered Checklist/Side by Side Checklist/Left Sided/Left Sided.html",
  "/Company Details/Client Only/Name-Address/Name_Address.html"
]

Errors and unusual responses

ResponseCondition
{"error":"not logged in"}No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs.

Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.

Behaviour and edge cases

  • The handler recursively scans report-styles/www/blocks and includes files whose names end in .html. Paths begin with / and are relative to that blocks directory.
  • Directory iteration order is returned as-is; there is no explicit sorting, tenant filtering, or pagination.
  • The list changes with deployed report-style assets and must not be treated as a fixed count or stable catalogue.

See it in Fieldmotion

CRM1

Open a form’s Report Document editor; the snippet chooser loads this list.

CRM2

The Report Document editor uses the same endpoint.

Related endpoints