Actions100
- Activity Logs Actions
- Articles Actions
- Asset Layouts Actions
- Asset Passwords Actions
- Assets Actions
- Get Assets
- Get Companies Company Id Assets
- Post Companies Company Id Assets
- Get Companies Company Id Assets Id
- Put Companies Company Id Assets Id
- Delete Companies Company Id Assets Id
- Put Companies Company Id Assets Id Archive
- Put Companies Company Id Assets Id Unarchive
- Put Companies Company Id Assets Id Move Layout
- Cards Actions
- Companies Actions
- Expirations Actions
- Exports Actions
- Folders Actions
- IP Addresses Actions
- Lists Actions
- Magic Dash Actions
- Matchers Actions
- Networks Actions
- Password Folders Actions
- Procedure Tasks Actions
- Procedures Actions
- Public Photos Actions
- Rack Storage Items Actions
- Rack Storages Actions
- Relations Actions
- Uploads Actions
Overview
This node interacts with a service to retrieve lists of items, specifically supporting the "Get Lists" operation under the "Lists" resource. It allows users to fetch multiple lists, optionally filtering them by name or searching by partial matches. This is useful in scenarios where you want to programmatically access and manipulate collections of data grouped as lists, such as contact lists, task lists, or any other categorized data sets managed by the connected service.
Practical examples include:
- Retrieving all available lists to display in a dashboard.
- Searching for lists that match a certain keyword to automate workflows based on list content.
- Filtering lists by exact names to target specific datasets for further processing.
Properties
| Name | Meaning |
|---|---|
| Additional Query Parameters | Optional parameters to refine the list retrieval: |
| - Query: Search lists by name using a partial match (substring search). | |
| - Name: Filter lists by an exact name match. |
These parameters are sent as query parameters in the API request to filter or search the lists accordingly.
Output
The node outputs JSON data representing the retrieved lists. The structure typically includes an array of list objects, each containing details such as list identifiers, names, and possibly other metadata depending on the external service's API response.
If the node supports binary data output, it would represent attachments or files related to the lists, but based on the provided code and properties, the output is primarily JSON data describing the lists.
Dependencies
- Requires an API key or authentication token configured in the node credentials to authorize requests to the external service.
- The base URL for the API is set dynamically from the credentials.
- Depends on the external service's REST API endpoint that provides list data.
Troubleshooting
- Empty results: If no lists are returned, verify that the query parameters are correct and that the authenticated user has access to lists.
- Authentication errors: Ensure the API key or authentication token is valid and has sufficient permissions.
- Invalid query parameters: Using unsupported or malformed query parameters may cause errors; double-check parameter names and values.
- Network issues: Connectivity problems can prevent the node from reaching the API endpoint.
Common error messages might include unauthorized access, invalid parameters, or timeout errors. Resolving these usually involves checking credentials, adjusting query parameters, and ensuring network connectivity.
Links and References
- Refer to the external service’s official API documentation for detailed information on list retrieval endpoints and supported query parameters.
- n8n documentation on creating and configuring HTTP Request nodes for similar use cases.