Actions20
- Candidates Actions
- Pipeline Templates Actions
- Stage Templates Actions
- Recruitment Campaigns Actions
Overview
This node interacts with the Pulse API to manage recruitment campaigns and related resources such as candidates, pipeline templates, and stage templates. Specifically, for the Recruitment Campaigns List operation, it retrieves a list of recruitment campaigns from the Pulse system.
This node is beneficial in scenarios where you want to automate or integrate recruitment campaign data retrieval into workflows, such as syncing campaigns with other HR systems, generating reports, or triggering actions based on campaign status.
Practical example:
You could use this node to fetch all active recruitment campaigns, filter them by creation date or status, and then send summary emails or update dashboards automatically.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | A collection of optional parameters to customize the list request: |
| - Sort | Sort order of the 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 for pagination (default is 10). |
| - Filters | One or more filters to narrow down results. Each filter consists of a key (field name) and comma-separated values to match. |
| - Fields | Specify which fields to include in the response for a given resource type. You provide the resource type and a comma-separated list of fields to retrieve. |
Output
The output is an array of JSON objects representing recruitment campaigns matching the query parameters. Each object contains the fields returned by the Pulse API for recruitment campaigns, potentially filtered by the specified fields property.
No binary data is output by this operation.
Example output structure (simplified):
[
{
"id": "campaign_123",
"name": "Software Engineer Hiring",
"status": "open",
"created_at": "2023-01-15T12:00:00Z",
"updated_at": "2023-02-01T08:30:00Z",
...
},
...
]
Dependencies
- Requires an API key credential for authenticating with the Pulse API.
- The node depends on the Pulse API service being accessible and properly configured.
- No additional environment variables are explicitly required beyond the API authentication setup.
Troubleshooting
Common issues:
- Invalid or missing API credentials will cause authentication errors.
- Incorrect filter keys or field names may result in empty responses or API errors.
- Pagination parameters out of range might return no results or errors.
- Unsupported operations or resources will throw explicit errors.
Error messages:
"The operation \"getRecruitmentCampaignsList\" is not supported for resource \"recruitmentCampaign\"!"
Means the operation name is incorrect or misspelled; verify the operation parameter."The resource \"recruitmentCampaign\" is not supported!"
Means the resource name is invalid; ensure the resource parameter is set correctly.- API errors related to authentication or rate limits should be resolved by checking API key validity and usage quotas.
Links and References
- Pulse API Documentation (example placeholder link)
- n8n Documentation on Creating Custom Nodes
- General info on Pagination and Filtering Best Practices