Pulse Recruitment icon

Pulse Recruitment

Recruitment actions from Pulse API

Actions20

Overview

The node interacts with a recruitment system via the Pulse API, specifically focusing on managing candidates when using the "Candidates" resource and the "List Candidates" operation. It retrieves a list of candidates from the recruitment platform, supporting pagination, sorting, filtering, and field selection to tailor the results.

This node is beneficial in scenarios where you want to automate candidate data retrieval for further processing, reporting, or integration with other systems such as HR platforms, CRMs, or analytics tools. For example, you could use it to fetch all candidates created within a certain timeframe, filter them by status or skill, and then pass that data downstream for automated emailing or dashboard visualization.

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 paginated results (default is 1).
- Page Size The number of candidates per page (default is 10).
- Filters One or more filters to narrow down results by specific fields. Each filter requires:
  Key The field name to filter on (e.g., "status", "location").
  Values Comma-separated list of values to match for the given key.
- Fields Specify which fields to include in the response, grouped by resource type. Each entry requires:
  Resource Type The resource type to specify fields for (likely "candidates" here).
  Fields Comma-separated list of candidate fields to include in the output JSON.

Output

  • The node outputs an array of JSON objects representing candidates.
  • Each JSON object contains candidate data fields as returned by the Pulse API, filtered and limited according to the input properties.
  • The exact structure depends on the selected fields and filters but typically includes candidate identifiers, names, statuses, creation dates, and other relevant recruitment information.
  • No binary data output is produced by this operation.

Dependencies

  • Requires connection to the Pulse API via an API key credential configured in n8n.
  • The node depends on the Pulse API helper utilities bundled with the node implementation to handle authentication and API requests.
  • Proper network access to the Pulse API endpoint is necessary.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using unsupported filter keys or invalid field names may result in empty responses or errors.
    • Pagination parameters out of range (e.g., negative page numbers) might cause unexpected behavior.

  • Error Messages:

    • "The operation "getCandidatesList" is not supported for resource "candidates"!" — This indicates a mismatch between the selected resource and operation; ensure both are correctly set.
    • API errors related to authentication or rate limits will be passed through; verify API key validity and usage quotas.

  • Resolution Tips:

    • Double-check API credentials and permissions.
    • Validate filter keys and field names against the Pulse API documentation.
    • Use sensible pagination values to avoid empty pages.

Links and References

Discussion