Time Tracking Settings

Retrieve the time tracking settings

Return the time tracking configuration of your company: the overtime computation basis (weekly/daily) and thresholds, the rounding tolerance and the forgotten-clock-in reminder settings. If your company has not configured it yet, the defaults are returned with id: null — the first update materialises the row.

get/companies/{company}/time-tracking-settings

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/time-tracking-settings
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Headers

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Example response

{
  "data": {
    "id": "01933a23-c060-7a71-8b82-5e6f7a8b9c02",
    "object": "time_tracking_settings",
    "overtime_basis": "weekly",
    "overtime_weekly_threshold_minutes": 2400,
    "overtime_tolerance_minutes": 15,
    "clock_in_reminder_enabled": true,
    "clock_in_reminder_grace_minutes": 30
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.