Query the CRM1 Customers table

When to use this endpoint

Use Customers_getDT only when reproducing CRM1’s Customers page. Its parameters and 17-position row arrays are coupled to that table’s columns and filters.

For a new integration use Customers_list; for CRM2’s mapped object rows use Customers_getDataTable.

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

Example request

$table = FM_api('Customers_getDT', [
	'draw' => '4',
	'start' => '0',
	'length' => '25',
	'fActive' => '1',
	'fHasJobs' => '1',
	'search' => [
		'value' => 'northwind',
		'fields' => json_encode(['name', 'account_number']),
	],
	'order' => [['column' => '2', 'dir' => 'asc']],
]);

Example response

{
  "data": [
    [
      1, 0, "Northwind Cork|Sam Example", "1",
      ["IRL", "Cork", "Cork"],
      ["T12 A3BC", "51.8985", "-8.4756", "14 Harbour Road"],
      "+353215550100", "+353875550100", ["2", "7"],
      ["4:1:Account (1 open)", {"id":"3","name":"Standard"}],
      ["2026-09-26 10:30", "Renewal call"], "18", "4", "",
      ["1088", "1001"], [], "21,25"
    ]
  ],
  "draw": 4,
  "recordsTotal": "250",
  "recordsFiltered": "1"
}

Each row position is: active flag, flagged flag, name|contact_name, notes-present flag, [country, county, town], [postcode, latitude, longitude, street_address1], landline, mobile, [type, department_id], [lead/account summary, price-band row-or-0], [callback without seconds, callback_notes], account-manager ID, stored appointments_closed job count, login token, customer-to-root ancestor IDs, an always-empty error list, and the stored files value.

Errors and unusual responses

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 from rows and both counts. Inactive customers remain unless fActive filters them.
• recordsTotal is the tenant-wide non-deleted customer count. recordsFiltered applies the complete filter set before page offset/length.
• Default ordering is customer name ascending. A recognized requested column uses the requested direction; there is no stable secondary sort for ties.
• Parent ancestry is followed one database lookup at a time and stops at a missing/deleted parent or a detected cycle. The row’s own ID is always first.
• Callback comparisons use the PHP server’s current date/time. The handler does not explicitly switch to the tenant timezone.
• The fixed row always includes the stored customer login value at position 13. The handler has no field-level permission check, so consumers must treat that legacy value as sensitive and avoid exposing it.
• The leading-quote fCounty and fPostcode branches build ungrouped SQL OR terms. When combined with other filters, SQL operator precedence can allow a country/town/street match to bypass preceding AND conditions.
• The endpoint raises its execution limit to 30 seconds and performs extra per-page queries for price bands and ancestry.

See it in Fieldmotion

CRM1

Open Customers. Searching, changing column filters, sorting, or paging reloads Customers_getDT; CRM1 sends the DataTables fields plus its f* filters.

CRM2

A production-source search found no CRM2 caller. CRM2’s Customers page uses Customers_getDataTable.

Related endpoints

• Customers_getDataTable is CRM2’s mapped customer table endpoint.
• Customers_getExportData implements the legacy two-stage CSV export.
• Customers_list is the simpler integration-oriented list endpoint.