Export customer data

When to use this endpoint

Use Customers_getExportData only for the Fieldmotion customer CSV exporter. The first request uses _ids=1 to select IDs from filters; later requests send a JSON ID batch plus the chosen field list.

For ordinary integration reads, use Customers_list and Customers_getById; their responses use named fields rather than positional f0, f1 keys.

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

// Phase 1: select matching IDs.
$selection = FM_api('Customers_getExportData', [
	'_ids' => '1',
	'is_active' => '1',
	'country' => ['IRL'],
]);

// Phase 2: retrieve a retryable ID batch.
$rows = FM_api('Customers_getExportData', [
	'_ids' => json_encode([1042, 1088]),
	'fields' => json_encode(['id', 'name', 'parent_id', 'last_job']),
]);

Example response

// Phase 1
{
  "ids": [1042, 1088]
}

// Phase 2
[
  {
    "id": "1042",
    "f0": "1042",
    "f1": "Northwind Service Centre",
    "f2": "1001",
    "f3": "2026-09-23 15:30:00"
  }
]

Phase-one IDs are emitted as JSON numbers. Phase-two database values are normally strings/null, and each fN position follows the caller’s fields order.

Accepted stored/metadata fields are account_manager, account_number, account_number_sage, accounts_name, accounts_number, appointments_closed, appointments_open, callback, callback_notes, cdate, city, contact_name, country, county, created_by, credit_terms, custom_values, default_nominal, default_taxcode, department_id, email, email_accounting, email_extra, id, industry, is_active, landline, last_edited, last_job, latitude, lead_acc, longitude, meta_default_invoice_due_date, meta_discount, mobile, name, notes, parent_id, postcode, price_band, state, static, street_address1, street_address2, town, type, xero_id, marketing_source, and last_edit_user.

Dynamic fields are custom_values.<key>, last_edited.<path>, and customer_table:<table-id>_<field-id>.

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

• Phase one always adds deleted=0. Phase two does not: an explicitly supplied ID can export a soft-deleted or inactive customer. Phase two also does not verify that IDs came from phase one.
• All phase-one filters are AND-combined except the values within country, marketing-source, and callback-status groups. Neither phase establishes a stable row order.
• IDs and fields are integer-converted/allowlisted before the data query. Duplicate IDs collapse in SQL; duplicate field requests produce multiple fN values.
• last_job uses the maximum stored job end epoch for matching numeric customer_id and converts it to tenant-local time. The derived query does not filter soft-deleted jobs or constrain customer type.
• xero_id uses only Xero customer links for the current xero_token.tenantId and formats the stored 32-character remote value as a hyphenated GUID.
• default_nominal, default_taxcode, and marketing_source translate stored IDs to current display strings; missing references become blank.
• last_edit_user returns the user ID from the newest customer-change row. customer_table fields return a JSON-encoded array of all matching row values, or a single-space string when no value exists.
• custom_values and other stored JSON values remain encoded strings. static is always blank.
• The handler streams both phases directly with invalid UTF-8 substitution and provides no built-in page size. The UI is responsible for sending retryable ID batches.

See it in Fieldmotion

CRM1

On Customers, pass the export-password dialog and configure a CSV export. The export widget first calls Customers_getExportData with _ids=1 and the current CRM1 table filters, then requests selected fields in ID batches.

CRM2

On Customers, choose Export. CRM2 first gathers filtered IDs through Customers_getDataTable, then its export widget calls Customers_getExportData in data phase for selected fields. It does not use this endpoint’s phase-one filters in that path.

Related endpoints

• Customers_exportCheckPass is the UI’s separate password preflight.
• Customers_getDataTable supplies CRM2’s filtered ID set.
• Customers_list returns named fields for integration reads.