The filtering feature enables your customers to specify which employees they wish to share, based on criteria such as work location, employment type, departments, and many more. By providing a user-friendly configuration interface, the feature ensures that only in-scope employee data is persisted.

Filtering UI to share with customers so they can share which employees they want to share with you

1

Enable the feature

The filtering feature is currently in BETA. To enable it, please contact our support team. They will activate it for you and provide the necessary documentation to get started.

2

Let your customer set up the filters

Once the feature is enabled, you can allow your customers to set up the desired filters. There are two ways to do this:

  • Create a connection flow link with filtering enabled either via the API or in the dashboard, and share it with new customers. We will display the filtering step in the connection flow once the connection has been successfully set up.

  • Create a filter update link either via the api or in the dashboard and share it with existing customers. They will be able to create or update the filters.

Once the filters are set, you will be able to view them in the dashboard. View active filters in the dashboard

3

Use the data

Finally, use the data by querying our API. Our employees, absences, and employments endpoints will return only the data that belongs to the employees matching the configured filters. We will still return all groups, legal entities, work locations, and teams, even if no employee belongs to them. We persist the data as described here.

We recommend setting up webhooks and reacting to finished syncs to get the filtered data back to your system.

Create and read absencesData deletion