When to use this endpoint

Call before Map_get to select a reusable mapping. This is a compact selector list, not a retrieval of translation rules.

Authentication and permissions

Authenticate with signed API-key fields or a logged-in CRM session. This handler checks for an authenticated tenant context; it has no additional page, role or map-owner permission check.

Maps are tenant-wide, not private to the user who saved them.

Parameters

ParameterTypeRequiredDescription
typeInteger stringNoPositive values filter by type. Omitted, zero or negative values list all stored types. Exact integer-converted 7 also appends the built-in customer map.

Example request

$maps = FM_api('Maps_list', ['type' => '7']);

Example response

[{"id":"1042","name":"Customer names"},{"id":"-2","name":"[default]"}]

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.
[]No stored matches and type is not 7. Type 7 still supplies the synthetic default on a successful query.

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

Behaviour and edge cases

  • Returns only id and name; both are strings for ordinary rows and the appended default.
  • No pagination, sort, owner or active/deleted filtering. Stored-row order is unspecified; the default is appended last. No writes occur.

See it in Fieldmotion

CRM1

Open an import or export dialog, then use its saved-map selector. Filter browser Network requests for this endpoint; widgetImport.js and widgetExport.js implement the workflow.

CRM2

Open the CRM2 import/export dialog and use its saved-map selector. The import widget and widgetExportCRM2.js use the same route and stored JSON-string contract.

Related endpoints