Skip to main content

Gem API Data Source

Follow the instructions below to create a new data flow that ingests data from a Gem API source in Nexla.
gem_api.png

Gem API

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 Gem API connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Gem API instance, and click Next; or, create a new Gem API credential for use in this flow.

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

    Gem API sources can also be configured manually, allowing you to ingest data from Gem API 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 Gem API endpoints. Each template is designed specifically for the corresponding Gem API 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.

    Get candidate by ID

    Returns the candidate object with the corresponding ID.

    • Enter the ID of the candidate you want to retrieve in the Candidate ID field. This should be a valid candidate ID from your Gem account.

    • The endpoint uses GET requests to https://api.gem.com/v0/candidates/{candidate_id} where {candidate_id} is the Candidate ID you provide. The endpoint URL is automatically constructed based on the Gem API base URL and the candidate ID.
    • The endpoint does not use pagination and returns the candidate object in a single request.
    • The endpoint will return the complete candidate object with the specified ID. The response data is extracted from the root-level object in the API response ($), and Nexla will process the entire response structure.

    Candidate IDs should be valid IDs from your Gem account. The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $, which extracts the entire root-level object from the API response. For detailed information about retrieving candidates by ID, see the Gem API documentation.

    List Candidate events/notes/uploaded resumes

    Returns a list of all events/notes/uploaded resumes for the given candidate and supports pagination and search parameters created_after, created_before.

    • Enter the ID of the candidate whose events, notes, or resumes you want to retrieve in the Candidate ID field. This should be a valid candidate ID from your Gem account.

    • Select the type of candidate data you want to retrieve from the Candidate Type dropdown menu. Available options are:

      • Events: Returns a list of all events for the given candidate
      • Notes: Returns a list of note objects on the given candidate
      • Resumes: Returns a list of all resumes uploaded for the candidate
    • The endpoint uses GET requests to https://api.gem.com/v0/candidates/{candidate_id}/{candidate_type} where {candidate_id} is the Candidate ID and {candidate_type} is the Candidate Type you provide. The endpoint URL is automatically constructed based on the Gem API base URL, the candidate ID, and the candidate type.
    • The endpoint does not use pagination and returns all matching records in a single request.
    • The endpoint will return all events, notes, or resumes for the specified candidate. The response data is extracted from the root-level array in the API response ($[*]), with each item processed individually.

    Candidate IDs should be valid IDs from your Gem account. The candidate type determines what data is retrieved: events, notes, or uploaded resumes. The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $[*], which extracts all items from the root-level array in the API response. For detailed information about listing candidate events, notes, or resumes, see the Gem API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Gem API data sources can be manually configured to ingest data from any valid Gem 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 Gem API sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Gem API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the Gem 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. Gem API endpoints typically follow the pattern https://api.gem.com/v0/{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 API Key authentication via the X-API-Key header, which is handled automatically by your credential configuration. For detailed information about Gem API endpoints and available APIs, see the Gem API documentation.