Skip to main content

Greenhouse Harvest Data Source

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that ingests data from a Greenhouse Harvest location.
grharvest_api.png

Greenhouse Harvest

Follow the instructions below to create a new data flow that ingests data from a Greenhouse Harvest source in Nexla.

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Greenhouse Harvest connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Greenhouse account, and click Next; or, create a new Greenhouse Harvest credential for use in this flow.

  3. In Nexla, Greenhouse Harvest data sources can be created using pre-built endpoint templates, which expedite source setup for common Greenhouse Harvest endpoints. Each template is designed specifically for the corresponding Greenhouse Harvest endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Greenhouse Harvest sources can also be configured manually, allowing you to ingest data from Greenhouse Harvest endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Greenhouse Harvest endpoints. Each template is designed specifically for the corresponding Greenhouse Harvest endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Fetch all Records of a Resource

    Fetch all records of any resource. Use the advanced tab for fetching a filtered list of records.

    • Select the resource type you want to fetch from the Resource Type dropdown menu. Available resource types include Applications, Candidates, Degrees, Disciplines, Jobs, Job Posts, Job Stages, Offers, Offices, Schools, Scheduled Interviews, and Users. The default value is candidates if not specified. The resource type determines which type of data will be retrieved from your Greenhouse account.
    • The endpoint uses GET requests to https://harvest.greenhouse.io/v1/{resource_type}?page=1&per_page=500 where {resource_type} is the Resource Type you select. The endpoint URL is automatically constructed based on the Greenhouse Harvest API base URL and the resource type.
    • The endpoint uses link header pagination (iteration.type: link.header) through the link header mechanism. The response data path is $[*], which extracts all items from the root-level array in the API response.
    • The endpoint fetches 500 records per page by default and automatically follows the link header to fetch additional pages until all records have been retrieved.

    This endpoint retrieves all records of the specified resource type from your Greenhouse account. Available resource types include Applications, Candidates, Degrees, Disciplines, Jobs, Job Posts, Job Stages, Offers, Offices, Schools, Scheduled Interviews, and Users. The endpoint supports pagination through the link header, which allows you to retrieve large datasets efficiently. When a response includes a link header with a rel="next" value, Nexla automatically uses it as the URL for the subsequent request to fetch the next page of results. You can use the advanced tab for fetching a filtered list of records. For detailed information about available resource types and the API response format, see the Greenhouse Harvest API documentation.

    Fetch one record of a Resource

    Fetch a specific record a resource.

    • Select the resource type you want to fetch from the Resource Type dropdown menu. Available resource types include Applications, Candidates, Degrees, Disciplines, Jobs, Job Posts, Job Stages, Offers, Offices, Schools, Scheduled Interviews, and Users. The default value is candidates if not specified. The resource type determines which type of data will be retrieved from your Greenhouse account.
    • Enter the ID of the specific record you want to fetch in the Resource ID field. This should be the unique identifier for the record you want to retrieve. The default value is 0 if not specified.
    • The endpoint uses GET requests to https://harvest.greenhouse.io/v1/{resource_type}/{resource_id} where {resource_type} is the Resource Type you select and {resource_id} is the Resource ID you provide. The endpoint URL is automatically constructed based on the Greenhouse Harvest API base URL, the resource type, and the resource ID.
    • The endpoint does not use pagination (iteration.type: static.url) and returns a single response. The response data path is $, which extracts the entire root-level object from the API response.

    This endpoint retrieves a specific record of the specified resource type from your Greenhouse account. Available resource types include Applications, Candidates, Degrees, Disciplines, Jobs, Job Posts, Job Stages, Offers, Offices, Schools, Scheduled Interviews, and Users. You must provide the unique identifier (Resource ID) for the record you want to retrieve. The endpoint returns a single record matching the specified resource type and ID. For detailed information about available resource types and the API response format, see the Greenhouse Harvest API documentation.

Configure Manually​

Greenhouse Harvest data sources can be manually configured to ingest data from any valid Greenhouse Harvest API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Greenhouse Harvest sources, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Content Format​

  1. Select the format in which the data from the Greenhouse Harvest API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The Greenhouse Harvest API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the Greenhouse Harvest API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Greenhouse Harvest API endpoints typically follow the pattern https://harvest.greenhouse.io/v1/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires Basic authentication via the Authorization header, where the API key is sent as the username, which is handled automatically by your credential configuration. For detailed information about Greenhouse Harvest API endpoints and available APIs, see the Greenhouse Harvest API documentation.