Actions11
Overview
The node interacts with a recruitment system via the Pulse API, specifically managing candidate data and quiz sessions related to candidates. The "List Candidates" operation retrieves a paginated list of candidates from the recruitment database, optionally filtered and sorted according to user-defined criteria.
This node is useful in scenarios where you want to automate workflows involving candidate management, such as syncing candidate lists with other systems, generating reports, or triggering actions based on candidate data changes.
Example use cases:
- Fetching a list of candidates who applied within a certain date range.
- Retrieving candidates sorted by their creation date for batch processing.
- Filtering candidates by specific attributes like status or job position.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | A collection of optional parameters to customize the candidate list retrieval: |
| - 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 candidates per page (default is 10). |
| - Filters | One or more filters to narrow down results. Each filter consists of: |
| • 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 "candidates"). | |
| • Fields: Comma-separated list of candidate fields to include in the output. |
Output
The node outputs JSON data containing the list of candidates matching the query parameters. The structure typically includes an array of candidate objects with fields as specified by the input properties.
If binary data were involved (not indicated here), it would be summarized accordingly, but this operation returns only JSON data representing candidate records.
Dependencies
- Requires connection to the Pulse API service.
- Needs an API authentication credential configured in n8n to authorize requests.
- No additional external dependencies are indicated.
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 available data may return empty lists.
- Specifying unsupported sort fields could lead to errors or ignored parameters.
Error messages:
"The operation \"getCandidatesList\" is not supported for resource \"candidates\"!"— indicates a misconfiguration of operation or resource.- Network or API errors will propagate as error messages; ensure network connectivity and valid API endpoint configuration.
Resolutions:
- Verify API credentials and permissions.
- Double-check filter keys and values against the API documentation.
- Use valid pagination parameters within expected ranges.
- Confirm that the resource and operation selections are correct.
Links and References
- Pulse API Documentation (replace with actual URL if known)
- n8n Documentation on Creating Custom Nodes
- General API Pagination Concepts: https://swagger.io/docs/specification/2-0/describing-responses/#pagination