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 a list of locations based on various filter criteria. It is designed to fetch multiple location records, optionally filtered and sorted according to user-defined parameters. This operation is useful for scenarios where you need to obtain an overview or detailed list of all available locations in a booking or scheduling system.

Practical examples include:

  • Retrieving all active locations in a specific city or country.
  • Searching locations by partial name or address.
  • Sorting locations by name or status for display in a dashboard.
  • Including metadata about locations for advanced processing or reporting.

Properties

Name Meaning
Filters Collection of filters to narrow down the locations returned. Options include:
- Name: Filter locations by exact or partial name.
- Status: Filter by "Active" or "Inactive" status.
- Address: Filter by address string.
- City: Filter by city name.
- State: Filter by state or province.
- Country: Filter by country name.
- Zip Code: Filter by postal or zip code.
- Phone: Filter by phone number.
- Search: General search across multiple location fields (name, address, description, etc.).
- Sort By: Field to sort results by; options are ID, Name, City, Status.
- Sort Order: Ascending or Descending order for sorting.
- Include Meta: Boolean to include additional metadata about locations in the response.
Description A text field to describe the purpose or context of this API call, helping AI understand intent.
Return All Boolean indicating whether to return all matching results or limit the number of results returned.
Limit Number specifying the maximum number of results to return if Return All is false (1-100).

Output

The output is an array of JSON objects, each representing a location record retrieved from the LatePoint API. Each location object contains fields such as name, status, address, city, state, country, zip code, phone, and optionally metadata if requested.

If the "Include Meta" option is enabled, additional metadata fields related to each location will be included in the output.

No binary data is produced by this node.

Example output snippet:

[
  {
    "id": "123",
    "name": "Main Office",
    "status": "active",
    "address": "123 Main St",
    "city": "Springfield",
    "state": "IL",
    "country": "USA",
    "zip_code": "62701",
    "phone": "555-1234",
    "meta": {
      "custom_field_1": "value1",
      "custom_field_2": "value2"
    }
  },
  ...
]

Dependencies

  • Requires an API key credential for authenticating with the LatePoint REST API.
  • The base URL for the LatePoint API must be configured in the credentials.
  • Network access to the LatePoint API endpoint is necessary.

Troubleshooting

  • No credentials configured!: Ensure that the API key credential is properly set up in n8n before running the node.
  • Invalid filter values: Providing unsupported or incorrectly formatted filter values may result in empty responses or errors. Verify filter inputs.
  • API rate limits or connectivity issues: Network problems or API rate limiting can cause request failures. Check network connectivity and API usage limits.
  • Invalid JSON in input fields: If using JSON body inputs elsewhere, ensure valid JSON syntax to avoid parsing errors.

Links and References

Discussion