Skip to content
  • There are no suggestions because the search field is empty.

How to Use the Timecloud Public API

The Timecloud Public API lets you connect external systems — payroll tools, HRIS platforms, scheduling engines, or custom dashboards — directly to your Timecloud data. Use it to automate employee management, roster scheduling, attendance tracking, and more.

Getting Started

  • Company admins can create and manage API keys directly from the Timecloud web app (see Managing Your API Keys below).
  • You will also need a designated API user - an admin employee whose credentials the integration uses to authenticate. Mark them in their employee profile (see Designating an API User below).
  • All API communication happens over HTTPS.

Authentication

  1. Call the /oauth/token endpoint with your API user's Client ID and Client Secret (provided by your Timecloud account manager).
  2. You'll receive a Bearer token.
  3. Include this token in the Authorization header of all subsequent requests:
    Authorization: Bearer <your-token>
  4. Include your API key in the X-Timecloud-Integrator-Key header:
    X-Timecloud-Integrator-Key: <your-api-key>

Managing Your API Keys

Company admins can create, view, and revoke API keys directly from the web app.

Where to find it

  • Go to Settings > API Integration.

Screenshot 2026-09-18 at 2.57.19 PM

Creating a key

  1. Click Create New Key.
  2. A dialog displays the new key. Copy it immediately - the key is shown only once and cannot be retrieved later.
    1. Store the key securely (e.g. in a secrets manager or password vault).

Screenshot 2026-09-18 at 3.00.23 PM

Viewing your keys

  • The API keys table shows every key with its Created date and Status (Active or Revoked).

Screenshot 2026-09-18 at 3.02.55 PM

Revoking a key

  1. Click Revoke next to the key you want to disable.
  2. Confirm in the dialog. This cannot be undone - any integration using the revoked key will stop working immediately.

Screenshot 2026-09-18 at 3.02.46 PM

Tip: You can have up to 100 active keys at a time. If you need a new key, revoke an unused one first.

Designating an API User

Each API integration authenticates as a specific admin employee. To mark an employee as an API user:

  1. Go to Employees and open the employee's profile.
  2. Navigate to the User Access tab.
  3. Ensure Admin Access is enabled, then toggle API User on.

Screenshot 2026-09-18 at 3.05.27 PM

Important: Turning off the API User toggle removes the integration's ability to authenticate as that employee. A confirmation dialog warns you before saving.

Controlling access to API Integration settings

  • Company admins have access by default.
  • Sub-admins need the API Integration Screen permission enabled in Feature Access (under System Administration & Security).

Screenshot 2026-09-18 at 3.06.41 PM

Date & Time Format

  • Request date fields: YYYY-MM-DD (e.g. 2024-01-15)
  • Response date-time fields: ISO 8601 UTC (e.g. 2024-01-15T09:30:00.000Z)
  • All times are returned in UTC.

Need Help?

Reach out to your Timecloud account manager or contact support@jointimecloud.com for API access, troubleshooting, or integration guidance.