The Workleap API enables you to automate various Workleap user/group management and provisioning actions through our API. The Workleap API developer portal makes it easy to create payloads and send requests.
Caution: Do you have workflows that use our legacy API endpoints? See how to update them for our current API here.
Endpoint types
User provisioning
User provisioning endpoints let you set up recurring organization-wide syncs between Workleap and your HRIS. Choose between a JSON or CSV-based connection to securely sync your user data through HTTPS.
Tip: We strongly recommend a user provisioning integration to ensure your Workleap user data stays up to date with your HRIS.
User management
User management endpoints enable you to perform one-time user management actions, such as user creation, activation, updates, and deletion, via our API. You can add these endpoints to your organization's user management workflows.
Group/team management
Group/team management endpoints enable you to perform one-off group/team management actions, such as creation, activation, updates, and deletion, via our API. You can add these endpoints to your organization's group management workflows.
Communication language
Communication language sets the language used for product communications, such as surveys in Workleap Officevibe.
It can be managed through:
User profile and Personal profile.
Bulk provisioning.
Workleap API.
This setting is separate from App language, which controls the platform interface.
Defaults to App language if not set.
Accepts two-letter codes (e.g.,
EN,FR,ES).Supported: French, English, Spanish, German, Portuguese, Italian, Dutch, and Korean.
Unsupported values fall back to App language, with a sync log warning.
Workleap API FAQ
Why use the Workleap API to manage users/groups?
Many organizations use APIs to create automated workflows between numerous tools and platforms (such as their HRIS). The Workleap API enables you to integrate Workleap into various workflows.
Are Workleap API user/group management endpoints compatible with the other tools in my workflows?
The Workleap API user/group management data model is based on the SCIM (System for Cross-domain Identity Management) standard.
Note: The Workleap API is currently not SCIM compliant.
I use the Workleap API, but I'm not sure where to start
Determine if your organization has a designated team or individual responsible for API integrations and share these articles with them. You may also want to review our developer portal navigation article. If you still have trouble, click the widget in the corner of your screen for personalized assistance.