Google Workspace Directory Integration Guide

Modified on 2026-04-12 11:02:21 +0200 by Jesper Frier.

Short answer:
Connect Xink to your Google Workspace Directory to automatically import user data using Google’s API. You can control what data is imported and apply filters to target specific users.

Google Workspace Directory integration is managed under Preferences > Integration > Google Workspace Directory.

Xink integrates using the Google API.
Access is read-only.
No access to infrastructure details or passwords.
You control the connection and data scope.
Only selected employee data (e.g. name, title, phone) is stored.

Link your Google account

Enable Google Workspace Directory integration, then click Link Google Account and sign in with an admin account that has at least Users, Groups, and OU read permissions.

Review the requested permissions and click Allow.

Click Check Google connectivity to verify the connection, then click Save.

Directory sync runs approximately once per hour. You can trigger it manually from Dashboard > Schedule Update.

Filter users during import

You can filter which users are imported using Google Directory query strings. Enter the query exactly as documented here:

Google Directory API – Search Users

Server-side filter examples

1. Users with a specific name:

name='John'

2. Users in a specific country:

addressCountry='United Kingdom'

3. Users with a specific email domain:

email:*@company.com

4. Users in a specific organisation:

orgName=Engineering

5. Users with a specific manager:

directManager='JohnDoe@xink.io'

6. Active users with a specific domain:

IsSuspended=false

$.mail != null && $.mail.indexOf('@company.com') > -1

7. Users in a specific organisational unit:

orgUnitPath=='/Denmark'

Or a sub-OU:

orgUnitPath=='/Denmark/Users/Standard'

Note: Use quotes if the OU contains spaces, for example: orgUnitPath='/United Kingdom'

Client-side filter

Use client-side filters for more advanced logic not supported by the Google API. These use JavaScript syntax and can be combined with server-side filters.

Learn more about JavaScript syntax and operators.

Examples

1. Users with a specific email domain:

$.mail != null && $.mail.indexOf('@xink.io') > -1

2. Users with a last name:

$.sn != null && $.sn.length > 0

3. Multiple domains:

$.mail != null && ($.mail.indexOf('@domain1.com') > -1 || $.mail.indexOf('@domain2.com') > -1)

4. Users with job titles:

$.title != null && $.title.length > 0

5. Users from specific departments:

$.department == "Marketing" || $.department == "Support Team"

6. Users from a specific company:

$.company == "Company Name"

7. Exclude specific OUs and departments:

IsSuspended=false

$.orgUnitPath != null && $.orgUnitPath.indexOf('/Denmark') == -1 && $.department != "External"

8. Users in a Google Group:

$.groupCnList != null && $.groupCnList.indexOf('"Google Group Name"') != -1

Multiple groups

$.groupCnList != null && $.groupCnList.indexOf('"Group 1"') != -1 || $.groupCnList != null && $.groupCnList.indexOf('"Group 2"') != -1

Note: Connectivity checks do not reflect how many users match client-side filters.