Fieldmotion API Getting started

Customer SFTP imports

List customer SFTP source IDs

POST /a/ImportsCustomersFtp_list

Discover the source IDs owned by the authenticated account.

When to use this endpoint

Use before a source detail call or cleanup. The list is not a file list and includes Disabled sources.

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

This endpoint has no operation-specific parameters.

Example request

$result = FM_api('ImportsCustomersFtp_list', []);

Example response

[
  {
    "id": "18"
  }
]

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.
{"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

  • Returns only account-owned source IDs, ordered by numeric ID. No paging, count envelope or enabled-status filter. Disabled sources are included; credentials and metadata are not 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. The visible table uses ImportsCustomersFtp_getDT; list is used by integration/test discovery rather than that table.

CRM2

In CRM2, open Imports > Customers FTP. The visible table uses ImportsCustomersFtp_getDataTable; no direct literal list caller was found. No direct caller was found in the searched current mobile intermediary or app source; these are office import-management routes.

Related endpoints