Who this guide is for: System administrators – Requires ‘System Admin’ role, Users permission and Superuser access for role-type changes
Overview:
This guide explains how to provision an API Client account in e-days—used for programmatic access via the RESTful Edays API.
How Edays API Works:
The e-days API exposes CRUD operations:
- GET: Retrieve data (200 OK/404 Not Found)
- POST: Create data (201 Created/400 Bad Request)
- PUT: Update data (201 Created/400 Bad Request)
- DELETE: Remove data (204 No Content/400 Bad Request)
An API Client account with full visibility (all User Views set to Everyone) and API Client role type is required for authentication and access.
How to Set Up Edays API Access:
- Create the API user account:
- Go to Admin tools > Users > User overview.
- Click + Add new.
- Confirm licence availability under Licensing information.
- Complete Personal details, System information (set Role to Standard Administrator), and groups. Click Next.
- Fill Entitlement and Authorisers (placeholder values OK), then click Save User.
- Important: Do not modify existing live users—use a new account.
- Grant universal visibility:
- In Users, search for the API user and click Edit.
- Select the System tab.
- Set Admin User View, Staff Records User View, Calendar User View, and Reporting User View each to Everyone.
- Click Save User.
- Change account type to API Client:
- Still in the API user’s record, select the Roles tab.
- Under Account Type, expand the default (e.g. User Account) and choose API Client.
- Click Save User.
- Upon saving, generate the Client ID and Secret via the UI prompts.
- Test API login:
- Use the Client ID/Secret to authenticate and perform a simple GET request (e.g. list users) against the e-days API endpoint per our developer docs at https://developer.e-days.com/.
Additional Information:
- API Client: A service account for integrations—never assign human users this role.
- Superuser access is required to change Account Type to API Client.
- Standard Administrator role is needed for initial user creation.
- Tip: Use the search function to quickly locate Users or Roles.
- Warning: Changing an existing user to an API Client will revoke their normal access.
- Use the search function within the platform to quickly find features or settings.