Fieldmotion API Getting started

User accounts and profiles

List configured custom user fields

POST /a/Users_listCustomValues

Read user-template field keys and labels for import/export and merge-code selectors.

When to use this endpoint

Use to build a field chooser, then read values through the export reader or metadata/profile endpoints. This returns configuration, not any user’s answers.

Authentication and permissions

Authenticate with signed API-key fields or a logged-in CRM session. Session requests use the dispatcher’s CSRF protection when configured.

This endpoint returns account template definitions, not user rows; the dispatcher permits the read without artificial record IDs.

Login is required. No additional page permission is imposed by this handler.

Parameters

This endpoint has no operation-specific parameters.

Example request

$result = FM_api('Users_listCustomValues', [
]);

Example response

[
  {
    "name": "badge",
    "label": "Badge number"
  }
]

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":"invalid users template configuration"}Saved template structure or a named field definition is malformed.

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

Behaviour and edge cases

  • Reads the decoded users-template setting and iterates each group’s draggable entries. Entries with field_name contribute name/label; no type, validation or current-user value is returned.
  • Repeated field names appear once, using the first definition and preserving template traversal order.
  • Missing/blank template returns []. Malformed non-array templates, groups, fields or missing labels return invalid users template configuration. No pagination.

Side effects

  • Reads data without changing business records, edit markers, activity history or notifications. Shared setting reads can populate their normal settings cache.

See it in Fieldmotion

CRM1

CRM1 User import, CSV export and email/report merge-code editors load Users_listCustomValues.

CRM2

CRM2 User CSV export, import and email/report template editors use the same endpoint.

Related endpoints