Getfly icon

Getfly

Interact with Getfly CRM API
Join our community

Actions3

Overview

This node interacts with the Getfly CRM API to retrieve data about customers (referred to as "accounts" in the API). Specifically, the "Get All" operation for the Customer resource fetches a list of customers with various filtering, sorting, and pagination options. This is useful when you want to bulk retrieve customer information for reporting, synchronization with other systems, or analysis.

Practical examples include:

  • Fetching all customers with their IDs, names, and emails to import into a marketing platform.
  • Retrieving a paginated list of customers filtered by name or email for targeted outreach.
  • Sorting customers by their account code or email address to organize data exports.

Properties

Name Meaning
Fields Comma-separated list of customer fields to retrieve. Default includes id, account_name, account_code, email, phone_office.
Limit Maximum number of customers to return in one request.
Offset Number of customers to skip before starting to collect the result set (used for pagination).
Additional Options Collection of optional parameters:
- Sort By Field to sort results by. Options: ID, Customer Name, Customer Code, Email.
- Sort Direction Direction to sort results. Options: Ascending, Descending.
- Filter by ID Filter customers by exact customer ID.
- Filter by Name Filter customers by exact customer name.
- Filter by Email Filter customers by partial match on email address.

Output

The node outputs an array of JSON objects representing customers. Each object contains the fields requested via the "Fields" property. The structure depends on the selected fields but typically includes identifiers, contact details, and account codes.

Example output item (fields depend on selection):

{
  "id": "123",
  "account_name": "Acme Corp",
  "account_code": "ACME001",
  "email": "contact@acme.com",
  "phone_office": "+123456789"
}

No binary data is output by this node.

Dependencies

  • Requires an active connection to the Getfly CRM API.
  • Needs an API key credential configured in n8n for authentication.
  • The node uses HTTP GET requests to the Getfly API endpoints.
  • The base URL domain must be provided in the credentials and is normalized to ensure it starts with https://.

Troubleshooting

  • Common issues:

    • Invalid or missing API key will cause authentication errors.
    • Incorrect domain URL format may lead to connection failures.
    • Requesting too many records without proper pagination might cause timeouts or large payloads.
    • Filters that do not match any records will return empty arrays.

  • Error messages:

    • Errors from the Getfly API are caught and rethrown with the message prefixed by "Getfly API Error:" followed by the API's error message.
    • Network or unexpected errors are thrown as-is.

  • Resolutions:

    • Verify API key correctness and permissions.
    • Ensure the domain URL in credentials is correct and accessible.
    • Use limit and offset properties to paginate large datasets.
    • Double-check filter values for accuracy.

Links and References

Discussion