Page the legacy customer SFTP source grid

When to use this endpoint

Use for the legacy table; CRM2’s mapped table has a different response contract.

Authentication and permissions

Use signed API-key authentication or a logged-in CRM session. API keys act as their owner; session requests use dispatcher CSRF protection when configured.

Requires a valid tenant account and View on pageImportsCustomersFtp. Source IDs and counts are restricted to the authenticated account owner; client-supplied ownership cannot expand access.

Parameters

Parameter	Type	Required	Description
`start / length / draw`	Nonnegative integer/string	No	start and length are required; draw defaults to 0. draw is read from the request, including a signed POST body. Negative values and length=-1 are rejected.
`order`	Native DataTables array	No	Standard order[0].column/dir and legacy direct order.dir are supported; asc/desc only. Columns 0 ID, 1 server, 2 directory, 3 status; other columns fall back to ID. Default server desc; ID breaks ties.

Example request

$result = FM_api('ImportsCustomersFtp_getDT', ['start'=>'0','length'=>'10','order'=>['dir'=>'asc']]);

Example response

{
  "recordsTotal": "1",
  "recordsFiltered": "1",
  "data": [
    [
      "18",
      "imports.example.invalid",
      "incoming",
      "0",
      "",
      "",
      ""
    ]
  ],
  "draw": 0
}

Errors and unusual responses

Response	Condition
`{"error":"not logged in"}`	No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs.
`{"error": "permission denied"}`	The user lacks the required Imports page action.

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

Behaviour and edge cases

Counts and rows are restricted to the authenticated owner. The seven positional cells are ID, server, directory, status and three empty UI placeholders. Counts retain database scalar types; draw is an integer.
Supports validated offset/limit and native DataTables ordering. There is no free-text search or status filter in this legacy grid. No password is returned.

Side effects

Reads data without modifying import settings, imported records, history, queues or notifications.

See it in Fieldmotion

CRM1

In CRM1, open Settings > Imports > Customers FTP. Load the page and filter for ImportsCustomersFtp_getDT; the DataTables client renders positional rows.

CRM2

In CRM2, open Imports > Customers FTP. Uses ImportsCustomersFtp_getDataTable instead.

Related endpoints

ImportCustomersFtp_save — Configure an owned source.
ImportsCustomersFtp_getDataTable — Discover source rows and IDs.
ImportCustomersFtp_getImportMaps — Inspect map choices before running.
ImportCustomersFtp_runOnce — Understand import writes and remote cleanup.