Fieldmotion API Getting started

Asset types

List legacy asset custom fields

POST /a/AssetTypes_listCustomFields

Enumerate custom asset fields from every asset type’s legacy metadata template.

When to use this endpoint

Use AssetTypes_listCustomFields for CRM1 export maps, email/report template editors, and job-form completion rules that still consume meta.template.

CRM2 layout-backed fields are available from AssetTypes_getCustomFields.

Authentication and permissions

The request must authenticate with signed API-key fields or a logged-in CRM session. The handler performs no additional page or role-permission check.

The lookup and any write use the authenticated tenant; an ID from another tenant cannot be addressed through this call.

Parameters

ParameterTypeRequiredDescription
condense_sharedInteger stringNoExact integer 1 keeps only the first occurrence of each field_name. The older key condense is ignored. Deduplication applies to all fields, not only those marked shared.

Example request

$fields = FM_api('AssetTypes_listCustomFields', [
	'condense_shared' => '1',
]);

Example response

[
  {
    "name": "inspection_class",
    "label": "Inspection class",
    "type": "select",
    "asset_type": "Compressor",
    "shared": 1
  }
]

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

  • Only metadata strings beginning with { and containing template are inspected. Draggables without field_name are skipped.
  • Missing label/type/shared properties become null, blank, and 0 respectively.
  • After collection, rows are sorted only by the numeric shared value; order within the same value is not guaranteed.
  • There is no type filter, search, pagination, or limit.

See it in Fieldmotion

CRM1

Open an Asset export-map editor, email template editor, Form report-document editor, or a job Form Asset field’s completion rules and inspect AssetTypes_listCustomFields.

CRM2

CRM2 email/notification templates, report-document editing, and the legacy export widget still call this endpoint. Newer Asset export/form field pickers use AssetTypes_getCustomFields.

Related endpoints