Overview

The following step-by-step guide will walk you through all user synchronization options in Connecteam via our REST API.

Upon completion of this guide, you will be able to interact with the Connecteam platform as follows:

• Create new users in Connecteam
• Get all user data from Connecteam
• Update existing user details (including custom fields)
• Archive users
• Unarchive users

👍

Good to know

The current limitation on batch actions for the users API is 25 users per request.

🚧

Important Note

Permanent deletion of users via the API is currently not available.

Furthermore, we recommend archiving users rather than deleting them. If you need to delete users from Connecteam, this action can only be performed through the platform interface.

What can you achieve with users sync

• By setting integration with users in Connecteam, you can automate the synchronization of user data across HR, payroll, IAM, and CRM systems, ensuring that employee and contact information is consistently updated, secure, and compliant with data protection regulations.

Common users data transformation processes

• Creating a new user in a third-party system automatically creates a new user in Connecteam and vice versa
• Updating an existing user in a third-party system updates the relevant details of the user in Connecteam
• Retrieving user data from Connecteam to create or update user details in third-party systems
• Deleting or removing users from a third-party system results in archiving the users in Connecteam
• Unarchiving or restoring users in Connecteam leads to restoring the users in third-party systems

Important Considerations

Data Validation: Ensure that the data being provided for updates is valid. This includes proper formatting for phone numbers, email addresses and ensuring that user types and permissions are correctly indicated.

Batch Updates: If you have multiple users, consider whether batching your requests will improve efficiency. Check the API guidelines concerning bulk requests if your use case requires it.

Testing: Before conducting requests on live data, it is advisable to test these operations in a sandbox environment to avoid unintended consequences.

For detailed information and examples, please refer to the following pages which walk you through each method comprehensively.