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 agents based on various filter criteria. The "Get All" operation for the "Agents" resource allows users to fetch multiple agent records, optionally filtered and sorted by fields such as name, email, status, creation date, and metadata. This is useful in scenarios where you want to integrate or synchronize agent data from LatePoint into workflows, generate reports, or trigger actions based on agent attributes.

Practical examples include:

  • Retrieving all active agents created after a certain date.
  • Searching agents by partial name or email.
  • Sorting agents alphabetically by last name.
  • Filtering agents by custom metadata keys and values.

Properties

Name Meaning
Filters Collection of filters to apply when retrieving agents. Options include:
• First Name (string)
• Last Name (string)
• Email (string)
• Phone (string)
• Status (Active, Inactive)
• Created Date From (YYYY-MM-DD)
• Created Date To (YYYY-MM-DD)
• Search (string across agent fields)
• Sort By (ID, First Name, Last Name, Email, Created Date)
• Sort Order (Ascending, Descending)
• Include Meta (boolean to include metadata)
• Meta Key (string to filter by specific meta key)
• Meta Value (string to filter by specific meta value)
Description Optional string description or prompt to provide context or purpose for the API call.
Return All Boolean indicating whether to return all results or limit the number of results.
Limit Number specifying the maximum number of results to return if "Return All" is false. Range: 1-100.

Output

The output is an array of JSON objects, each representing an agent record retrieved from the LatePoint API. Each object contains the agent's details such as first name, last name, email, phone, status, creation date, and optionally metadata if requested.

No binary data is output by this node.

Example output snippet:

[
  {
    "id": "123",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane.doe@example.com",
    "phone": "+1234567890",
    "status": "active",
    "created_date": "2023-01-15",
    "meta": {
      "key1": "value1",
      "key2": "value2"
    }
  },
  ...
]

Dependencies

  • Requires a configured API authentication token credential for the LatePoint REST API.
  • The node makes HTTP requests to the LatePoint API base URL using the provided API key.
  • No additional external dependencies are required.

Troubleshooting

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

  • Invalid JSON in body:
    Occurs if the user inputs malformed JSON in the "JSON Body" field when sending a custom request body. Validate JSON syntax before running.

  • API request failures:
    Could be due to network issues, invalid filters, or permission problems. Check API key validity, endpoint accessibility, and filter correctness.

  • Empty results despite valid filters:
    Verify that filter values match existing agent data. For example, date formats must be YYYY-MM-DD, and status values must be either "active" or "inactive".

Links and References

Discussion