Setting permissions for the API user

• Modified on: Wed, 16 Sep, 2020 at 9:18 AM

Access to your data via the API is regulated by a set of permissions. Usually third party applications will use the Celery API to access your data and you want to give only access to data that the third party application really needs.

A time tracking tool for example does not need access to compensation information or documents generated by Celery. For that kind of application access to "normal" employer en employee data is more than enough.

You will need to enable the Celery API integration and set API permissions on at least one user to enable access to your data via the API. Follow these steps:

1. Enable the Celery API Integration for the employer(s) you want to access using the API
   1. In Celery, go to Employer => Integrations => General integrations.
      
   2. Click on the Celery API integration.
   3. Set Enabled to Yes and save the integration.
      
2. Choose either an Account User or a Company User to set the API permissions.
3. Edit the user and scroll to the API Authorisation section.
   
4. Choose the desired permissions and save the user.