
Product
Introducing Scala and Kotlin Support in Socket
Socket now supports Scala and Kotlin, bringing AI-powered threat detection to JVM projects with easy manifest generation and fast, accurate scans.
@mergeapi/merge-node-client
Advanced tools
[](https://www.npmjs.com/package/@mergeapi/merge-node-client) [](https://github.com/fer
The Merge Node.js library provides access to the Merge API from JavaScript/TypeScript.
API reference documentation is available here.
npm install --save @mergeapi/merge-node-client
# or
yarn add @mergeapi/merge-node-client
import { MergeClient } from '@mergeapi/merge-node-client';
const merge = new MergeClient({
apiKey: 'YOUR_API_KEY',
accountToken: 'YOUR_ACCOUNT_TOKEN',
});
This SDK contains the ATS, HRIS, CRM, Ticketing, Accounting, and File Storage categories. Even if you do not plan on using more than one Merge API category right now, the SDK provides upgrade-flexibility in case you find new Merge API categories useful in the future.
Each category is namespaced:
const merge = new MergeClient({
apiKey: 'YOUR_API_KEY',
accountToken: 'YOUR_ACCOUNT_TOKEN',
});
merge.ats. // APIs specific to the ATS Category
merge.hris. // APIs specific to the HRIS Category
Below are code snippets of how you can use the Node SDK.
import { MergeClient, Merge } from '@mergeapi/merge-node-client';
const merge = new MergeClient({
apiKey: 'YOUR_API_KEY',
// `accountToken` may be omitted if necessary (e.g., during the initial Link session)
accountToken: 'YOUR_ACCOUNT_TOKEN',
});
const linkTokenResponse = await merge.ats.linkToken.create({
endUserEmailAddress: "john.smith@gmail.com",
endUserOrganizationName: "acme",
endUserOriginId: "1234",
categories: [Merge.ats.CategoriesEnum.ATS],
linkExpiryMins: 30,
});
console.log("Created link token", linkTokenResponse.linkToken)
import { MergeClient, Merge } from '@mergeapi/merge-node-client';
const merge = new MergeClient({
apiKey: 'YOUR_API_KEY'
});
const accountTokenResponse = await merge.ats.accountToken.retrieve(publicToken)
console.log("Retrieved account token", accountTokenResponse.accountToken)
import { MergeClient, Merge } from '@mergeapi/merge-node-client';
const merge = new MergeClient({
apiKey: 'YOUR_API_KEY',
accountToken: 'YOUR_ACCOUNT_TOKEN',
});
employee = await merge.hris.employees.retrieve("0958cbc6-6040-430a-848e-aafacbadf4ae")
import { MergeClient, Merge } from '@mergeapi/merge-node-client';
const merge = new MergeClient({
apiKey: 'YOUR_API_KEY',
accountToken: 'YOUR_ACCOUNT_TOKEN',
});
candidate = await merge.ats.candidates.retrieve(
id="521b18c2-4d01-4297-b451-19858d07c133")
import { MergeClient, Merge } from '@mergeapi/merge-node-client';
const merge = new MergeClient({
apiKey: 'YOUR_API_KEY',
accountToken: 'YOUR_ACCOUNT_TOKEN',
});
const candidatesResponse = await merge.ats.candidates.list({
created_after="2030-01-01"
})
console.log(candidatesResponse.results)
import { MergeClient, Merge } from '@mergeapi/merge-node-client';
const merge = new MergeClient({
apiKey: 'YOUR_API_KEY',
accountToken: 'YOUR_ACCOUNT_TOKEN',
});
contact = await merge.accounting.contacts.retrieve(
"c640b80b-fac9-409f-aa19-1f9221aec445")
import { MergeClient, Merge } from '@mergeapi/merge-node-client';
const merge = new MergeClient({
apiKey: 'YOUR_API_KEY',
accountToken: 'YOUR_ACCOUNT_TOKEN',
});
await merge.ticketing.tickets.create({
model: {
name: "Please add more integrations",
assignees: ["17a54124-287f-494d-965e-3c5b330c9a68"],
creator="3fa85f64-5717-4562-b3fc-2c963f66afa6",
due_date="2022-10-11T00:00:00Z",
status=merge.ticketing.TicketStatusEnum.Open,
},
})
import { MergeClient, Merge } from '@mergeapi/merge-node-client';
import * as fs from 'fs/promises';
const merge = new MergeClient({
apiKey: 'YOUR_API_KEY',
accountToken: 'YOUR_ACCOUNT_TOKEN',
});
const listResponse = await merge.filestorage.files.list({
name: "<FILE_NAME>"
})
const file = response.results[0]
const localFilepath = `<LOCAL_FILE_PATH>/${file.name}`
const response = await merge.filestorage.files.downloadRetrieve(file.id)
const fileStream = fs.createWriteStream(localFilepath);
await stream.pipeline(response, fileStream);
The SDK may return paginated results. Endpoints that return paginated results will
include a next
and prev
property on the response. To get the next page, you can
pass in the value of next
to the cursor property on the request. Similarly, to
get the previous page, you can pass in the value of prev
to the cursor property on
the request.
Below is an example of iterating over all pages:
// response contains the first page
let response = merge.hris.employees.list({
createdAfter: "2030-01-01",
})
// if there is a next page, load it by passing `next` to the cursor argument
while (response.next != null) {
response = merge.hris.employees.list({
cursor: response.next,
created_after: "2030-01-01",
})
}
While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!
FAQs
[](https://www.npmjs.com/package/@mergeapi/merge-node-client)
The npm package @mergeapi/merge-node-client receives a total of 60,061 weekly downloads. As such, @mergeapi/merge-node-client popularity was classified as popular.
We found that @mergeapi/merge-node-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports Scala and Kotlin, bringing AI-powered threat detection to JVM projects with easy manifest generation and fast, accurate scans.
Application Security
/Security News
Socket CEO Feross Aboukhadijeh and a16z partner Joel de la Garza discuss vibe coding, AI-driven software development, and how the rise of LLMs, despite their risks, still points toward a more secure and innovative future.
Research
/Security News
Threat actors hijacked Toptal’s GitHub org, publishing npm packages with malicious payloads that steal tokens and attempt to wipe victim systems.