Supported Features
Employee Master Integration
Account Deletion
Account Creation
About the SmartHR Integration
There are two ways to integrate with SmartHR: via OAuth or via API key.
For new integrations, we recommend using OAuth as it is simpler to set up.
[Important] Please check your permissions following the SmartHR specification changeWith OAuth integration, employee information can only be retrieved within the scope of the permission group of the SmartHR account used to log in at the time of integration.A SmartHR update scheduled for around August 2026 will let you manage permission settings for employee information separately for “yourself” and “others (other employees)”.As a result, please confirm that the fields Admina retrieves (name, email address, custom fields, and so on) are set to viewable for both “yourself” and “others”.How to check: In SmartHR, go to Settings > Permission Settings and check the settings of the permission group that the integration account belongs to.Note: If either one is set to not viewable, no error appears, but the affected fields stop syncing.
Prerequisites
How to Log In to SmartHR
Go to the SmartHR login page and enter your email address and password to log in.
OAuth Integration (Recommended)
To integrate via OAuth, access SmartHR Plus from the link below and authorize the connection with SmartHR.
SaaS Management: SmartHR Plus
-
Click Get Started.
-
Log in to SmartHR with an administrator account. Once logged in, the prerequisites are complete — proceed to the Integration Setup section below.
API Key Integration
To integrate via API key, confirm the following items.
How to Obtain Your Workspace Key
After logging in to SmartHR, part of the URL is your workspace key. Copy and save it.
https://{workspace-key}.smarthr.jp/ (do not include https://)
How to Obtain Your Access Key
The access token is your access key. Refer to SmartHR’s documentation to issue an access token.
How to Issue an Access Token
- The following permissions are required: read access for employee information (/crews) and accounts (/users).
- If retrieving email addresses from custom employee fields at the time of integration, read permission for the added custom employee field items is also required.
Integration Setup
-
In the integrations screen, search for SmartHR.
-
You can connect via [OAuth] or [API].
a. OAuth Integration (Recommended): Click the OAuth tab and click Connect. Configure the following options as needed.
b. API Key Integration: Select the [API] tab, enter the values for each field below, and click Connect.
-
Once the integration with SmartHR is successful, the registered user information will appear in the account list. If the integration does not complete successfully. Click Edit from the Status tab on the integrations screen and try again. If the issue persists, please contact us via chat.
Data Retrieved via SmartHR Integration
For details on the fields synced from SmartHR, please refer to SmartHR Plus.
