Skip to main content

How to Use the REST API for Employee Provisioning

Updated

You can provision employees from your source system to actimo using our REST API. This will enable you to handle three core jobs as to create, update and delete employees in Actimo.

 

API Call limits/requests:

There is a limit of 20 API requests/calls per API Key, per second.

 

 

API Key: Have an Admin on your platform contact your integration specialist.

 

 

Understanding the API

  • An employee in actimo is referred to as a Contact. Each of these will get their own ID (id) which you can use to update or make changes.

  • You can see all API calls in our UI via the develop tab. If you get an Admin login to the platform from the owner, you can copy/paste calls and payload by doing the actions in the UI.

  • Actimo does not have a sandbox environment. We recommend doing the calls in the production platform on targeting 1-2 test contacts or reaching out to your Customer Success Manager if in need of a test platform.

  • Actimo's API is in JSON format.

  • Actimo comes with default fields such as "first name" and "last name". Secondly it is also possible to create custom fields if needed. Bear in mind that where default fields will have logical names after the data they carry, custom fields will be called data1, data2 etc. You can see these names using the developer tab in the UI.

Creating contacts

In order to create a contact in actimo you will need the following call.

 

 

Add payload to the body with necessary data you wish to add to that contact.

 

 

Delete contacts

In order to delete a contact in actimo you will need the following call.

 

 

In this example we are deleting three contacts at once marked as the parameters highlighted in bold.

 

 

Updating contacts

In order to update a contact in actimo you will need the following call.

 

 

Add payload to the body with necessary data you wish to update on the contacts.

 

 

Add-on: Creating a manager-to-employee relationship

If you wish to create a relationship between manager and employee contacts, you will need to do the following call. Keep in mind that you will need to use the contact id of both manager and employee.

 

PUT: https://app.actimo.com/api/v1/contacts/8562183/relationships

 

 

Questions?

 

Questions in regards to the API can be added to one of our integration specialist. If you are being onboarded to Actimo you will already have contact directly with a specialist.

 

Please also let us know if this was helpful by clicking the emoji's below or sending some feedback via support@actimo.com.

Related articles