Skip to main content

Sync HRIS Data From Deel via the API

Learn how to sync employee data from Deel into Culture Amp using a secure, one-way API integration.

Jessie Walsh avatar
Written by Jessie Walsh
Updated today

Who can use this feature?

Available on:

  • All Culture Amp subscriptions.

You can import employee data directly from Deel into Culture Amp using a secure, one-way API connection. This ensures your employee list and demographics are always up-to-date.

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

Initial Setup Timeframe: As this integration is currently in Beta, we recommend a setup and validation timeframe of 1–2 weeks.

This Integration is Currently in Beta

This is a new HRIS integration that is currently in Beta. Beta means you’re one of the first to try out our latest integration before its full launch. During this phase, we're actively seeking your feedback to refine and improve the integration experience further. While it's fully functional and secure, you may encounter occasional bugs or changes as we fine-tune the experience. Your input is invaluable in shaping the final version, so please don't hesitate to share your thoughts and experiences with us via this survey.

Choosing Your Integration Method


We offer two primary ways to connect your employee data. The table below briefly outlines both and should help with the decision on which is the best approach for your organization:

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. Users with an End Date in the HRIS become former employees instantly upon sync. If a user is simply removed from the sync report without an End Date, they will remain "Active" in Culture Amp until a manual sync is performed by our Culture Amp Support team. Properly terminating employees in your HRIS with an End Date is the only way to guarantee automatic deactivation.

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, so must be included on the file with an end date, to become former.

API Integration Checklist


  1. Access Requirements & Terminology — Prerequisites and system logic.

  2. Step 1: Connect & Authenticate — Locating and entering your API credentials.

  3. Step 2: Field Mapping — Aligning your Deel demographics with Culture Amp.

  4. Step 3: Activate Integration — Establishing the technical connection.

  5. Step 4: Run Your First Sync — Reviewing and importing employee records.

  6. Troubleshooting & FAQs — Solving errors, duplicates, and sync blocks.

Before You Start: Access Requirements & Terminology


To set up the connection, you’ll need:

Important Considerations & Data Limitations

  • Employee ID Mapping (Worker ID): In Deel, the unique identifier used for syncing is the Worker ID. This will map automatically to the Employee ID field in Culture Amp. If you are transitioning from a manual CSV import, verify that your current Culture Amp Employee IDs match the Deel Worker IDs.

  • Essential Permission Scopes: When generating your API token in Deel, you must select all available scopes, specifically including "contracts." Missing this scope is the most common cause of "403 Forbidden" errors and will prevent Culture Amp from reading your employee data.

  • Unsupported Demographics (Gender & Level): Due to specific API restrictions within Deel, the Gender and Seniority/Level fields cannot be synced automatically at this time. If you require these demographics for your reporting, they must be managed via a manual file upload.

  • Hierarchy Sync: Culture Amp builds your reporting structure using the Direct Manager field in Deel. For the hierarchy to sync correctly, the manager must be an active user in Deel with a valid work email address that matches their Culture Amp profile.

  • Active Status Logic: The integration is designed to pull users marked as "Active" in Deel. Employees without a valid "Active" status or those missing a Start Date may not appear in the sync results.

  • Syncing Teams: Deel "Teams" are treated as a separate organizational group. Because these don't map automatically, you must manually align them to a Culture Amp demographic (like "Department") during Step 2: Field Mapping.

Terminology Breakdown

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

Term

Also Known As

Definition & Example

Worker ID

Employee Number

The unique identifier in Deel (found in the People profile) that anchors the record to the Culture Amp Employee ID.

Organization Token

API Key

The unique security string generated in the Deel Developer Center to authorize the integration.

Direct Manager

Supervisor

The person assigned to a contract in Deel who will be used to build your reporting hierarchy.

Team

Group / Department

The organizational unit in Deel (e.g., "Engineering") that requires manual mapping in Step 2.

Required Permissions & Rationale

Permission/Role

Permissions Needed in Deel

Rationale

Organization Admin

Developer Center Access

Required to generate the Organization Token and select API scopes.

People (Read)

rest/v2/people

Allows Culture Amp to pull demographic data like names, emails, and hire dates.

Contracts (Read)

Full Scope Selection

Essential: Prevents 403 errors and allows access to the worker data model.

Teams (Read)

rest/v2/teams

Allows organizational groupings to be pulled for manual mapping.

Step 1: Connect & Authenticate Your Deel Account


  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 Deel from the list of integrations and click Continue setup

  4. When asked how you would like to authenticate, select Use my Credentials

  5. Click I am admin to confirm your Deel administrator access

  6. When asked what type of account you're connecting, select Production data

  7. You will see CultureAmp’s request to read your Deel employee data. Click Next

  8. On the Connect Deel screen, click Open Window. You will be directed to enter your credentials and sign in.

  9. Follow the prompts to generate and enter your Deel Organization Token

🔑 How to Generate your Deel Organisation Token

To authenticate Deel, you will need to provide the following information:

  • Organization Token

Prerequisites:

  • You must be a Deel admin to complete the linking flow

  • Your Deel account must have API access enabled. Contact your Deel account manager to confirm if you are unsure of this

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

Instructions:

Step 1: Create an organization token

  1. In your Deel portal, go to Developer Center in the drop-down menu from the top bar

  2. Click generate new token

    Screenshot 2025-09-23 at 4.55.57 PM.png

  3. Label your token, choose "Organization token (Recommended)", and click next

    Screenshot 2025-09-23 at 4.57.11 PM.png

  4. Select all scopes to add to your organization token and click generate

Step 2: Enter your token in the linking flow

  1. Enter the token you have just generated and click Submit

Step 2: Setting Up Demographic Field Mapping


Once you have authenticated with Deel, you will be prompted to map the demographic fields you would like to import into Culture Amp.

Note: Core demographic fields map automatically and should not be manually configured unless instructed by a Culture Amp specialist. Please note that once these fields are set up, they cannot be edited or deleted. If you need to make changes, reply with "ask a person" in a support conversation to speak with a specialist.

Core Demographics: Automatic Mapping

This table is intended for your technical Deel administrator. The following fields will sync automatically from Deel to Culture Amp.

Note: While the "Typical Deel UI Label" shows the common reference field in Deel, exact UI labels and underlying field names may vary by tenant and configuration.

Typical Deel UI Label

Primary Deel API Endpoint (Data Location)

Culture Amp Field (The Destination)

Work Email

/rest/v2/people

Email (Unique Identifier)

Worker ID

/rest/v2/people

Employee ID (Unique Identifier)

Full Name

/rest/v2/people

Name

First Name

/rest/v2/people

Preferred Name

Birth Date

/rest/v2/people

Date of Birth

Start Date

/rest/v2/people

Start Date

End Date

/rest/v2/people

End Date

Direct Manager (Work Email of referenced Manager)

/rest/v2/people

Manager Email (Hierarchy demographic)

Custom Demographics: Manual Mapping

If you track additional employee data in Deel that you want to use as demographics in Culture Amp, follow these steps to set up custom mapping.

Step 1. Map Fields

  • Now that the initial authentication is complete, on your Integrations page, click Map fields.

Step 2. Select the Data Model

  • Select the data model for your target field (e.g., Employee).

Step 3. Set Details for the Target Field

  • Set the details for the field you are targeting in Culture Amp (the demographic name, e.g., Location).


Step 4. Choose the Matching Field from Deel

  • Select the matching Deel field that contains the data.

Step 5. Save Mappings

  • You can Save mappings or click the + Field mapping icon to add more.

  • Alternatively, if you’re not ready to map fields yet, you can click Skip for now and return to mapping later.

Tip:Your HRIS may limit access to specific custom fields. If you cannot find a required demographic field during mapping, you may need to:

  • Map an alternate custom field that contains similar data.

  • Manage the demographic outside of Deel directly in Culture Amp via manual imports or SFTP.

Excluding Employees

To exclude specific employees, you must first specify them in your Deel system (e.g., by creating a custom field or using an existing one) and set the value of this field to "Yes" for the employees you want to exclude.

Step 1. Start Mapping

  • Click on Map fields to begin the workflow.

Step 2. Select the Exclusion Field

  • You will see a field mapping for Exclude from Culture Amp in the workflow.

  • Search for the corresponding field from your HRIS under the Exclude from Culture Amp field.

  • Ensure that employees you want to exclude are marked as "Yes" in your HRIS.

Step 3. Save Mappings

  • Click Save mappings


Step 3: Activate Integration


After mapping your fields, click Sync, and the system will run an initial sync to connect your Deel 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 Deel 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.

Note: 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.

Set Up 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.

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

Troubleshooting/FAQs


If the fixes below don't resolve your issue, please remember that the high potential for customization in Deel means complex mapping or sync problems often require a specialist. Please reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist.

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.

Deel: Integration-Specific Errors

Issue

Cause

Suggested Fix

Missing Data/403 Permission Errors

The Deel Organisation Token lacks the required permissions to read specific data objects.

Ensure the admin has ticked the contracts checkbox for their API access token in line with Merge’s doc. Specifically this step

Terminated Employees Still Showing as "Active"

The employee was removed from the Deel sync report or deactivated without a populated End Date.

Immediate Fix: Re-add the user to the Deel report with a valid End Date and sync again.

Secondary Fix: If they cannot be re-added to the report, reach out to our Culture Amp Support team (via "Ask a Person") to request a manual sync to process the deactivation.

Need to Edit/Delete Mappings

Mappings are locked in the Culture Amp platform once set up. Adding or editing custom mappings often requires a full back-end sync to be triggered by our Culture Amp support team for the changes to be reflected in the platform.

Contact Culture Amp Support:

  • Reply with "Ask a Person" in a Support Conversation to speak with a Product Support Specialist.

  • Please be ready to provide the values of the fields you'd like to map, edit or delete.

  • The change must be made by a specialist, and a full system re-sync may be required to reflect the change.

"Failed" Status for Groups

Missing "Contracts" scope in token.

Fix: Regenerate your Organization Token in Deel and ensure all scopes (including contracts) are selected before updating the credentials in Culture Amp.

Cannot Map Gender or Level

Deel API restrictions.

Alternative: These fields are currently blocked by Deel's API. Manage these demographics via a manual CSV upload if they are required for reporting.

Missing Employee IDs

Known issue with the SCIM /Users endpoint mapping.

Contact Support: This is a core field and cannot be mapped manually. Please reply with "Ask a Person" in a Support Conversation to have a specialist adjust your backend mapping to pull the worker_id from the People endpoint.

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 uses two fields as unique identifiers for user profiles: Email and Employee ID.

  • As long as at least one of these remains consistent between Deel and Culture Amp, the sync will successfully update the existing profile rather than creating a new one.

  • Duplicate Risk: If you change both the Email and the Employee ID simultaneously in Deel, the sync will not find a match and will create a duplicate profile.

If you see a duplicate profile error flag during your import, take the following steps:

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 Deel.

  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 Deel. This keeps the history on the existing employee record.

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?