Skip to main content

How to Sync HRIS Data From Justworks Using the API

Guidance on how you can sync employee data from Justworks into Culture Amp using the API.

Jessie Walsh avatar
Written by Jessie Walsh
Updated this week

Who can use this feature?

Available on:

  • All Culture Amp subscriptions.

You can import employee data directly from Justworks into Culture Amp using a secure, one-way API connection powered by Merge. Merge is a trusted sub-processor that has partnered with Culture Amp to offer more integration options for our customers. Once set up, data will flow through automatically from your HRIS into Culture Amp, ensuring your employee list and demographic information are always up-to-date.

  • Data Flow: Employee Data flows from Justworks into Culture Amp (one-way sync). Changes made in Culture Amp will not sync back to your HRIS.

Choosing Your Integration Method


We offer two primary ways to connect your employee data. For Justworks, the API integration is the standard, recommended approach. The table below briefly outlines both options to help with decision-making:

Method

Type of Import

Best For

Key Difference

Full Integration (API)

Full Employee Import

Organizations seeking real-time, daily automation of all employee data that the API supports.

Data transfer is handled automatically via a secure API connection (e.g., using Merge). Users left off the file with a termination date (End Date) will become former employees upon sync. For users who simply fall off the data without a termination date, they will remain Active in Culture Amp until a manual sync is triggered by Culture Amp Support. We strongly recommend ensuring all terminated employees have an end_date in the HRIS to guarantee accurate deactivation.

SFTP (Secure File Transfer Protocol)

Partial Employee Import

Organizations that need complete control over file creation, have unique filtering requirements, or need to manage data fields not supported by the API.

You generate a file and securely transfer it to us at scheduled intervals. Users missing from the file are ignored unless you include an end_date.

Sync Your Data with the API


This integration establishes a secure, one-way connection to automatically sync employee data from Justworks into Culture Amp via our trusted partner, Merge API.

Access Requirements

To set up the connection, you’ll need:

Important Considerations for the Justworks API


The setup process is generally straightforward and relatively quick. However, involving an administrator familiar with your Justworks instance is always recommended to ensure you have the correct account access and can troubleshoot any permission-related issues quickly.

  • Field Mapping Limitation: Justworks currently does not support field mapping for custom demographics directly within the Culture Amp platform. This includes the ability to set up an exclusion field. Only the demographic fields listed in the table will automatically map. See the field mapping section for more details.

Terminology Breakdown

When working with your Justworks administrator, these terms may be helpful for clarifying your data structure:

Term

Also Known As

Definition & Example

Object

Data Container, Entity

The primary record where the data lives (e.g., the employee's Member record).

Field

Data Element, Attribute

The specific piece of data you are tracking (e.g., "Job Title," "preferred_name").

Value

Data Point

The specific data assigned to the employee for that Field (e.g., "Sales Representative").

Step 1: Connect and Authorize Your Justworks Account


The Justworks integration setup is initiated within the Culture Amp platform, which will redirect you to Justworks for authorization.

  1. Sign in to Culture Amp with an account that has Account Administrator or Employee data administrator access.

  2. Navigate to your Settings > Account > Integrations page in the Culture Amp platform.

  3. Select Justworks from the list of integrations and click Continue setup.

  4. Click I am an admin to confirm your Justworks administrator permissions.

  5. You will see Culture Amp’s request to read your Justworks employee data. Click Next.

  6. Open the window and login to Justworks to authorize the integration.

🔑 Authenticate Your Justworks Account

Overview

To authenticate your Justworks account, you will need to login to Justworks and authorize the integration in the linking flow.

Note: The steps below are sourced from Merge, our integration partner. We recommend checking their official guide for the most current instructions: Merge Justworks Account Linking Guide.

Prerequisites

Please ensure you fulfill all the requirements to set up the integration:

  • You are an Administrator in your company's Justworks instance, or someone has shared their access with you.

  • Your company is on an active paid plan with Justworks

Instructions

Step 1: Open window to the Justworks login screen

Step 2: Log into Justworks

Step 3: Click next on first screen

Step 4: Click on checkbox if applicable and click Authorize

The checkbox is only relevant if the company you're connecting to requires access to Sex or Date of Birth information. If they do not, you will not see this checkbox.

Fields Culture Amp has Read Access to

Employees

Date Of Birth
Display Full Name
Employee Number
Employment Status
First Name
Gender
Groups
Last Name
Manager
Mobile Phone Number
Personal Email
Preferred Name
Remote Created Timestamp
Start Date
Termination Date
Work Email

Groups

Name

Type

Step 2: Reviewing Field Mapping


The fields listed below are configured to automatically map to their equivalent in Justworks.

Note: While the underlying Merge API platform does have the technical capacity to support custom field mapping for many HRIS systems, the Culture Amp/Justworks integration is currently configured to only pull the demographics listed in this table. This simplifies setup but means you cannot map custom demographics at this time. If you require additional demographic data, we recommend using an SFTP or Manual File Import.

Culture Amp Field (The Destination)

Merge Common Model Field

Justworks Endpoint (Data Location)

Notes on Source & Known Quirks

Email (Unique Identifier)

workEmail (from Employee Object)

GET /v1/members (via emails field)

Crucial for matching. Must match the primary email in Culture Amp.

Employee ID (Unique Identifier)

employeeNumber (from Employee Object)

GET /v1/members

Directly mapped from the Justworks API field employee_number.

Name

displayFullName (from Employee Object)

GET /v1/members

Pulled from first_name, last_name, and the combined display_full_name fields.

Preferred Name

preferredName (from Employee Object)

GET /v1/members

Directly mapped from the Justworks API field preferred_name.

Date of Birth

dateOfBirth (from Employee Object)

GET /v1/members

Directly mapped from the Justworks API field date_of_birth.

Start Date

startDate (from Employee Object)

GET /v1/members

Corresponds to the employee's hire date. Directly mapped from the Justworks API field start_date.

End Date

terminationDate (from Employee Object)

GET /v1/members

Used to mark employees as former users. Directly mapped from the Justworks API field termination_date. Strongly recommended for accurate deactivation.

Manager Email / Manager ID / Manager Name

manager (from Employee Object)

GET /v1/members

Pulled from the manager UUID field. The system uses hard-coded logic to resolve this UUID into the manager's email, ID, and name in Culture Amp.

Custom Demographics

Justworks currently does not support field mapping for custom demographics. Only the fields listed above will sync.

Excluding Users (Workaround Required)


Justworks does not support an exclusion field via the API. If you need to exclude users from your sync, you must use Culture Amp’s bulk deactivation feature as a workaround.

  1. Allow the initial sync to import all users from Justworks, including those you want to exclude.

  2. In Culture Amp, export a copy of your user list:

    • Go to Settings > Employee Data > Users > Import & Export > Export

    • Check the box for Include deactivated users

    • The export will contain a column labeled Employee Deactivated.

  3. Update the Employee Deactivated column in the exported file:

    • Assign "TRUE" to all users you want to exclude (they will be deactivated).

    • Assign "FALSE" to users who should remain active.

  4. Save the file and perform a manual partial import:

    • Go to Settings > Employee Data > Users > Import & Export > Import users > Upload your file > Partial import.

  5. Once complete, deactivated users will remain deactivated and will not be reactivated in future syncs.

Step 3: Activate Integration


Once everything's set up, you'll see the integration screen. Click Sync and the system will run an initial sync to connect your Justworks account details and mappings.

Note: This sync does not import employee data yet.

  • You will see a "Syncing data" message. This initial sync can take up to 12 hours to complete, depending on the size and complexity of your Justworks configuration.

  • Feel free to navigate away from the page. The process runs in the background.

  • The "Syncing data" message confirms the connection and mapping setup. Once this first sync completes, you can proceed to import your employee data through another sync.

Note: As part of our commitment to data security, only data relevant to your import and field mappings will be stored.

Step 4: Run Your First Employee Data Sync


Once the initial setup sync is complete, the Integrations page in Culture Amp will update. Follow these steps to run your first employee data import:

  1. Click the Finalise sync button.

  2. Click Get Started.

  3. On the review page, ensure Sync is selected in the "Sync with merge" section (ignore the other options).

  4. Culture Amp will validate the data. If there are no concerns, click Next.

  5. Review the data: Carefully examine the review screen, which shows the number of new employees to be created, existing employees to be updated, and employees to be deactivated.

  6. If the data looks correct, click Import Data to pull the employees into Culture Amp.

  7. After the import is complete, click Go to Users to review the new users.

Important: If you see any unexpected numbers (e.g., too many employees being deactivated or created), do not proceed with the import. Check the Troubleshooting section or reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist.

Once these steps are completed, you will see the green "Syncing data" notification appear on the Integrations page.

After syncing is complete, you will see the latest sync information, including the date and time of the last sync, and confirmation that your integration is Connected on the Integrations page.

Setup Automated Daily Syncs


By default, auto-syncs are Off. We recommend enabling daily syncing to ensure your employee demographics are kept up-to-date.

  1. To enable: Go to Integrations, click on the Off button and toggle Auto-sync On.

  2. To disable: Go to Integrations, click on the On button, then click Turn off auto sync.

Important:

  • Auto-sync won’t run if the Finalise sync step is still displayed. Click Finalise sync to finish setup.

  • While you can enable daily auto-sync, due to the current integration logic for Justworks, updates aren't always instant, but they are guaranteed. See the Troubleshooting/FAQs section to learn more.

Troubleshooting & FAQs


If the fixes below don't resolve your issue, please reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist.

Justworks: Integration-Specific Errors

Issue

Cause

Suggested Fix

Missing Data/Users

The connecting Justworks service account lacks the required read access to necessary employee data objects.

Verify Permissions: Ensure the user has full permissions to read all necessary employee data in your Justworks instance.

Custom Demographics Not Syncing

Justworks API currently does not support custom field mapping via the Merge integration.

Alternative: If you require additional demographic data, you will need to manage these fields via a Manual File Import (CSV) or SFTP.

General Data Integrity & Import Management

The first step when investigating any data issue is to check the Import Summary Screen for your most recent import.

  1. Go to Settings > Employee Data > Import History.

  2. Select your most recent import to view details.

This screen provides information on the state of your integration, any specific errors, or will prompt you to run a manual sync to identify problems.

Switching From CSV or Other Imports

If you are moving from CSV uploads or a different integration, keep the following in mind:

  • Demographic Consistency: When mapping fields, you must map the data to the exact same demographic field you used historically (e.g., mapping to "TEAM" is different from mapping to "TEAM NAME"). Using an incorrect or slightly different title risks discontinuity in your trended survey results.

  • Recommended Action: To avoid confusion, we recommend navigating to Settings > Employee Data Demographics and deleting the old, unused demographics after your first successful sync. (This won't impact any previous survey results.)

Handling Duplicate Employees

Culture Amp matches employees based on their Email address. If an employee has a different email in Culture Amp than in Justworks, duplicate profiles will be created.

Scenario

Action to Take

A. Before Changes Are Applied

During the first sync review screen, stop the sync. Update the employee emails in Culture Amp to match those in Justworks.

  1. Go to the Culture Amp Users page,

  2. Click on the name of the employee you want to update.

  3. Update their email.

  4. Click Save and Exit to update.

  5. Repeat for all duplicated employees.

  6. Then, retry the integration sync.

B. After Changes Are Applied

To clean up the duplicated profiles:

  1. Go to the Culture Amp Users page,

  2. Locate the newest duplicate profile for that user. Click on the name to open up their profile.

  3. Remove existing Email/Employee ID and assign a fake Email or Employee ID to the user and save.

  4. Deactivate this updated profile.

  5. Update the original user profile to match emails in Justworks. This keeps the history on the existing employee record.

Further Guidance

Check out our dedicated support guide for further information on duplicate employee clean-up.

Sync Blocked to Protect Employee Privacy

Your automated daily sync might be blocked if Culture Amp detects a high-risk change for an employee. You will receive an email notification if this occurs.

  • When It Happens: The sync is blocked if a combination of an employee's Name, Date of Birth, or Email is changed simultaneously.

  • Purpose: This prevents one employee from accidentally getting access to another employee's private information (like performance reviews).

  • Fix: If you've intentionally changed the employee's details, you can run a manual sync to push the change through. Go to Settings > Employee Data > Users, click Import data, and select Sync. Culture Amp will guide you through the rest.

Redaction of Sensitive Data

As part of this integration, Culture Amp has the ability to redact sensitive data at your request. If you need any fields to be disabled/redacted for your account, please reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist.


💬 Need help? Just reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist.

Did this answer your question?