Actions20
- Candidates Actions
- Pipeline Templates Actions
- Stage Templates Actions
- Recruitment Campaigns Actions
Overview
This node interacts with the Pulse API to manage recruitment-related data. Specifically, for the Pipeline Templates resource and the Get List of Pipeline Templates operation, it retrieves a paginated list of pipeline templates used in recruitment workflows.
Use cases include:
- Fetching available pipeline templates to display or process them in recruitment automation.
- Filtering and sorting pipeline templates based on specific criteria.
- Controlling pagination to handle large sets of pipeline templates efficiently.
For example, you might use this node to get all pipeline templates sorted by creation date, or filter templates by certain attributes to integrate with your HR system.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | A collection of optional parameters to customize the request: |
| - Sort | Sort order of results, e.g., "created_at" for ascending or "-created_at" for descending order. |
| - Page Number | The page number for pagination (default is 1). |
| - Page Size | Number of items per page for pagination (default is 10). |
| - Filters | One or more filters to narrow down results. Each filter has: |
| Key | The field name to filter on. |
| Values | Comma-separated list of values to match for the key. |
| - Fields | Specify which fields to include in the response. Each entry includes: |
| Resource Type | The resource type to specify fields for (likely "pipelineTemplate" here). |
| Fields | Comma-separated list of fields to include in the output JSON. |
Output
The node outputs an array of JSON objects representing pipeline templates matching the query parameters. Each object contains the fields returned by the Pulse API for a pipeline template, potentially filtered by the specified fields property.
The output structure corresponds directly to the API response for pipeline templates and typically includes details such as template ID, name, stages, creation date, and other metadata.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the Pulse API via an API key credential configured in n8n.
- The node depends on the Pulse API helper utilities bundled within the node's codebase to perform authenticated requests.
- Proper network access to the Pulse API endpoint is necessary.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication failures.
- Incorrect filter keys or malformed filter values may result in empty responses or API errors.
- Requesting pages beyond the available range will return empty lists.
- Specifying unsupported fields in the "Fields" property may be ignored or cause partial responses.
Error messages:
"The operation "getListPipelineTemplates" is not supported for resource "pipelineTemplate"!"— indicates a misconfiguration of operation or resource.- Network or API errors will propagate with their message; ensure the API key is valid and the service is reachable.
- If the node is set to continue on fail, errors will appear in the output JSON under an
errorkey.
Links and References
- Pulse API Documentation (replace with actual URL)
- n8n documentation on Creating Custom Nodes
- Pagination and filtering best practices in REST APIs
If you need further details about other operations or resources, feel free to ask!