Skip to main content
All CollectionsAccount Admin HubIntegrations & APIMerge API
Excluding specific employees from data imports via the Merge API
Excluding specific employees from data imports via the Merge API

Guidance for excluding specific employees from data imports via the Merge API

Jessie Walsh avatar
Written by Jessie Walsh
Updated over a week ago

Who can use this feature?

Available on:

  • All Culture Amp subscriptions.

This feature is available for the following integrations:

Steps to exclude employees


If you want to exclude specific employees when importing your employee data via the Merge API, you'll need to specify those employees in your HRIS system. You can do this by creating a custom field or using an existing field in your HRIS. Set the value of this field to "Yes" for the employees you want to exclude. During the sync process, any employees marked with "Yes" will not be imported into Culture Amp once you've completed the field mapping.

When setting up your HRIS integration in your Culture Amp account, you'll have the option to create field mappings. If you choose to skip this step initially, you can come back and complete it later.

  1. Click on Map fields.

2. By default, you will see a field mapping for Exclude from Culture Amp in the workflow. To exclude certain employees based on a demographic attribute, 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.

3. Click Save mappings.

Additional steps for UKG Ready customers


If you're using UKG Ready, there are a few extra steps required to ensure the exclusion field works correctly:

  1. Create a Custom Field in UKG Ready

    • In the HR Custom Fields section of UKG Ready, create a new field titled "Exclude from Culture Amp" with Yes/No values.

    • Mark employees you wish to exclude with "Yes" in this field.

  2. Contact Culture Amp Support

    • Once the field is created, reach out to Culture Amp’s Product Support Team by replying with "Ask a Person" in a support conversation to speak with a Specialist.

    • Let them know you need assistance with:

      • Basic Field Mapping: Mapping the Exclude from Culture Amp field to hr_custom_fields in the Merge Dashboard.

      • Advanced Mapping: Configuring JMESPath in the Merge Dashboard to select the correct object from the array (e.g., [0]."value" to identify "Yes" values).

  3. Complete the Sync

    • After these steps are completed by the Culture Amp Support team, the exclusion values will be properly recognized during the sync.

Additional steps for UKG Pro customers


If you're using UKG Pro, the exclusion field must be constructed in a specific manner for mapping and functionality.

There are two ways in UKG Pro to set up custom fields:

  • User-defined fields

    • Business Rules > Business Rules > User-defined fields

  • Platform Configuration Fields

    • Platform Configuration > Platform Configuration > Create a field

Our integration only supports User-defined fields

  1. Create a Custom Field in User-defined fields in UKG Pro

    • In User-defined fields

      • Business Rules > Business Rules > User-defined fields, create a new field titled "Exclude from Culture Amp" with Yes/No values.

    • Mark employees you wish to exclude with "Yes" in this field.

  2. Contact Culture Amp Support

    • Once the field is created, reach out to Culture Amp’s Product Support Team by replying with "Ask a Person" in a support conversation to speak with a Specialist.

    • Let them know you need assistance with:

      • Basic Field Mapping: Mapping the Exclude from Culture Amp field between Merge and UKG Pro

  3. Complete the Sync

    • After these steps are completed by the Culture Amp Support team, the exclusion values will be properly recognized during the sync.


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

Did this answer your question?