{"id":43009991,"url":"https://github.com/merge-api/merge-sdk-typescript","last_synced_at":"2026-01-31T05:09:00.754Z","repository":{"id":41844093,"uuid":"480929199","full_name":"merge-api/merge-sdk-typescript","owner":"merge-api","description":"The Node SDK for accessing various Merge Unified APIs","archived":false,"fork":false,"pushed_at":"2023-08-09T20:16:28.000Z","size":1435,"stargazers_count":7,"open_issues_count":10,"forks_count":5,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-08-08T19:33:51.131Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/merge-api.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-04-12T18:31:30.000Z","updated_at":"2023-07-29T19:19:45.000Z","dependencies_parsed_at":"2022-08-02T15:46:03.055Z","dependency_job_id":null,"html_url":"https://github.com/merge-api/merge-sdk-typescript","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/merge-api/merge-sdk-typescript","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/merge-api%2Fmerge-sdk-typescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/merge-api%2Fmerge-sdk-typescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/merge-api%2Fmerge-sdk-typescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/merge-api%2Fmerge-sdk-typescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/merge-api","download_url":"https://codeload.github.com/merge-api/merge-sdk-typescript/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/merge-api%2Fmerge-sdk-typescript/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28929866,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T04:05:25.756Z","status":"ssl_error","status_checked_at":"2026-01-31T04:02:35.005Z","response_time":128,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-31T05:08:57.406Z","updated_at":"2026-01-31T05:09:00.747Z","avatar_url":"https://github.com/merge-api.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Deprecation Notice\n\nMerge has released a new version of our [Typescript SDK](https://github.com/merge-api/merge-node-client/). As part of that release, we are providing a deprecation notice of our legacy SDKs.\n\nTo help give you time to plan your migration to our latest SDK:\n\n- August 2023: SDK deprecation notice on our legacy Typescript SDKs.\n- Until February 2024: we’ll support updates as needed and address bugs in priority order\n- After February 2024: we’ll no longer make updates or bug fixes to the deprecated SDKs\n\nFor information about the deprecation notice see our [help center](https://help.merge.dev/en/collections/4258952-sdks) and for information about migrating to the Typescript SDK, see the [Typescript Migration Guide](https://help.merge.dev/en/articles/8229417-advanced-node-sdk-migration-guide).\n\n## @mergeapi/merge-sdk-typescript@3.0.10\n\nThis is the Merge API, Inc. SDK client for Typescript. It utilizes [Fetch API](https://fetch.spec.whatwg.org/) to\nmake requests to Merge on behalf of customers. We recommend only using this module in NodeJS server environments.\n\nLanguage level\n\n- ES5 - you must have a Promises/A+ library installed\n- ES6\n\nModule system\n\n- CommonJS\n- ES6 module system\n\nIt can be used in both TypeScript and JavaScript. In TypeScript, the definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html))\n\n## Documentation\n\nThe documentation for various Merge category API's can be found here:\n\n- [Accounting](https://www.merge.dev/docs/accounting/overview/)\n- [ATS](https://www.merge.dev/docs/ats/overview/) (Applicant Tracking Systems)\n- [CRM](https://www.merge.dev/docs/crm/overview/) (Customer Relationship Management)\n- [HRIS](https://www.merge.dev/docs/hris/overview/) (Human Resource Information Systems)\n- [Ticketing](https://www.merge.dev/docs/ticketing/overview/)\n\n### Basic Usage\n\nCommon to all categories is the Merge SDK `Configuration` object, which defines the authentication properties of\nyour requests. The `apiKey` property is the API Key of your Merge account, which can be administered in the\n[Merge dashboard](https://app.merge.dev/configuration/keys). The `accessToken` property will be the\n`X-Account-Token` header which identifies which of your customers' data you are requesting. See the following\nexamples for calling various category API's:\n\n#### node-fetch override on Node version \u003c 17.5\n\nThis SDK relies on the Fetch API, which is baked into Node starting at version 17.5. For those customers on older\nversions of Node, we allow you to explicitly set the fetchApi property like so:\n\n```\nimport fetch from 'node-fetch'\n\n...\n\nlet test_conf_crm = new Configuration({\n    apiKey: \"REDACTED\",\n    accessToken: \"REDACTED\",\n    fetchApi: fetch\n});\n```\n\nYou can find the node-fetch package here: https://www.npmjs.com/package/node-fetch . We have tested that\nnode-fetch @ 2.x.x can be passed in directly on Node version 16.0.0, however later versions of node-fetch or later\nversions of Node may require additional type adjustments to make it work.\n\n#### Accounting\n\n```\nconst confAccounting = new Configuration({\n    apiKey: \"REDACTED-YourAPIKeyWithMerge\",\n    accessToken: \"REDACTED-YourCustomer1Key\"\n});\n\nconst accountsApi = new merge_sdk.Accounting.AccountsApi(confAccounting);\n\n// lists the accounting accounts for customer 1\nlet response = await accountsApi.accountsList({}).catch((reason) =\u003e {\n    console.log(reason);\n});\nconsole.log(response);\n```\n\n#### ATS\n\n```\nconst confAts = new Configuration({\n    apiKey: \"REDACTED-YourAPIKeyWithMerge\",\n    accessToken: \"REDACTED-YourCustomer1Key\"\n});\n\nconst candidatesApi = new merge_sdk.ATS.CandidatesApi(confAts);\n\n// lists ats candidates for customer 1\nlet response = await candidatesApi.candidatesList({}).catch((reason) =\u003e {\n    console.log(reason);\n});\nconsole.log(response);\n```\n\n#### CRM\n\n```\nconst confCrm = new Configuration({\n    apiKey: \"REDACTED-YourAPIKeyWithMerge\",\n    accessToken: \"REDACTED-YourCustomer1Key\"\n});\n\nconst contactsApi = new merge_sdk.CRM.ContactsApi(confCrm);\n\n// lists crm contacts for customer 1\nlet response = await contactsApi.contactsList({});\nconsole.log(response);\n```\n\n#### HRIS\n\n```\nconst confHris = new Configuration({\n    apiKey: \"REDACTED-YourAPIKeyWithMerge\",\n    accessToken: \"REDACTED-YourCustomer1Key\"\n});\n\nconst employeesApi = new merge_sdk.HRIS.EmployeesApi(confHris);\n\n// list all employess reporting to managerId: x for customer 1\nlet response = await employeesApi.employeesList({\n    managerId: \"REDACTED\"\n});\nconsole.log(response);\n```\n\n#### Ticketing\n\n```\nconst confTicketing = new Configuration({\n    apiKey: \"REDACTED-YourAPIKeyWithMerge\",\n    accessToken: \"REDACTED-YourCustomer1Key\"\n});\n\nconst ticketsApi = new merge_sdk.Ticketing.TicketsApi(confTicketing);\n\n// list all ticketing tickets for customer 1\nlet response = await ticketsApi.ticketsList({});\nconsole.log(response);\n```\n\n### Enums\n\nMerge's API tries to unify enum values across integrations for a given category. However, there will be\nsporadic cases where integration enum values are too unique to be mapped. In these cases, the value will\ncome back as-is. In order to support this behavior, starting in v3.0.0 of merge-sdk-typescript, all enum\nvalues will be wrapped in an interface like:\n\n```\n{\n    value: EnumValue,\n    rawValue: string\n}\n```\n\nWhere the `rawValue` property will be the string from the Merge API, which may be the enum value as-is\nfrom the integration source.\n\n### Building\n\nTo build and compile the typescript sources to javascript use:\n\n```\nnpm install\nnpm run build\n```\n\n### Tests\n\nThere is a single rough test for the SDK which calls one API from each category. To run it, you must set\nconfiguration variables with the relevant API key and access token for each category. Additionally, the HRIS\nsection of the test checks an optional filtering query parameter.\n\n### Consuming\n\nnavigate to the folder of your consuming project and run one of the following commands.\n\n_published:_\n\n```\nnpm install @mergeapi/merge-sdk-typescript@3.0.9 --save\n```\n\n_unPublished (not recommended):_\n\n```\nnpm install PATH_TO_GENERATED_PACKAGE --save\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmerge-api%2Fmerge-sdk-typescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmerge-api%2Fmerge-sdk-typescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmerge-api%2Fmerge-sdk-typescript/lists"}