Gem

Gem is a modern recruiting platform that streamlines the talent acquisition process through automated sourcing, candidate engagement, interview scheduling, and pipeline management, helping recruiting teams scale their operations and improve hiring efficiency with data-driven insights.

Power end-to-end data operations for your Gem API with Nexla. Our bi-directional Gem connector is purpose-built for Gem, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Gem or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Gem workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Gem API credential, you need to obtain an API key from your Gem account. The API key is required to authenticate with the Gem API.

To obtain your API key, you need to have a Gem account with API access enabled. Once you have access to your account, you can generate an API key from your Gem account settings. The API key is sent in the X-API-Key header for all API requests to the Gem API. For detailed information about API key setup and authentication, refer to the Gem API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
API Key Value	Yes	Yes

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Gem API

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Gem API key in the API Key Value field. This is the API key you obtained from your Gem account settings. The API key is sent in the X-API-Key header for all API requests to the Gem API.

   Keep your API key secure and do not share it publicly. The API key provides access to your Gem account and should be treated as sensitive information. You can view and manage your API keys in your Gem account settings. The API key is sent in the X-API-Key header for all API requests to the Gem API. For detailed information about obtaining and managing API keys, see the Gem API documentation.

4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Gem API connector tile, 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.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Gem API endpoints. 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.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Gem API data sources can also be manually configured to ingest data from any valid Gem API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Gem API endpoints typically follow the pattern https://api.gem.com/v0/{endpoint_path}. Requests are authenticated automatically via the X-API-Key header configured in your credential.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Gem API data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Gem API destination, and select the Send to Destination option from the menu. Select the Gem API connector from the list of available destination connectors, then select the credential that will be used to connect to the Gem API organization, and click Next; or, create a new Gem API credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Gem API endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Candidate/Note/Project/Project Fields

Create new candidate/Note/Project/Project Fields.

• Select the type of resource to create from the Candidate/Note/Project/Project Fields dropdown menu. Available options are:

  • Candidates: Create a new candidate
  • Notes: Create a new note
  • Projects: Create a new project
  • Project Fields: Create a new project field
• The endpoint uses POST requests to https://api.gem.com/v0/{event_type} where {event_type} is the Candidate/Note/Project/Project Fields type you select. The endpoint URL is automatically constructed based on the Gem API base URL and the selected resource type.
• The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically formatted according to the schema fields and data mapping you configure. Each record in your Nexset will be sent as a JSON object containing the resource data to create.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a resource. If you need to create multiple resources, you can send multiple records, but each will be processed as a separate request.
• This endpoint does not automatically create a data source to track the responses received from the Gem API after each call.

The resource type determines which endpoint is used: candidates, notes, projects, or project fields. The request body must be properly formatted JSON that matches the Gem API specification for creating the selected resource type. The endpoint requires API Key authentication via the X-API-Key header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about creating candidates, notes, projects, or project fields, including required fields, field names, and request formats, see the Gem API documentation.

Modify Candidate

Modifies a candidate based on ID. Only the fields included in the request argument will be modified.

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

• The endpoint uses PUT 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 sends data from your Nexset as the request body in JSON format. The request body is automatically formatted according to the schema fields and data mapping you configure. Each record in your Nexset will be sent as a JSON object containing the candidate fields to modify.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to modify a candidate. If you need to modify multiple candidates, you can send multiple records, but each will be processed as a separate request.
• This endpoint does not automatically create a data source to track the responses received from the Gem API after each call.

Candidate IDs should be valid IDs from your Gem account. Only the fields included in the request body will be modified; other fields will remain unchanged. The request body must be properly formatted JSON that matches the Gem API specification for modifying candidates. The endpoint requires API Key authentication via the X-API-Key header, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about modifying candidates, including required fields, field names, and request formats, see the Gem API documentation.

Manual configuration

Gem API destinations can also be manually configured to send data to any valid Gem API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Gem API endpoints typically follow the pattern https://api.gem.com/v0/{endpoint_path} and generally use JSON format for request bodies. Requests are authenticated automatically via the X-API-Key header configured in your credential.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Gem API endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Gem API endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.