Fieldmotion API Getting started

Customers

List customer account numbers

POST /a/Customers_listAccountNumbers

Return every non-deleted customer’s ID, name, and account number.

When to use this endpoint

Use Customers_listAccountNumbers only when a tenant-wide account-number mapping requires this exact compact projection.

For lookup or integration work, Customers_list provides filters and optional paging, while Customer_getByAccountNumber resolves one exact value.

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

$accountNumbers = FM_api('Customers_listAccountNumbers', []);

Example response

[
  {
    "id": "1042",
    "name": "Northwind Service Centre",
    "account_number": "NW-1042"
  }
]

Database scalar values are normally serialized as strings; a legacy SQL null remains JSON null.

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 tenant has no non-deleted customers.

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

Behaviour and edge cases

  • Soft-deleted customers are excluded. Inactive customers and rows with blank or null account numbers are included.
  • The query has no ordering clause. Match by id and do not rely on response position.
  • There is no search, field selection, pagination, or result-size limit.

See it in Fieldmotion

CRM1

A production-source search found no CRM1 caller for Customers_listAccountNumbers.

CRM2

A production-source search found no CRM2 caller for Customers_listAccountNumbers.

Related endpoints