When to use this endpoint

Load form tags before editing them. This is definition metadata, separate from notes/answers recorded against individual jobs.

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

ParameterTypeRequiredDescription
idInteger-compatible form IDYesPositive integer-converted local form ID.

Example request

$tags = FM_api('Form_getTags', ['id'=>'1042']);

Example response

"Safety\nAnnual service"

The endpoint decodes the outer metadata only. It returns meta.tags as stored, or an empty string when the property is unset. Stored HTML entities are not decoded; a JSON note/tag string remains a string. Historically stored native arrays/objects retain their decoded value shape.

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.
{"error":"missing or invalid parameter: id"}Missing/null/nonpositive integer-converted ID.
{"error":"no such file"}The selected meta value is false-like, including a missing row, null/empty metadata or failed read. The legacy message is exact.

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

Behaviour and edge cases

  • Includes archived forms and every type, without a page, department or owner restriction. There is no pagination or ordering on this scalar lookup.
  • Truthy malformed metadata decodes to null and normally produces an empty string rather than the missing-record error. The handler does not repair metadata or distinguish every read failure from absence.
  • No direct mobile app/m-service caller for this RPC was found. Mobile form definitions arrive through m’s syncDownloads form channel, not this endpoint.

Side effects

  • Read-only; no history, cache invalidation, file write, URL fetch or report rendering.

See it in Fieldmotion

CRM1

Open Forms → Tags editor and filter for Form_getTags. The caller receives a scalar string rather than a record object.

CRM2

No direct Form_getTags caller found. Forms uses mapped metaTags data in its table/editor.

Related endpoints