Actions20
- Candidates Actions
- Pipeline Templates Actions
- Stage Templates Actions
- Recruitment Campaigns Actions
Overview
This node interacts with the Pulse API to perform recruitment-related actions. Specifically, for the Stage Templates resource with the Get List Stage Templates operation, it retrieves a paginated and optionally filtered list of stage templates used in recruitment pipelines.
Typical use cases include:
- Fetching all available stage templates to display or process them in workflows.
- Filtering stage templates by specific criteria such as creation date or other metadata.
- Paginating through large sets of stage templates to handle them efficiently.
For example, a recruiter might use this node to get all stage templates sorted by creation date to review or update their recruitment pipeline stages.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | A collection of optional parameters to customize the list retrieval: |
| - 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 | The number of items per page (default is 10). |
| - Filters | Filter results by specific fields. Each filter consists of a key and a comma-separated list of values. |
| - Fields | Specify which fields to include in the response, grouped by resource type, as comma-separated strings. |
Output
The node outputs an array of JSON objects representing stage templates retrieved from the Pulse API. Each object contains the data fields of a stage template according to the requested fields or defaults.
The output structure typically includes:
- Identifiers and metadata of each stage template.
- Any additional fields specified in the request.
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 make authenticated requests.
- Proper network access to the Pulse API endpoint is necessary.
Troubleshooting
Common Issues:
- Incorrect or missing API credentials will cause authentication failures.
- Invalid filter keys or values may result in empty responses or errors.
- Requesting pages beyond the available range will return empty lists.
- Specifying unsupported fields in the "Fields" property may be ignored or cause errors depending on API behavior.
Error Messages:
"The operation "getListStageTemplates" is not supported for resource "stageTemplate"!"— This indicates a mismatch between selected resource and operation; ensure correct selections.- Network or authentication errors will typically propagate from the Pulse API and should be resolved by verifying credentials and connectivity.
Links and References
- Pulse API Documentation (replace with actual URL)
- n8n Documentation on Creating Custom Nodes
- Pagination and filtering concepts in REST APIs: REST API Pagination