Tikklok REST API v1

Uptime probe. No authentication.

Response 200

{
  "success": true,
  "status": "ok",
  "version": "v1",
  "time": "2026-08-08T14:23:00Z"
}

Confirms your credentials work and shows which company they map to.

Response 200

{
  "success": true,
  "company_id": 1,
  "company_name": "Acme Corp",
  "key_id": "TK_PUB_LIVE_A1B2C3D4E5F60718",
  "key_name": "My Slack integration"
}

Paginated roster of your company's people (company_users), each with a lean list of the locations they're actively assigned to. Owners/admins appear too, with an empty locations array if they have no assignments.

Query parameters

Response 200

{
  "success": true,
  "total": 25,
  "limit": 100,
  "offset": 0,
  "data": [
    {
      "company_user_id": 42,
      "first_name": "Jane",
      "last_name": "Doe",
      "is_active": true,
      "locations": [
        { "location_user_id": 15, "location_id": 7, "location_name": "Main Store" }
      ]
    }
  ]
}

Full detail for one employee plus every location assignment (active and historical — each carries its own is_active). Each assignment includes its location_user_id (the per-assignment key, used for API clock events). 404 not_found if the employee isn't in your company.

Response 200

{
  "success": true,
  "data": {
    "company_user_id": 42,
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane@example.com",
    "tel": "+32 470 00 00 00",
    "role": "employee",
    "status": "active",
    "is_active": true,
    "created": "2025-01-15 10:30:00",
    "updated": "2025-08-27 14:22:15",
    "locations": [
      {
        "location_user_id": 15,
        "location_id": 7,
        "location_name": "Main Store",
        "role": "staff",
        "function_id": 3,
        "function_name": "Sales",
        "is_user_primary": true,
        "clocking_allowed": true,
        "valid_from": null,
        "valid_to": null,
        "is_active": true
      }
    ]
  }
}

One employee's assignment at one location. 404 not_found if the employee isn't in your company, the location isn't in your company, or there's no assignment linking the two.

Response 200

{
  "success": true,
  "data": {
    "company_user_id": 42,
    "location_user_id": 15,
    "location_id": 7,
    "location_name": "Main Store",
    "role": "staff",
    "function_id": 3,
    "function_name": "Sales",
    "is_user_primary": true,
    "clocking_allowed": true,
    "valid_from": null,
    "valid_to": null,
    "is_active": true,
    "created": "2025-01-15 10:30:00",
    "updated": "2025-08-27 14:22:15"
  }
}

The same performance data as the dashboard's downloadable report, as JSON, grouped by location. For each location the employee is (or was) assigned to, a per-day breakdown plus summed totals. All figures are hours (2 decimals); overtime_hours can be negative (undertime).

expected_hours = planned − closed − location_holiday − user_holiday − sick · overtime_hours = worked − expected

Query parameters (both required)

Bad/missing date or min_date > max_date → 400 invalid_date. A span over 366 days → 400 range_too_large. 404 not_found if the employee isn't in your company. An employee with no data in range returns 200 with an empty locations array.

Response 200

{
  "success": true,
  "data": {
    "company_user_id": 42,
    "employee_name": "Jane Doe",
    "period": { "min_date": "2025-01-01", "max_date": "2025-01-31" },
    "locations": [
      {
        "location_id": 7,
        "location_name": "Main Store",
        "days": [
          {
            "date": "2025-01-06",
            "planned_hours": 8,
            "worked_hours": 7.75,
            "closed_hours": 0,
            "location_holiday_hours": 0,
            "user_holiday_hours": 0,
            "sick_hours": 0,
            "expected_hours": 8,
            "overtime_hours": -0.25
          }
        ],
        "totals": {
          "planned_hours": 40, "worked_hours": 39, "closed_hours": 0,
          "location_holiday_hours": 0, "user_holiday_hours": 0, "sick_hours": 0,
          "expected_hours": 40, "overtime_hours": -1
        }
      }
    ]
  }
}

Your company's locations. qr_base64 is intentionally omitted (large, and clocking is handled app-side).

Query parameters

Response 200

{
  "success": true,
  "data": [
    {
      "location_id": 7,
      "name": "Main Store",
      "street": "Rue de la Paix",
      "house_nr": "42",
      "postal_code": "1000",
      "city": "Brussels",
      "country": "BE",
      "timezone": "Europe/Brussels",
      "is_company_primary": true,
      "latitude": 50.8503,
      "longitude": 4.3517,
      "geo_radius_meters": 100,
      "is_active": true,
      "created": "2024-06-01 09:00:00",
      "updated": "2025-08-27 14:22:15"
    }
  ]
}

One location, same object shape as the list. 404 not_found if it isn't in your company.

The active people working at one location — each active assignment (location_users row) joined with the person's name. Only rows where the assignment, its company_user, and the user are all active are returned. 404 not_found if the location isn't in your company; an in-company location with no active staff returns 200 with an empty data.

Response 200

{
  "success": true,
  "location_id": 7,
  "data": [
    {
      "location_user_id": 15,
      "first_name": "Jane",
      "last_name": "Doe",
      "role": "staff",
      "function_id": 3,
      "function_name": "Sales"
    }
  ]
}

Current clock status for one employee at one location, resolved from their most recent clock event there. clocked_in is true when the latest event is an IN, false when it's an OUT or the employee has never clocked there. 404 not_found if the employee or location isn't in your company, or the employee has no assignment at that location. The last_event_* fields are null if they've never clocked at that location.

Response 200

{
  "success": true,
  "data": {
    "company_user_id": 42,
    "location_id": 7,
    "location_user_id": 15,
    "clocked_in": true,
    "last_event_type": "IN",
    "last_event_time_utc": "2026-09-03 08:00:00",
    "last_event_time_local": "2026-09-03 10:00:00"
  }
}

Clock status for multiple employees at one location in a single call — built for an admin overview. Each row is one employee's current status, resolved from their latest clock event at that location. 404 not_found if the location isn't in your company; a location with no matching staff returns 200 with an empty data.

Query parameters

Response 200

{
  "success": true,
  "location_id": 7,
  "data": [
    {
      "company_user_id": 42,
      "location_user_id": 15,
      "clocked_in": true,
      "last_event_type": "IN",
      "last_event_time_utc": "2026-09-03 08:00:00",
      "last_event_time_local": "2026-09-03 10:00:00"
    }
  ]
}