UKG Ready API

Integrate UKG Ready with your product—along with any other
HR & Payroll
application

Connect your product to all the applications your customers use via Merge's

HR & Payroll

Unified API to close more deals, retain customers, and expand to new markets

Get a demo

Sync UKG Ready Data

Bank Info

The BankInfo object is used to represent the Bank Account information for an Employee.

Docs

Benefits

The Benefit object is used to represent a benefit that an employee has enrolled in.

Docs

Companies

The Company object is used to represent a company within the HRIS / Payroll system.

Docs

Dependents

The Dependent object is used to represent a dependent (e.g. child, spouse, domestic partner, etc) of an Employee

Docs

Employees

The Employee object is used to represent any person who has been employed by a company.

Docs

Employee Payroll Runs

The EmployeePayrollRun object is used to represent an employee's pay statement for a specific payroll run.

Docs

Employer Benefits

The Employer Benefit object is used to represent a benefit plan offered by a company.

Docs

Employments

The Employment object is used to represent a job position at a company. If an integration supports historical tracking of employments, it will be reflected in the data. If not, a new Employment object will be created whenever there is a change in job title or pay. The effective_date field should be used to order Employment objects, with the most recent date corresponding to the latest employment record for an employee.

Docs

Groups

The Group object is used to represent any subset of employees across, for example, DEPARTMENT or TEAM. Employees can be in multiple Groups.

Docs

Locations

The Location object is used to represent an address that can be associated with an employee.

Docs

Pay Groups

The PayGroup object is used to represent a subset of employees that are put together for payroll processing purposes.

Docs

Payroll Runs

The PayrollRun object is used to represent a group of pay statements for a specific pay schedule.

Docs

Teams

The Team object is used to represent a subdivision of the company, usually a department. Each employee will be grouped into one specific Team.

Docs

Time Off

The TimeOff object is used to represent all employees' Time Off entries.

Docs

Time Off Balances

The TimeOffBalance object is used to represent current balances for an employee's Time Off plan.

Docs

FAQ on integrating with UKG Ready’s API

Trusted to power integrations Globally

Build Smarter

Make integrations your competitive advantage

More sales, less code, fewer headaches

Focus on your core product

Stop diverting your engineers to yet another integration and let them get back to work.

Give customer success a break

Manage your simplified integration issues in a single pane. No therapist required.

Stop losing sales due to integrations

Launch integrations in days, not quarters. Your sales team will thank you.

Seamless Account Linking

Integration authentication that feels like magic

Merge seamlessly manages authentication and authorization on behalf of your customers.

Offer account linking and permission controls to your users with Link for a customizable frontend or with Magic Link for URL-based authorization

View docs

APIs Made Simple

The toolkit for all your integration needs

We make integrations painless with accessible API design, dead-simple SDKs, and beautiful documentation that we agonize over.

View docs

Get Employee Data

import merge
from merge.client import Merge
merge_client = Merge(api_key="<YOUR_API_KEY>", account_token="<YOUR_ACCOUNT_TOKEN>")
employee = merge_client.hris.employees.list()

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.list()

ApiClient.instance.authentications.tokenAuth = {
  type: 'bearer',
  accessToken: 'API_KEY',
};
new EmployeesApi().employeesList('ACCOUNT_TOKEN', {}, (data) => {
  console.log(data);
});

import (
  "context"
  "fmt"
  merge "github.com/fern-api/merge-go"
  mergeclient "github.com/fern-api/merge-go/client"
  "github.com/fern-api/merge-go/hris"
)

client := mergeclient.NewClient(
  mergeclient.ClientWithAuthApiKey("<YOUR_API_KEY>"),
  mergeclient.ClientWithHeaderAccountToken("<YOUR_ACCOUNT_TOKEN>"),
)
employee, err := client.Hris().Employees().List(
  context.TODO(),
  &hris.EmployeesRetrieveRequest{
    IncludeRemoteData: merge.Bool(true),
  },
)
if err != nil {
  return err
}
fmt.Printf("Retrieved employee with ID %q\n", *employee.Id)

ApiClient client = Configuration.getDefaultApiClient();
client.setBasePath('https://api.merge.dev/api/ats/v1');
ApiKeyAuth tokenAuth = client.getAuthentication('tokenAuth');
tokenAuth.setApiKey('API_KEY');
CandidatesApi apiInstance = new CandidatesApi(client);
apiInstance.candidatesList('ACCOUNT_TOKEN');

import com.merge.api.MergeApiClient;
import com.merge.api.resources.hris.employees.requests.EmployeesRetrieveRequest;
import com.merge.api.resources.hris.types.Employee;
MergeApiClient mergeClient = MergeApiClient.builder()
    .accountToken("ACCOUNT_TOKEN")
    .apiKey("API_KEY")
    .build();
Employee employee = mergeClient.hris().employees().list(
    EmployeesRetrieveRequest.builder()
        .includeRemoteData(true)
        .build());

{
"id": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"remote_id": "19202938",
"employee_number": "2",
"company": "8d9fd929-436c-4fd4-a48b-0c61f68d6178",
"first_name": "Dirna",
"last_name": "Emanuel",
"display_full_name": "Dirna Emanuel",
"username": "dirnaemanuel",
"groups": [
  "21a54124-397f-494d-985e-3c5b330b8a68"
],
"work_email": "dirna@merge.dev",
"personal_email": "dirnaemanuel@gmail.com",
"mobile_phone_number": "+1234567890",
"employments": [
  "17a54124-287f-494d-965e-3c5b330c9a68"

+ More languages

Meta Endpoint

Programmatically access required schemas

Third-party providers require specific (and often different) fields to write data to their APIs, making your code a mess.

Dynamically fetch required data schemas from Merge’s /meta endpoint to make POST or PATCH requests that just work.

View Docs

Beyond Building

Rely on the best integration observability system

Let our logs, issue detection, and automated alerts save your customer success team time, money, and headaches.

Forget maintenance - let your developers focus on building!

Start for free

How Drata helps thousands streamline their SOC 2 with Merge

Read case study

”Working with Merge’s Unified API and beautiful React component took less than a sprint to integrate, test, and release.”

Daniel Marashlian

Co-Founder & CTO

We're the cheat code to your integrations strategy

Revolutionize your integrations strategy for HR, payroll, directory, ATS, project management, ticketing, accounting and CRM platforms.

Start for free or talk to our sales team and learn how Merge makes it easy to add all your integrations in days – not years.

Get a demo

Create account

Integrate UKG Ready with your product—along with any other
HR & Payroll
application

Top integration use cases for UKG Ready

Sync UKG Ready Data

FAQ on integrating with UKG Ready’s API

Make integrations your competitive advantage

Focus on your core product

Give customer success a break

Stop losing sales due to integrations

Integration authentication that feels like magic

The toolkit for all your integration needs

Programmatically access required schemas

Rely on the best integration observability system

How Drata helps thousands streamline their SOC 2 with Merge

Read more about building and maintaining multiple integrations

We're the cheat code to your integrations strategy

Integrate UKG Ready with your product—along with any other HR & Payroll application

Top integration use cases for UKG Ready

Sync UKG Ready Data

FAQ on integrating with UKG Ready’s API

Make integrations your competitive advantage

Focus on your core product

Give customer success a break

Stop losing sales due to integrations

Integration authentication that feels like magic

The toolkit for all your integration needs

Programmatically access required schemas

Rely on the best integration observability system

How Drata helps thousands streamline their SOC 2 with Merge

Read more about building and maintaining multiple integrations

We're the cheat code to your integrations strategy

Integrate UKG Ready with your product—along with any other
HR & Payroll
application