Skip to main content

Merge

Merge provides a single, unified API for integrating with dozens of Applicant Tracking Systems (ATS). Instead of building and maintaining a separate integration for each provider, you connect once to Merge and read or write normalized candidate, job, application, and interview data through one standardized interface, with each end-user integration represented by a Linked Account.

Merge icon

Power end-to-end data operations for your Merge API with Nexla. Our bi-directional Merge connector is purpose-built for Merge, 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 Merge or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Merge 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 Merge credential, you need a Merge API key and the Account Token for the Linked Account you want to read from or write to. Merge authenticates every request with two headers: an API key sent as a Bearer token in the Authorization header, and a Linked Account token sent in the X-Account-Token header that identifies which end-user integration the request applies to.

To obtain your Merge credentials, follow these steps:

  1. Sign in to the Merge Dashboard.

  2. Navigate to API Keys in the dashboard. Copy your Production Access Key, or generate a new Production or Test access key. This value is your API Key. Add it to the Authorization header with a Bearer prefix when calling the API.

  3. Obtain the Account Token for the Linked Account whose data you want to access:

    • For test Linked Accounts, you can find the Account Token directly in the Linked Accounts dashboard.
    • For production Linked Accounts, the Account Token is the permanent account_token returned when your end user completes the Merge Link authorization flow (Merge Link exchanges the temporary public_token for a durable account_token). Store this token securely.
  4. Confirm which regional Base URL applies to your Merge tenant. Merge defaults to https://api.merge.dev for US tenants. Use https://api-eu.merge.dev for the EU data center or https://api-ap.merge.dev for the APAC data center.

Treat both the API key and the Account Token as sensitive credentials. If either is compromised, regenerate the API key in the Merge Dashboard and re-authorize the affected Linked Account. For full details on authentication, Linked Accounts, and available endpoints, see the Merge API documentation.

Authenticate

Credentials required

FieldRequiredSecretDescription
API KeyYesYesYour Merge API key for bearer token authentication.
Account TokenYesYesThe X-Account-Token identifying the linked end-user account. Required for all ATS data endpoints. Obtain from the Merge dashboard or Linked Account API.
Base URLYesNoThe base URL for the Merge API. Defaults to https://api.merge.dev for US tenants. Use https://api-eu.merge.dev for EU or https://api-ap.merge.dev for APAC.

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.

  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 Merge API key in the API Key field. This value is sent as a Bearer token in the Authorization header for every request and must be kept confidential.

  4. Enter the Linked Account token in the Account Token field. This value is sent in the X-Account-Token header and identifies the end-user integration whose ATS data will be read or written.

  5. Enter the Base URL for your Merge data center, or leave the default https://api.merge.dev for US tenants.

    If your API key or Account Token is compromised, regenerate the API key in the Merge Dashboard and re-authorize the affected Linked Account. For detailed information about authentication, Linked Accounts, and available endpoints, see the Merge API documentation.

  6. 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 Merge connector tile, then select the credential that will be used to connect to Merge, and click Next; or, create a new Merge 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 Merge ATS 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. Most list endpoints are cursor-paginated; Nexla automatically follows the pagination cursor to retrieve all available records.

[Rest API] Get Account Details

Retrieves detailed information about the authenticated account.

[Rest API] List Activities

Returns a paginated list of activities in the ATS system.

[Rest API] List Applications

Returns a paginated list of job applications in the ATS system.

[Rest API] List Attachments

Returns a paginated list of file attachments in the ATS system.

[Rest API] List Candidates

Returns a paginated list of job candidates in the ATS system.

[Rest API] List Departments

Returns a paginated list of departments in the ATS system.

[Rest API] List EEOCs

Returns a paginated list of EEOC (Equal Employment Opportunity Commission) records in the ATS system.

[Rest API] List Interviews

Returns a paginated list of job interviews in the ATS system.

[Rest API] List Job Interview Stages

Returns a paginated list of job interview stages in the ATS system.

[Rest API] List Jobs

Returns a paginated list of job openings in the ATS system.

[Rest API] List Offers

Returns a list of job offers from the ATS system.

[Rest API] List Offices

Returns a list of offices from the ATS system.

[Rest API] Get Sync Status

Returns the synchronization status of the ATS system integration.

[Rest API] List Users

Returns a list of users from the ATS system.

[Rest API] List Tags

Lists candidate or job tags used for segmentation and filtering.

[Rest API] List Job Postings

Lists external job board postings created from Job records.

[Rest API] List Scorecards

Retrieves interviewer scorecards and structured feedback for candidates.

[Rest API] List Screening Questions

Retrieves job-specific screening questions and candidate answers.

[Rest API] List Reject Reasons

Lists the rejection reason labels configured in the connected ATS.

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

Merge data sources can also be manually configured to ingest data from any valid Merge Unified 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.

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 Merge 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 Merge destination, and select the Send to Destination option from the menu. Select the Merge connector from the list of available destination connectors, then select the credential that will be used to connect to Merge, and click Next; or, create a new Merge 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 Merge ATS 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.

[Rest API] Create Application

Creates a new application (and optionally a new candidate) in the connected ATS. Each record from your Nexset is sent as a separate request to Merge.

[Rest API] Create Candidate

Creates a new candidate record in the connected ATS.

[Rest API] Change Application Stage

Moves an application to a different pipeline stage in the connected ATS.

  • This endpoint requires the Application ID of the application to update. Provide the ID in the endpoint configuration so Nexla can target the correct record.

[Rest API] Update Candidate

Updates an existing candidate's profile fields in the connected ATS.

  • This endpoint requires the Candidate ID of the candidate to update. Provide the ID in the endpoint configuration so Nexla can target the correct record.

[Rest API] Create Activity

Logs a note or activity against a candidate record in the connected ATS.

[Rest API] Create Attachment

Uploads a resume or other file attachment to a candidate record in the connected ATS.

[Rest API] Schedule Interview

Schedules an interview for a candidate's application in the connected ATS.

Manual configuration

Merge destinations can also be manually configured to send data to any valid Merge Unified 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.

Merge write endpoints expect JSON in the request body. For endpoints that update a specific record, such as changing an application stage or updating a candidate, include the record ID in the endpoint configuration so the request targets the correct object.

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 Merge endpoint, open the destination resource menu, and select Activate.

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