REST API for Latepoint icon

REST API for Latepoint

Consume REST API for LatePoint on Tools
Join our community

Actions40

Overview

This node interacts with the LatePoint REST API to retrieve customer data. Specifically, the "Customers" resource with the "Get All" operation allows users to fetch a list of customers from the LatePoint system. It supports applying various filters and sorting options to narrow down or organize the results.

Common scenarios where this node is beneficial include:

  • Retrieving all customers who match specific criteria (e.g., active status, created within a date range).
  • Searching customers by name, email, or phone.
  • Exporting customer lists for marketing or CRM purposes.
  • Integrating customer data into other workflows or systems.

Practical example:

  • Fetch all active customers created after January 1, 2023, sorted by last name in ascending order.
  • Search customers whose email contains a certain domain.
  • Retrieve a limited number of customers including their metadata for detailed analysis.

Properties

Name Meaning
Filters Collection of filters to apply when retrieving customers. Options include: First Name, Last Name, Email, Phone, Status (Active/Inactive), Created Date From, Created Date To, Search (across name, email, phone), Sort By (ID, First Name, Last Name, Email, Created Date), Sort Order (Ascending/Descending), Include Meta (boolean to include metadata), Meta Key, Meta Value.
Description A text field to describe the purpose or context of the API call, helping AI understand the intent.
Return All Boolean indicating whether to return all matching customers or limit the number of results.
Limit Number specifying the maximum number of results to return if Return All is false. Range: 1 to 100.

Output

The output is an array of JSON objects representing customers retrieved from the LatePoint API. Each object corresponds to one customer and includes fields such as first name, last name, email, phone, status, creation date, and optionally metadata if requested.

If the "Include Meta" option is enabled, additional metadata fields related to each customer are included in the response.

No binary data output is produced by this node.

Dependencies

  • Requires connection to the LatePoint REST API.
  • Requires configuration of an API key credential for authentication.
  • The base URL and API key must be set in the node credentials before execution.

Troubleshooting

  • No credentials configured!
    This error occurs if the API key credential is missing or not set up properly. Ensure that the required API authentication token is configured in n8n credentials.

  • Invalid JSON in body:
    If using custom JSON bodies (not typical for Get All), malformed JSON will cause errors. Validate JSON syntax before input.

  • Empty or no results returned:
    Check filter values and date formats (YYYY-MM-DD). Incorrect filters may result in no matching customers.

  • API rate limits or connectivity issues:
    Network problems or API limits can cause request failures. Verify network access and API usage quotas.

Links and References

Discussion