The Companies API icon

The Companies API

Access company data, enrichment, analytics and more using The Companies API

Overview

This node integrates with The Companies API to enrich job titles. Specifically, the "Enrich job titles" operation allows users to input a job title name and receive enriched data related to that job title from the external service. This can be useful in scenarios such as enhancing CRM records, improving candidate profiles in recruitment workflows, or augmenting business intelligence datasets with standardized job title information.

For example, a user might input a raw job title like "Sr. Software Eng." and get back a normalized, enriched version with additional metadata about the role, industry relevance, or common synonyms.

Properties

Name Meaning
Name The job title string to enrich. This is the main input for the enrichment operation.

The property accepts a string representing the job title to be enriched.

Output

The node outputs JSON data containing the enriched job title information returned by The Companies API. The exact structure depends on the API response but generally includes detailed metadata about the job title.

  • The output is paired with the input item index.
  • If an error occurs during processing, the output JSON will contain an error field with the error message.
  • No binary data output is produced by this node.

Dependencies

  • Requires an API token credential for The Companies API to authenticate requests.
  • Uses the official SDK of The Companies API (@thecompaniesapi/sdk) to perform the enrichment call.
  • The node expects the environment to have network access to The Companies API endpoints.

Troubleshooting

  • Unknown operation error: If the operation parameter is set incorrectly or not supported, the node throws an error indicating "Unknown operation". Ensure the operation is set exactly to "enrichJobTitles".
  • SDK method not found: If the SDK does not expose the expected method, it will throw an error. This could indicate a version mismatch or incorrect SDK installation.
  • API authentication errors: Missing or invalid API token will cause authentication failures. Verify the API token credential is correctly configured.
  • Empty or invalid input: Providing empty or null job title strings may result in no meaningful output or API errors.
  • Continue on fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References


Note: This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion