Fieldmotion API Getting started

Customers

List customer custom-field definitions

POST /a/Customers_listCustomValues

List customer custom-field definitions found in the tenant’s legacy customer layout setting.

When to use this endpoint

Use Customers_listCustomValues when building a customer import/export mapping or another UI that needs the configured custom-field names and labels.

This endpoint returns definitions, not values stored on any customer.

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

This endpoint has no operation-specific parameters.

Example request

$fields = FM_api('Customers_listCustomValues', []);

Example response

[
  {
    "name": "{{service_level}}",
    "label": "Service level",
    "type": "Custom",
    "data_type": "text",
    "extra": null
  }
]

Values are copied from each matching draggable layout item. extra is null when that key is absent.

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.
[]The mainFormat setting is absent, does not decode to an array, or contains no exact type: "Custom" items.
Server warning or malformed resultA layout page lacks the expected draggable array or a custom item lacks required keys such as field_name.

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 source is the tenant mainFormat setting. Definitions are returned page by page and draggable by draggable in stored order; they are not deduplicated.
  • Type comparison is exact and case-sensitive: only Custom is selected.
  • No customer table is queried, and inactive/deleted state is irrelevant.
  • There is no pagination or field filter.

See it in Fieldmotion

CRM1

Open a customer export or another mapping UI that offers customer custom fields. The shared customersGetCustomValues cache calls Customers_listCustomValues once and reuses the result.

CRM2

No direct production CRM2 caller was found for this endpoint. CRM2 obtains layout/custom-field metadata through its layout APIs.

Related endpoints