Merge API basics

Merge SDKs

Take advantage of our SDKs to speed up your backend integration with Merge.

Overview

Once you’ve added our embedded Linking Flow to your app, your users can authorize any integration that Merge supports.

The SDKs listed below will allow your app’s backend to communicate with Merge and interact with data from those integrations.

Note that our SDKs are in various stages of active development. Please contact us at support@merge.dev with any questions.

Complete category SDKs

The following SDKs encompass all of Merge’s categories. Even if you do not plan on using more than one Merge API category right now, these SDKs are more frequently updated (to rollout changes to all customers sooner) and provide upgrade flexibility in case you find new Merge API categories useful in the future.

We are in the process of releasing new versions of these SDKs.

If you do not see your language here, get in touch with us at support@merge.dev. If you would prefer to manually build your own integration with Merge, refer to our API reference.

Fetching data

Learn to fetch data from the integrations your users have authorized by reviewing the example usage of the Merge HRIS SDK below.

1# Using Advanced Python SDK.
2
3from pprint import pprint
4
5import merge
6from merge.client import Merge
7
8# Swap YOUR_API_KEY below with your production key from:
9# https://app.merge.dev/keys
10api_key = "<YOUR_API_KEY>"
11
12# The string 'TEST_ACCOUNT_TOKEN' below works to test your connection
13# to Merge and will return dummy data in the response.
14# In production, replace this with account_token from user.
15account_token = "TEST_ACCOUNT_TOKEN"
16
17merge_client = Merge(api_key=api_key, account_token=account_token)
18
19try:
20    employee_return_object = merge_client.hris.employees.list()
21    employee_next_cursor = employee_return_object.next
22    employee_previous_cursor = employee_return_object.previous
23    employee_list = employee_return_object.results
24    pprint(employee_list)
25except:
26    print("Exception when calling Employees API -> list_employees.")
27
28# Pagination Example
29if employee_next_cursor:
30    try:
31        employee_next_return_object = merge_client.hris.employees.list(
32            cursor=employee_next_cursor
33        )
34        next_employee_list = employee_next_return_object.results
35        pprint(next_employee_list)
36    except:
37        print("Exception when calling Employees API -> list_employees.")