Workstream Public APIs allow seamless integration with your company’s data, enabling efficient communication between different software systems.
These APIs use OAuth 2.0 for secure access, ensuring that only authorized users can retrieve or manage data. Super Admins have exclusive permissions to add integrations and generate access tokens, which are required for authentication.
📌 Each access token is valid for seven (7) days, after which a new token must be created or refreshed to maintain connectivity. This setup ensures controlled and secure API usage while facilitating streamlined data management within Workstream.
⚠️ Things to remember:
Only Super Admins have permission to add and manage integrations in Workstream. If you need access, please contact your admin for assistance.
Located in Admin view > Integrations > Access Token, you can generate your access tokens here.
Create an access token
On Admin View, go to Company Settings → Integrations.
On the left panel, choose Access Token. Click the Create access token button. A Create token pop-up appears.
In the Create token pop-up:
(Required) Enter a Token name. The name can't be changed after the token is created, and it must be unique.
(Required) Under What data access does this token have?, choose the data this token can access:
Positions
Company users
Company roles
Applicants
Employees
Team members
Locations
Departments
Imported employee infos
Custom Fields
Once done, click Create.
The Access token created dialog shows your token. Click Copy token and save it somewhere secure. You can't view it again unless you refresh the token or create a new one. The token expires in 7 days. Click Close when you're done.
Check a token's status
The access token list shows each token's Status, either Active or Expired, and an Expires value for active tokens. To include expired tokens in the list, select Show expired tokens.
Refresh an access token
On Admin View, go to Company Settings → Integrations.
On the left panel, choose Access Token.
Click on the three-dot menu (•••) beside the token/s you wish to refresh then click Refresh Token.
A confirmation titled Refresh [token name]? asks you to confirm the token refresh. Click Refresh.
Note: Any applications or scripts using the token you're refreshing will be impacted. If the token has already expired, it refreshes right away without a confirmation.After refreshing, the Access token refreshed dialog appears with your token. Copy the token by clicking on the Copy token button and save this token somewhere secure.
Edit an access token
On Admin View, go to Company Settings → Integrations.
On the left panel, choose Access Token.
Click on the three-dot menu (•••) beside the token/s you wish to edit then click Edit. An Edit token pop-up appears.
Choose the data access you want to add or remove for the token. The Token name can't be changed. Once done, click Save.
Delete an access token
On Admin View, go to Company Settings → Integrations.
On the left panel, choose Access Token.
Click on the three-dot menu (•••) beside the token/s you wish to delete then click Delete. A pop-up titled Delete [token name]? asks you to confirm. Any applications or scripts using the token will be impacted.
If your decision is final, click Delete.