Actions58
- Lead Management Actions
- User Agent Management Actions
- Campaign Management Actions
- Phone DID Management Actions
- List Management Actions
- Reporting Monitoring Actions
- System Info Actions
- Other Operations Actions
Overview
This node operation, "List Custom Fields" under the "List Management" resource, retrieves custom field definitions associated with a specific list from an external API. It is useful when you want to programmatically access metadata about custom fields configured for a list, such as their names, order, and formatting options.
Typical use cases include:
- Synchronizing or auditing custom field configurations between systems.
- Dynamically generating forms or interfaces based on available custom fields.
- Exporting custom field definitions for reporting or backup purposes.
For example, if you manage marketing lists with custom attributes, this node can fetch all those custom fields so you can process or display them elsewhere in your workflow.
Properties
| Name | Meaning |
|---|---|
| Function | The API function to call; fixed to "List Custom Fields" for this operation. |
| User | API user credential string used for authentication. |
| Pass | API password credential string used for authentication. |
| Source | A description or identifier of what originated the API call; default is "n8n". |
| List Id | The unique identifier of the list whose custom fields are being requested. |
| Stage | Output format of the response; options: Csv, Tab, Pipe, Json. |
| Header | Whether to include a header row in the output; options: YES, NO. |
| Custom Order | Sorting order of the custom fields; options: Table Order, Alpha Up (alphabetical ascending), Alpha Down (alphabetical descending). |
Output
The node outputs the retrieved custom fields data in the specified format (stage property). The json output field will contain the parsed data representing the list's custom fields, including their properties and order.
If the output format is one of the text-based formats (Csv, Tab, Pipe), the output will be a string formatted accordingly, optionally including headers depending on the header property.
No binary data output is indicated by the source code or properties.
Dependencies
- Requires an external API endpoint accessible via HTTP(S) that supports the specified query parameters.
- Requires valid API credentials (user and password) to authenticate requests.
- The base URL and authentication details must be configured in the node's credentials.
- No additional environment variables or services are explicitly required.
Troubleshooting
- Authentication errors: If the API user or password is incorrect or missing, the node will fail to authenticate. Verify credentials are correctly set.
- Invalid List ID: Providing a non-existent or malformed list ID may result in empty responses or errors. Confirm the list ID is valid.
- Unsupported output format: Ensure the
stageproperty is set to one of the supported formats (csv, tab, pipe, json). - Network issues: Connectivity problems to the API endpoint will cause request failures. Check network access and API availability.
- Missing required properties: The node requires certain properties like
function,user,pass, andlist_id. Omitting these will cause errors.
Links and References
- Refer to the external API documentation for detailed information on the "List Custom Fields" function and its parameters.
- n8n documentation on creating and using credentials for API authentication.
- General best practices for handling API pagination and data formatting in n8n workflows.