Referenz der öffentlichen API

Mit der öffentlichen API von Workify360 Focus können Ihre eigenen Skripte und Tools Berichte und Zeitdaten lesen und Änderungen nach denselben Regeln wie im Dashboard vornehmen. Die öffentliche API, API-Schlüssel und Webhooks sind Teil des Premium-Tarifs.

Die Operationen auf dieser Seite bleiben abwärtskompatibel. Das maschinenlesbare OpenAPI-Dokument derselben Operationen:

https://api.focus.workify360.com/v1/openapi/public.json

Erzeugt aus Version 0.1.0 des API-Vertrags (c95fb97bb49a).

Authentifizierung

Senden Sie bei jeder Anfrage einen persönlichen API-Schlüssel im Header Authorization. Ein Schlüssel gehört der Person, die ihn erstellt hat, handelt als diese Person und darf nie mehr, als ihre aktuelle Rolle erlaubt. Eine Anfrage mit fehlendem, falschem, abgelaufenem oder widerrufenem Schlüssel erhält 401 mit dem Code unauthorized.

curl https://api.focus.workify360.com/v1/me \
  -H "Authorization: Bearer w360_pat_…"

So erstellen Sie Schlüssel, legen ihre Scopes fest und widerrufen sie: API-Schlüssel und die öffentliche API

Scopes

Jede Operation benötigt einen Scope, der neben ihr angezeigt wird. Ein Schlüssel darf eine Operation aufrufen, wenn er diesen Scope besitzt und die aktuelle Rolle, die Teams und der Tarif seines Inhabers die Anfrage zulassen – genau wie im Dashboard.

Scope	Was er erlaubt
`me`	Ihr eigenes Profil und Ihr Timer
`reports:read`	Lesen von Berichten, Zeiteinträgen, Abwesenheiten, Schichten, Teams, Projekten, Aufgaben und Exporten
`time:write`	Hinzufügen und Ändern von Zeiteinträgen, Abwesenheiten, Schichten, Aufgaben und der Zeit, die Aufgaben zugewiesen ist, sowie Entscheiden über Anträge
`org:admin`	Verwalten von Mitgliedern, Teams, Einladungen und Projekten
`webhooks:manage`	Verwalten von Webhook-Endpunkten

Rate-Limits

Jeder Schlüssel darf 600 Einheiten pro Minute senden, eine Organisation 1.800 für alle ihre Schlüssel zusammen. Eine Anfrage, die etwas ändert (alles außer GET und HEAD), zählt als zwei Einheiten, jede andere als eine. Ein Schlüssel kann außerdem höchstens 60 Einheiten auf einmal senden; aufgefüllt wird mit 10 pro Sekunde. Mehr als 60 Lesezugriffe (oder 30 Änderungen) in kurzer Folge werden daher mit 429 beantwortet, auch wenn 600 pro Minute nicht erreicht sind.

Header	Bedeutung
`RateLimit: "key";r=598;t=2`	Bei jeder gezählten Antwort: die verbleibenden Einheiten des Schlüssels und die Sekunden, bis sie wieder voll sind
`RateLimit-Policy: "key";q=600;w=60, "tenant";q=1800;w=60`	Bei jeder gezählten Antwort: die Limits pro Minute für den Schlüssel und für die Organisation
`Retry-After: 12`	Bei 429 (Code `rate_limited`): die Sekunden, die vor der nächsten Anfrage zu warten sind

Fehler

Ein Fehler ist ein Problem-Dokument nach RFC 9457 (Content-Type: application/problem+json). code ist ein stabiler Code in snake_case, gegen den Sie programmieren können; title ist ein englischer Text für Logs. type ist die Hilfe-Adresse des Codes, https://workify360.com/help/errors/<code>/, wobei jedes _ als - geschrieben wird; sie öffnet den Hilfeartikel, der den Code erklärt, sofern es einen gibt.

HTTP/1.1 403 Forbidden
Content-Type: application/problem+json

{
  "type": "https://workify360.com/help/errors/forbidden/",
  "title": "Forbidden",
  "status": 403,
  "code": "forbidden",
  "action": "webhooks.manage",
  "traceId": "4bf92f3577b34da6a3ce929d0e0e4736"
}

Manche Probleme enthalten weitere Felder: errors (die Feldfehler bei 422 validation_failed), action (die Berechtigung, auf die sich ein 403 forbidden bezieht), requiredPlan (402 feature_not_in_plan), retryAfterSeconds (429 und 503) und traceId (geben Sie sie an, wenn Sie den Support kontaktieren).

Status	Code	Wann
400	`invalid_request`	Ein Parameter ist fehlerhaft oder fehlt
401	`unauthorized`	Der Schlüssel fehlt, ist falsch, abgelaufen oder widerrufen, oder sein Inhaber hat die Organisation verlassen
402	`feature_not_in_plan`, `subscription_read_only`	Der Tarif enthält die Funktion nicht, oder das Abonnement ist schreibgeschützt
403	`forbidden`, `feature_not_enabled`	Dem Schlüssel fehlt der Scope, oder die aktuelle Rolle, die Teams oder die Einstellungen seines Inhabers lassen die Anfrage nicht zu
412	`version_conflict`	Die Version in `If-Match` ist nicht mehr aktuell; lesen Sie die Ressource erneut
422	`validation_failed`	Der Body ist ungültig; `errors` listet die Felder auf
428	`precondition_required`	Die Operation benötigt einen `If-Match`-Header mit der Version, die Sie gelesen haben
429	`rate_limited`	Zu viele Anfragen; warten Sie die Sekunden aus `Retry-After` ab

Codes mit Hilfeartikel sind in der Liste der Operationen verlinkt.

Webhooks

Statt die API immer wieder abzufragen, kann ein eigener Endpunkt eine signierte HTTPS-Anfrage erhalten, wenn sich etwas ändert. Die Ereignisse, das Anfrageformat, die Prüfung der Signatur in Node.js und Python, Wiederholungsversuche und die Rotation des Secrets erklärt der Hilfeartikel: Webhooks

Operationen

Nach Bereich gruppiert. Die Zusammenfassungen und Feldbeschreibungen stammen aus dem API-Vertrag.

Abwesenheiten

GET `/v1/absences` Scope: `reports:read`

List absences overlapping a range.

Parameter

Name	In	Typ	Beschreibung
`from`	Query	string (date)
`to`	Query	string (date)	At most 366 days after `from`.
`userId`	Query	string (uuid)
`teamId`	Query	string (uuid)
`status`	Query	string
`typeId`	Query	string (uuid)
`cursor`	Query	string
`limit`	Query	integer (int32)

Antworten

200 AbsencePage

Fehler

400 invalid_request, range_too_long
402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)

POST `/v1/absences` Scope: `time:write`

Request (or record) an absence.

Parameter

Name	In	Typ	Beschreibung
`Idempotency-Key`erforderlich	Header	string	Required: the same key and body return the first answer

Request-Body

AbsenceRequest

Antworten

201 AbsenceDto

Fehler

400 invalid_absence_unit, invalid_absence_range, invalid_half, unit_not_allowed, range_too_far
402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)
404 absence_type_not_found
409 overlaps_absence, insufficient_balance, absence_type_inactive

POST `/v1/absences/{id}/decision` Scope: `time:write`

Approve or reject an absence (the G1 endpoint of the calendar).

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Id
`If-Match`erforderlich	Header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Request-Body

CalendarDecisionRequest

Antworten

200 AbsenceDto

Fehler

402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)
404 absence_not_found
409 absence_not_pending, insufficient_balance
412 version_conflict
428 precondition_required (no If-Match)

Aktivität

GET `/v1/activity/day` Scope: `reports:read`

One user's local day (My Focus, the timeline): totals, productivity, attendance, day plan, slots, apps, time entries.

Parameter

Name	In	Typ	Beschreibung
`date`	Query	string (date)	The user's local day (required).
`userId`	Query	string (uuid)	Default: the caller; another user must be visible (else 403).

Antworten

200 ActivityDayDto

Fehler

400 invalid_request (malformed or missing parameter)
402 feature_not_in_plan
403 forbidden (action = the permission; a user outside the scope)

Zeitzuweisungen

GET `/v1/allocations` Scope: `reports:read`

A person's allocations of a range of local days (the caller's, the people they manage, and the time on the projects they manage).

Parameter

Name	In	Typ	Beschreibung
`userId`	Query	string (uuid)	Default: the caller.
`from`	Query	string (date)	Local date, included.
`to`	Query	string (date)	Local date, included; at most 93 days after `from`.
`projectId`	Query	string (uuid)
`cursor`	Query	string
`limit`	Query	integer (int32)	1–200 (default 200).

Antworten

200 AllocationPage

Fehler

400 invalid_request (malformed parameter), range_too_long
402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission; a person outside the scope)

POST `/v1/allocations` Scope: `time:write`

Put time on a project: entered (manual) or tracked time assigned afterwards (assignment); for another person with allocations.write.

Parameter

Name	In	Typ	Beschreibung
`Idempotency-Key`	Header	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Request-Body

AllocationCreateRequest

Antworten

201 AllocationCreatedDto

Fehler

400 range_in_future, range_too_old
402 feature_not_in_plan, subscription_read_only
403 forbidden, project_not_trackable
404 project_not_found, task_not_found, member_not_found
409 allocation_overlaps, allocation_billed, project_not_active
422 validation_failed, allocation_too_long, task_not_in_project

Exporte

POST `/v1/exports` Scope: `reports:read`

Request an export: the file is produced by a worker job with the requester's current role.

Parameter

Name	In	Typ	Beschreibung
`Idempotency-Key`erforderlich	Header	string	Required: the same key and body return the first answer

Request-Body

CreateExportRequest

Antworten

202 ExportJobDto

Fehler

400 invalid_dataset, range_too_long, too_many_columns_for_pdf
402 feature_not_in_plan
403 forbidden (action = the permission; a user or team outside the scope; includeCosts without the right to see amounts)
404 template_not_found
409 export_not_available
422 validation_failed
429 too_many_exports
503 export_storage_unavailable

GET `/v1/exports/{id}` Scope: `reports:read`

One export job (poll every 2 s).

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Id

Antworten

200 ExportJobDto

Fehler

402 feature_not_in_plan
403 forbidden (action = the permission; a user or team outside the scope)
404 export_not_found

Eigenes Profil

GET `/v1/me` Scope: `me`

The signed-in person, their membership, organization, rights and session.

Antworten

200 MeDto

Fehler

401 unauthorized

Mitglieder

POST `/v1/invitations` Scope: `org:admin`

Invite a person.

Parameter

Name	In	Typ	Beschreibung
`Idempotency-Key`erforderlich	Header	string	Required: 1–255 printable ASCII characters

Request-Body

CreateInvitation

Antworten

201 InvitationResult

Fehler

409 already_member
422 validation_failed, idempotency_key_reused

GET `/v1/members` Scope: `org:admin`

List members.

Parameter

Name	In	Typ	Beschreibung
`status`	Query	string	Comma-separated statuses (default active,invited,suspended)
`teamId`	Query	string (uuid)	Primary team
`role`	Query	string	owner, admin, team_admin, manager or employee
`q`	Query	string	Part of the name or e-mail (Turkish case folding)
`cursor`	Query	string	Opaque cursor of the next page
`limit`	Query	integer (int32)	1–200, default 50

Antworten

200 MemberPage

Fehler

403 No right

GET `/v1/members/{id}` Scope: `org:admin`

One member.

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Membership id

Antworten

200 MemberDto

Fehler

404 member_not_found

PATCH `/v1/members/{id}` Scope: `org:admin`

Change a member's role, team, viewer teams, zone or tracking.

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Membership id
`If-Match`erforderlich	Header	string	ETag of the member ("v<n>")

Request-Body

PatchMember

Antworten

200 MemberDto

Fehler

400 self_change_forbidden, owner_immutable, role_not_assignable, team_required, viewer_teams_not_allowed
412 version_conflict
428 precondition_required

POST `/v1/members/{id}/reactivate` Scope: `org:admin`

Reactivate a suspended member.

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Membership id

Antworten: 200 MemberDto

POST `/v1/members/{id}/suspend` Scope: `org:admin`

Suspend a member: the membership is suspended and every session of it in this organization ends.

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Membership id

Antworten

200 MemberDto

Fehler

409 conflict (an invitation is revoked instead)

Projekte

GET `/v1/projects` Scope: `reports:read`

The projects the caller sees (Owners and Admins: all; others: open ones, their teams and, read only, the projects of the people they manage).

Parameter

Name	In	Typ	Beschreibung
`status`	Query	string	`active`, `on_hold` or `completed`.
`clientId`	Query	string (uuid)
`q`	Query	string	Name or code search (case-insensitive).
`includeArchived`	Query	boolean
`mine`	Query	boolean	Only the projects the caller may track time on.
`cursor`	Query	string
`limit`	Query	integer (int32)	1–200 (default 50).

Antworten

200 ProjectPage

Fehler

400 invalid_request (malformed parameter)
402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)

POST `/v1/projects` Scope: `org:admin`

Add a project (Owners and Admins).

Parameter

Name	In	Typ	Beschreibung
`Idempotency-Key`	Header	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Request-Body

ProjectRequest

Antworten

201 ProjectDto

Fehler

402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)
404 client_not_found
409 project_name_taken, project_code_taken
422 validation_failed (errors[] = field codes)

GET `/v1/projects/{id}` Scope: `reports:read`

One project (invisible projects are 404).

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Project id

Antworten

200 ProjectDto

Fehler

402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)
404 project_not_found

PUT `/v1/projects/{id}` Scope: `org:admin`

Change a project (Owners and Admins; the whole body).

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Project id
`If-Match`erforderlich	Header	string	The ETag the caller read (412 version_conflict when it changed)

Request-Body

ProjectRequest

Antworten

200 ProjectDto

Fehler

402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)
404 project_not_found, client_not_found
409 project_name_taken, project_code_taken, project_currency_locked
412 version_conflict
422 validation_failed (errors[] = field codes)
428 precondition_required (If-Match)

Berichte

GET `/v1/reports/productivity` Scope: `reports:read`

Productivity by day, week, month or range for the company, a team or a user.

Parameter

Name	In	Typ	Beschreibung
`from`	Query	string (date)
`to`	Query	string (date)	`day` 93 days, `week`, `month` and `range` 366.
`groupBy`	Query	string	`day`, `week`, `month` or `range`.
`teamId`	Query	string (uuid)
`userId`	Query	string (uuid)

Antworten

200 PeriodReportDto

Fehler

400 invalid_request (malformed parameter), invalid_group_by, range_too_long
402 feature_not_in_plan
403 forbidden (action = the permission; a user or team outside the scope)

GET `/v1/reports/projects` Scope: `reports:read`

Allocated time, billable time and the rate-layered amounts (Owners and Admins) of projects in a range, grouped by one or two of project, task, user, client and day, with the projects' budget use.

Parameter

Name	In	Typ	Beschreibung
`from`	Query	string (date)	Local date, included.
`to`	Query	string (date)	Local date, included; at most 366 days after `from`.
`groupBy`	Query	string	One or two of `project` (default), `task`, `user`, `client`, `day`, comma separated.
`projectIds`	Query	string	Comma-separated project ids.
`clientId`	Query	string (uuid)
`userIds`	Query	string	Comma-separated user ids (visible people only).
`teamId`	Query	string (uuid)
`billable`	Query	string	`all` (default), `billable` or `nonBillable`.
`includeProductive`	Query	boolean	Also compute the productive time within the allocations (costly; default false).

Antworten

200 ProjectReportDto

Fehler

400 invalid_request (malformed parameter), invalid_group_by, range_too_long
402 feature_not_in_plan
403 forbidden (action = the permission; a user or team outside the scope)

GET `/v1/reports/summary` Scope: `reports:read`

The summary of the visible users over a range.

Parameter

Name	In	Typ	Beschreibung
`from`	Query	string (date)
`to`	Query	string (date)	At most 93 days after `from`.
`teamId`	Query	string (uuid)	Only the team's current members; the team must be visible (else 403).

Antworten

200 SummaryDto

Fehler

400 invalid_request (malformed parameter), range_too_long
402 feature_not_in_plan
403 forbidden (action = the permission; a team outside the scope)

GET `/v1/reports/targets` Scope: `reports:read`

The apps, domains or hosts of the visible users over a range (Apps & URLs).

Parameter

Name	In	Typ	Beschreibung
`from`	Query	string (date)
`to`	Query	string (date)
`type`	Query	string	`app`, `domain` or `host`.
`teamId`	Query	string (uuid)
`userId`	Query	string (uuid)
`q`	Query	string	Search in the key and the name (.NET `search`).
`level`	Query	string	`productive`, `unproductive` or `neutral`.
`categoryKey`	Query	string
`unclassified`	Query	boolean	Only targets without a category.
`cursor`	Query	string
`limit`	Query	integer (int32)	1–200, default 50.

Antworten

200 TargetListDto

Fehler

400 invalid_request (malformed parameter or cursor), invalid_level, range_too_long
402 feature_not_in_plan
403 forbidden (action = the permission; a user or team outside the scope)

GET `/v1/reports/users/{userId}/daily` Scope: `reports:read`

A user's days of a range (computed days and the workdays without activity).

Parameter

Name	In	Typ	Beschreibung
`userId`erforderlich	Pfad	string (uuid)	User
`from`	Query	string (date)
`to`	Query	string (date)	At most 93 days after `from`.

Antworten

200 UserDailyDto

Fehler

400 invalid_request (malformed parameter), range_too_long
402 feature_not_in_plan
403 forbidden (action = the permission; a user outside the scope)

Schichten

GET `/v1/shifts` Scope: `reports:read`

List the shifts starting in a range.

Parameter

Name	In	Typ	Beschreibung
`from`	Query	string (date)
`to`	Query	string (date)
`teamId`	Query	string (uuid)
`userId`	Query	string (uuid)
`includeOpen`	Query	boolean	Also open shifts (default true).

Antworten

200 ShiftListDto

Fehler

400 invalid_request (malformed parameter)
402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)

POST `/v1/shifts` Scope: `time:write`

Create a shift (assigned or open).

Parameter

Name	In	Typ	Beschreibung
`Idempotency-Key`erforderlich	Header	string	Required: the same key and body return the first answer

Request-Body

ShiftBody

Antworten

201 ShiftDto

Fehler

400 invalid_shift_time, invalid_break, open_shift_requires_team, …
402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)
409 overlaps_shift, shift_in_past

Aufgaben

GET `/v1/projects/{id}/tasks` Scope: `reports:read`

A visible project's tasks, by sort order.

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Project id
`status`	Query	string	`open`, `in_progress` or `done`.
`assigneeUserId`	Query	string (uuid)
`includeArchived`	Query	boolean
`cursor`	Query	string
`limit`	Query	integer (int32)	1–500 (default 200).

Antworten

200 TaskPage

Fehler

400 invalid_request (malformed parameter)
402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)
404 project_not_found

POST `/v1/projects/{id}/tasks` Scope: `time:write`

Add a task (an Admin or the project's manager).

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Project id
`Idempotency-Key`	Header	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Request-Body

TaskRequest

Antworten

201 TaskDto

Fehler

402 feature_not_in_plan, subscription_read_only
403 forbidden, project_not_trackable (the assignee)
404 project_not_found
409 task_name_taken
422 validation_failed (errors[] = field codes)

GET `/v1/tasks/{id}` Scope: `reports:read`

One task of a visible project.

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Task id

Antworten

200 TaskDto

Fehler

402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)
404 task_not_found

PUT `/v1/tasks/{id}` Scope: `time:write`

Change a task (the whole body).

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Task id
`If-Match`erforderlich	Header	string	The ETag the caller read (412 version_conflict when it changed)

Request-Body

TaskRequest

Antworten

200 TaskDto

Fehler

402 feature_not_in_plan, subscription_read_only
403 forbidden, project_not_trackable (the assignee)
404 task_not_found
409 task_name_taken
412 version_conflict
422 validation_failed (errors[] = field codes)
428 precondition_required (If-Match)

Teams

GET `/v1/teams` Scope: `reports:read`

List teams.

Parameter

Name	In	Typ	Beschreibung
`includeArchived`	Query	boolean	Also archived teams (default false)
`cursor`	Query	string	Opaque cursor of the next page
`limit`	Query	integer (int32)	1–200, default 50

Antworten: 200 TeamPage

POST `/v1/teams` Scope: `org:admin`

Create a team (the G1 endpoint).

Request-Body

CreateTeam

Antworten

201 TeamDto

Fehler

403 forbidden (action teams.create)
409 team_name_taken

PATCH `/v1/teams/{id}` Scope: `org:admin`

Rename a team or change its description.

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Team id
`If-Match`erforderlich	Header	string	ETag of the team

Request-Body

PatchTeam

Antworten

200 TeamDto

Fehler

409 team_name_taken

Zeiteinträge

GET `/v1/time-entries` Scope: `reports:read`

List a user's time entries of a range (by start).

Parameter

Name	In	Typ	Beschreibung
`userId`	Query	string (uuid)	Default: the caller.
`from`	Query	string (date)	The entry's local day, required.
`to`	Query	string (date)	At most 93 days after `from`.
`kind`	Query	string	`offline` or `deletion`.
`status`	Query	string	`pending`, `approved` or `rejected`.
`cursor`	Query	string
`limit`	Query	integer (int32)	1–500.

Antworten

200 TimeEntryPage

Fehler

400 invalid_request, range_too_long, invalid_kind
402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)

POST `/v1/time-entries` Scope: `time:write`

Add offline time or a deletion (for oneself, or for a user one manages: TimeEntryPolicy in the handler).

Parameter

Name	In	Typ	Beschreibung
`Idempotency-Key`erforderlich	Header	string	Required: the same key and body return the first answer

Request-Body

CreateTimeEntryRequest

Antworten

201 TimeEntryDto

Fehler

400 invalid_time_range, range_not_in_one_day, range_in_future, range_too_old, invalid_description, invalid_level, invalid_kind, project_not_supported
402 feature_not_in_plan, subscription_read_only
403 forbidden, offline_time_disabled, time_editing_disabled
404 user_not_found
409 overlaps_entry

GET `/v1/time-entries/{id}` Scope: `reports:read`

One time entry (invisible, missing and other tenants' entries are all 404).

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Entry id

Antworten

200 TimeEntryDto

Fehler

402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)
404 entry_not_found

PUT `/v1/time-entries/{id}` Scope: `time:write`

Replace an entry's editable fields.

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Entry id
`If-Match`erforderlich	Header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Request-Body

UpdateTimeEntryRequest

Antworten

200 TimeEntryDto

Fehler

400 invalid_time_range, range_not_in_one_day, range_in_future, range_too_old, invalid_description, invalid_level, invalid_kind, project_not_supported
402 feature_not_in_plan, subscription_read_only
403 forbidden, offline_time_disabled, time_editing_disabled
404 entry_not_found
409 overlaps_entry
412 version_conflict
428 precondition_required (no If-Match)

DELETE `/v1/time-entries/{id}` Scope: `time:write`

Delete an entry (deleting a deletion restores the tracked time).

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Entry id
`If-Match`erforderlich	Header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Antworten

204 (kein Body)

Fehler

402 feature_not_in_plan, subscription_read_only
403 forbidden, offline_time_disabled, time_editing_disabled
404 entry_not_found
412 version_conflict
428 precondition_required (no If-Match)

POST `/v1/time-entries/{id}/decision` Scope: `time:write`

Approve or reject a pending offline entry (the G1 endpoint of the time module).

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	Entry id
`If-Match`erforderlich	Header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Request-Body

TimeEntryDecisionRequest

Antworten

200 TimeEntryDto

Fehler

400 invalid_request
402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)
404 entry_not_found
409 entry_not_pending
412 version_conflict
428 precondition_required (no If-Match)

Timer

GET `/v1/me/timer` Scope: `me`

The caller's timer (a segment due after 24 hours is stopped first).

Parameter

Name	In	Typ	Beschreibung
`If-None-Match`	Header	string \| null	The ETag the caller holds (304 when unchanged)

Antworten

200 TimerDto · 304 (kein Body)

Fehler

402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)

POST `/v1/me/timer/start` Scope: `me`

Start the timer, or switch the running one to another project or task, at at (the client's clock).

Parameter

Name	In	Typ	Beschreibung
`Idempotency-Key`	Header	string \| null	The client's command id; a retry returns the first answer

Request-Body

TimerStartRequest

Antworten

200 TimerCommandResultDto

Fehler

POST `/v1/me/timer/stop` Scope: `me`

Stop the running timer at at; its segment becomes allocations.

Parameter

Name	In	Typ	Beschreibung
`Idempotency-Key`	Header	string \| null	The client's command id; a retry returns the first answer

Request-Body

TimerAtRequest

Antworten

200 TimerCommandResultDto

Fehler

400 range_in_future
402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)
409 allocation_overlaps
422 timer_command_too_old

Webhooks

GET `/v1/webhook-endpoints` Scope: `webhooks:manage`

The tenant's webhook endpoints.

Parameter

Name	In	Typ	Beschreibung
`cursor`	Query	string
`limit`	Query	integer (int32)	1–200, default 50.

Antworten

200 WebhookEndpointPage

Fehler

402 feature_not_in_plan, subscription_read_only
403 forbidden (action = webhooks.manage), feature_not_enabled

POST `/v1/webhook-endpoints` Scope: `webhooks:manage`

Add a webhook endpoint (its signing secret is in this answer only; no Idempotency-Key: the answer holds a secret).

Request-Body

CreateWebhookEndpointRequest

Antworten

201 CreatedWebhookEndpointDto

Fehler

402 feature_not_in_plan, subscription_read_only
403 forbidden (action = webhooks.manage), feature_not_enabled
409 webhook_limit_reached
422 validation_failed, webhook_url_invalid, webhook_url_not_allowed, webhook_event_unknown

GET `/v1/webhook-endpoints/{id}` Scope: `webhooks:manage`

One webhook endpoint.

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	The endpoint

Antworten

200 WebhookEndpointDto

Fehler

403 forbidden (action = webhooks.manage), feature_not_enabled
404 webhook_endpoint_not_found

PATCH `/v1/webhook-endpoints/{id}` Scope: `webhooks:manage`

Change an endpoint: URL, description, events, pause or resume (active also opens a disabled endpoint), take it over.

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	The endpoint
`If-Match`erforderlich	Header	string	The endpoint's ETag (`"v<n>"`)

Request-Body

UpdateWebhookEndpointRequest

Antworten

200 WebhookEndpointDto

Fehler

403 forbidden (action = webhooks.manage), feature_not_enabled
404 webhook_endpoint_not_found
412 version_conflict
422 validation_failed, webhook_url_invalid, webhook_url_not_allowed, webhook_event_unknown
428 precondition_required

DELETE `/v1/webhook-endpoints/{id}` Scope: `webhooks:manage`

Delete an endpoint and its deliveries.

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	The endpoint

Antworten

204 (kein Body)

Fehler

403 forbidden (action = webhooks.manage), feature_not_enabled
404 webhook_endpoint_not_found

GET `/v1/webhook-endpoints/{id}/deliveries` Scope: `webhooks:manage`

The deliveries of an endpoint, newest first.

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	The endpoint
`status`	Query	string	`pending`, `succeeded`, `failed`, `dead`.
`eventType`	Query	string
`cursor`	Query	string	Opaque cursor of the next page.
`limit`	Query	integer (int32)	1–200, default 50.

Antworten

200 WebhookDeliveryPage

Fehler

403 forbidden (action = webhooks.manage), feature_not_enabled
404 webhook_endpoint_not_found

GET `/v1/webhook-endpoints/{id}/deliveries/{deliveryId}` Scope: `webhooks:manage`

One delivery with the body that was sent.

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	The endpoint
`deliveryId`erforderlich	Pfad	string	The delivery (a 64-bit integer)

Antworten

200 WebhookDeliveryDetailDto

Fehler

403 forbidden (action = webhooks.manage), feature_not_enabled
404 webhook_endpoint_not_found, webhook_delivery_not_found

POST `/v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retry` Scope: `webhooks:manage`

Queue a failed or dead delivery again (attempts start over).

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	The endpoint
`deliveryId`erforderlich	Pfad	string	The delivery (a 64-bit integer)

Antworten

202 AcceptedDto

Fehler

403 forbidden (action = webhooks.manage), feature_not_enabled
404 webhook_endpoint_not_found, webhook_delivery_not_found

POST `/v1/webhook-endpoints/{id}/rotate-secret` Scope: `webhooks:manage`

A new signing secret (the previous one still signs for 24 hours).

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	The endpoint

Antworten

200 RotatedWebhookSecretDto

Fehler

403 forbidden (action = webhooks.manage), feature_not_enabled
404 webhook_endpoint_not_found

POST `/v1/webhook-endpoints/{id}/test` Scope: `webhooks:manage`

Send the webhook.test event (also to a paused endpoint).

Parameter

Name	In	Typ	Beschreibung
`id`erforderlich	Pfad	string (uuid)	The endpoint

Antworten

202 WebhookTestDto

Fehler

403 forbidden (action = webhooks.manage), feature_not_enabled
404 webhook_endpoint_not_found
409 connection_paused (a disabled endpoint)

GET `/v1/webhook-events` Scope: `webhooks:manage`

The webhook event catalog and whether the tenant's plan has each event.

Antworten

200 WebhookEventsDto

Fehler

402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission), feature_not_enabled

Schemas

Die Request- und Response-Bodys, die die Operationen verwenden. Pflichtfelder sind gekennzeichnet.

AbsenceDto

An absence.

Feld	Typ	Beschreibung
`createdAt`erforderlich	string (date-time)
`createdBy`erforderlich	CalendarUserRefDto
`days`erforderlich	number (double)	Σ `deductionByYear`; for types that do not deduct, the planned workdays (information only).
`decidedAt`	string (date-time) \| null
`decidedBy`	CalendarUserRefDto \| null
`decisionNote`	string \| null
`deductionByYear`erforderlich	object	The balance deduction per year, e.g. `{"2026": 3.5}`; empty for types that do not deduct.
`end`erforderlich	string (date-time)
`endDate`erforderlich	string (date)
`endTime`	string \| null
`half`	string \| null
`id`erforderlich	string (uuid)
`note`	string \| null
`permissions`erforderlich	AbsencePermissionsDto
`start`erforderlich	string (date-time)	UTC coverage start.
`startDate`erforderlich	string (date)
`startTime`	string \| null
`status`erforderlich	string
`timeZone`erforderlich	string
`type`erforderlich	AbsenceTypeRefDto
`unit`erforderlich	string
`updatedAt`erforderlich	string (date-time)
`user`erforderlich	CalendarPersonDto
`userId`erforderlich	string (uuid)

AbsencePage

GET /v1/absences.

Feld	Typ	Beschreibung
`items`erforderlich	AbsenceDto[]
`nextCursor`	string \| null

AbsencePermissionsDto

Feld	Typ	Beschreibung
`canApprove`erforderlich	boolean
`canCancel`erforderlich	boolean
`canEdit`erforderlich	boolean

AbsenceRequest

POST /v1/absences, PUT /v1/absences/{id} (the user never changes).

Feld	Typ	Beschreibung
`endDate`	string (date) \| null
`endTime`	string \| null
`half`	string \| null	`am` or `pm` for a half day.
`note`	string \| null
`startDate`	string (date) \| null
`startTime`	string \| null	Local `HH:mm` for `hours`.
`typeId`	string (uuid) \| null
`unit`	string \| null	`days`, `half_day` or `hours`.
`userId`	string (uuid) \| null	`null` = the caller.

AbsenceTypeRefDto

The absence's type as the absence shows it; name translated for a built-in type that was not renamed.

Feld	Typ	Beschreibung
`color`erforderlich	string
`countsAsWorked`erforderlich	boolean
`deductsFromBalance`erforderlich	boolean
`id`erforderlich	string (uuid)
`key`	string \| null
`name`erforderlich	string
`paid`erforderlich	boolean
`timeEffect`erforderlich	string

AcceptedDto

202 Accepted of a queued job.

Feld	Typ	Beschreibung
`accepted`erforderlich	boolean	Always `true`.

AccessDto

What the person may see and manage (FAZ1 AccessDto; focus_contracts::access::policy).

Feld	Typ	Beschreibung
`assignableRoles`erforderlich	string[]
`canManageCompanySettings`erforderlich	boolean
`canManageTeams`erforderlich	boolean
`canManageUsers`erforderlich	boolean
`manageTeamIds`erforderlich	string[]
`scope`erforderlich	string	`company`, `teams` or `self`.
`unassignedFallback`erforderlich	boolean
`viewTeamIds`erforderlich	string[]

ActivityDayDto

One user's local day. A day without activity is a 200 with zero totals, null arrival/leave and empty lists.

Feld	Typ	Beschreibung
`absenceCreditMs`erforderlich	integer (int64)	A `worked` absence tops the worked time up to the expected work.
`activeMs`erforderlich	integer (int64)	Window time ∩ not AFK (computer time only).
`afkCoverage`erforderlich	boolean	False when no device reported AFK data (idle unknown).
`apps`erforderlich	AppUsageDto[]	Daily totals, largest first.
`arrivalAt`	string (date-time) \| null
`atWorkMs`erforderlich	integer (int64)
`attendance`	DayAttendanceDto \| null
`categories`erforderlich	CategoryUsageDto[]	Active time per category (`null` key = uncategorized); offline time is in no category.
`classified`erforderlich	boolean	False for a day written before the Phase 2 classification (all neutral).
`date`erforderlich	string (date)
`dayEnd`erforderlich	string (date-time)
`dayStart`erforderlich	string (date-time)	The day's window: local midnight, or the end of the previous day's night shift window.
`deletedMs`erforderlich	integer (int64)	Tracked time removed by approved deletions (part of idle).
`domains`erforderlich	DomainUsageDto[]
`hosts`erforderlich	HostUsageDto[]	Hosts with a URL, at most 50, largest first.
`idleMs`erforderlich	integer (int64)
`leftAt`	string (date-time) \| null
`meetingMs`erforderlich	integer (int64)	Active time the meeting apps exception turned from idle into active.
`offlineMs`erforderlich	integer (int64)	Approved offline time outside the tracked active time.
`pendingOfflineMs`erforderlich	integer (int64)	Pending offline entries of the day (information only).
`plan`	DayPlanDto \| null
`privateIntervals`erforderlich	TimeIntervalDto[]	Private intervals of the day, merged and clipped, without detail.
`privateMs`erforderlich	integer (int64)	Private time outside active and offline time.
`productivity`erforderlich	DayProductivityDto
`recomputing`erforderlich	boolean	The day waits in the recompute queue (the UI refetches every 15 s).
`slots`erforderlich	ActivitySlotDto[]	One entry per 5-minute UTC slot with activity, by time.
`teamId`	string (uuid) \| null	The user's current primary team (its rules classify the day).
`timeEntries`erforderlich	TimeEntryDto[]	Offline and deletion entries of every status overlapping the day's window, by start; the caller's permissions.
`timeZone`erforderlich	string	The zone the day was computed in; the UI draws slots at their wall-clock time in it.
`userId`erforderlich	string (uuid)
`workedMs`erforderlich	integer (int64)	`activeMs + offlineMs`: the denominator of `productivity.productivityPct`.

ActivitySlotDto

Time in one 5-minute slot; activeMs includes approved offline time (offlineMs).

Feld	Typ	Beschreibung
`activeMs`erforderlich	integer (int64)
`apps`erforderlich	AppUsageDto[]
`neutralMs`erforderlich	integer (int64)
`offlineMs`erforderlich	integer (int64)
`productiveMs`erforderlich	integer (int64)
`slotStart`erforderlich	string (date-time)
`unproductiveMs`erforderlich	integer (int64)

AffectedAllocationDto

An allocation replace changed.

Feld	Typ	Beschreibung
`change`erforderlich	string	`trimmed`, `split` or `deleted`.
`id`erforderlich	string (uuid)

AllocationCreateRequest

POST /v1/allocations (Idempotency-Key).

Feld	Typ	Beschreibung
`endedAt`	string (date-time) \| null	At most 24 hours after `startedAt`, at most 5 minutes in the future.
`isBillable`	boolean \| null
`note`	string \| null
`projectId`	string (uuid) \| null
`replace`	boolean \| null	Trim, split or delete the person's (unbilled) allocations it overlaps; otherwise an overlap is 409 `allocation_overlaps`.
`source`	string \| null	`manual` or `assignment` (`timer` only through the timer).
`startedAt`	string (date-time) \| null
`taskId`	string (uuid) \| null
`userId`	string (uuid) \| null	`null` = the caller; another person needs `allocations.write` and to be managed by the caller.

AllocationCreatedDto

POST /v1/allocations → 201.

Feld	Typ	Beschreibung
`affected`erforderlich	AffectedAllocationDto[]
`allocation`erforderlich	AllocationDto

AllocationDto

Time on a project.

Feld	Typ	Beschreibung
`createdAt`erforderlich	string (date-time)
`createdBy`erforderlich	NamedRefDto
`durationMs`erforderlich	integer (int64)
`effectiveBillable`erforderlich	boolean
`endedAt`erforderlich	string (date-time)
`id`erforderlich	string (uuid)
`invoiceId`	string (uuid) \| null	Set once the time is on an invoice.
`isBillable`	boolean \| null	`null` takes the task's, then the project's value.
`localDate`erforderlich	string (date)	The start's day in the person's zone (rates, reports).
`note`	string \| null
`permissions`erforderlich	AllocationPermissionsDto
`project`erforderlich	ProjectRefDto
`source`erforderlich	string	`timer`, `manual` or `assignment`.
`startedAt`erforderlich	string (date-time)
`task`	NamedRefDto \| null
`timeZone`erforderlich	string
`updatedAt`erforderlich	string (date-time)
`userId`erforderlich	string (uuid)
`version`erforderlich	integer (int64)	The row version: `If-Match: "v<version>"` of a change (the same value as the resource's `ETag`).

AllocationPage

GET /v1/allocations.

Feld	Typ	Beschreibung
`items`erforderlich	AllocationDto[]
`nextCursor`	string \| null

AllocationPermissionsDto

What the caller may do with an allocation (a billed one is locked).

Feld	Typ	Beschreibung
`delete`erforderlich	boolean
`edit`erforderlich	boolean

AppTotalDto

Feld	Typ	Beschreibung
`activeMs`erforderlich	integer (int64)
`appKey`erforderlich	string
`categoryKey`	string \| null
`level`	string \| null	Level in the response's `levelContext`.
`name`erforderlich	string
`percentage`erforderlich	number (double)	Share of the range's worked time (0–100, one decimal).

AppUsageDto

An app's time; offline rows use the reserved keys _offline_<level> with name: "Offline time" and levelSource: "offline".

Feld	Typ	Beschreibung
`activeMs`erforderlich	integer (int64)
`appKey`erforderlich	string
`categoryKey`	string \| null
`level`	string \| null	The app's own rule (`productive`, `unproductive`, `neutral`).
`levelSource`	string \| null	`team`, `company`, `default` or `offline`.
`name`erforderlich	string

BudgetDto

A project's budget: hours (minutes) or an amount in the project's currency (amountMinor).

Feld	Typ	Beschreibung
`amountMinor`	integer (int64) \| null
`kind`	string \| null	`hours` or `amount`.
`minutes`	integer (int64) \| null

BudgetRequest

The budget of a project request (kind hours with minutes, or amount with amountMinor).

Feld	Typ	Beschreibung
`amountMinor`	integer (int64) \| null
`kind`	string \| null
`minutes`	integer (int64) \| null

CalendarDecisionRequest

{decision, note?} of the decision endpoints (approve or reject; the note at most 500 characters).

Feld	Typ	Beschreibung
`decision`	string \| null
`note`	string \| null

CalendarPersonDto

A user with the current team.

Feld	Typ	Beschreibung
`fullName`	string \| null
`id`erforderlich	string (uuid)
`teamId`	string (uuid) \| null
`teamName`	string \| null

CalendarUserRefDto

A user reference (names from the directory; null when unknown).

Feld	Typ	Beschreibung
`fullName`	string \| null
`id`erforderlich	string (uuid)

CapabilitiesDto

Subscription capabilities.

Feld	Typ	Beschreibung
`features`erforderlich	string[]
`readOnly`erforderlich	boolean

CategoryUsageDto

Feld	Typ	Beschreibung
`activeMs`erforderlich	integer (int64)
`categoryKey`	string \| null	`null` = uncategorized.

CreateExportRequest

POST /v1/exports: definition is the full definition the dialog shows; without it the saved template (templateId) or the built-in one (templateKey) gives it.

Feld	Typ	Beschreibung
`definition`	ExportDefinitionDto \| null
`from`	string (date) \| null
`locale`	string \| null	`tr` or `en`.
`templateId`	string (uuid) \| null
`templateKey`	string \| null
`to`	string (date) \| null

CreateInvitation

POST /v1/invitations.

Feld	Typ	Beschreibung
`email`erforderlich	string
`fullName`erforderlich	string
`locale`	string \| null	Language of the e-mail and the acceptance page (`tr`, `en`); the organization's default otherwise.
`role`erforderlich	string	`admin`, `team_admin`, `manager` or `employee`.
`teamId`	string (uuid) \| null
`timeZone`	string \| null
`viewerTeamIds`	string (uuid)[]

CreateTeam

POST /v1/teams.

Feld	Typ	Beschreibung
`description`	string \| null	At most 500 characters.
`name`erforderlich	string	1–100 characters, unique among active teams (Turkish case folding).

CreateTimeEntryRequest

POST /v1/time-entries (the .NET CreateTimeEntryRequest).

Feld	Typ	Beschreibung
`description`	string \| null	Offline: 1–500 characters; deletion: optional reason (at most 500).
`end`	string (date-time) \| null
`kind`	string \| null	`offline` or `deletion`.
`level`	string \| null	Offline only (default `productive`).
`projectId`	string (uuid) \| null	Must be `null` (400 `project_not_supported`).
`start`	string (date-time) \| null
`userId`	string (uuid) \| null	`null` = the caller; a manager may add time for a user it manages.

CreateWebhookEndpointRequest

POST /v1/webhook-endpoints.

Feld	Typ	Beschreibung
`description`	string \| null	≤ 200 characters.
`eventTypes`erforderlich	string[]	1–50 catalog event types of the tenant's plan.
`url`erforderlich	string	`https://…` (≤ 2048; no user info, no fragment; every resolved address public).

CreatedWebhookEndpointDto

CreatedWebhookEndpointDto: the endpoint and its signing secret, shown once.

Feld	Typ	Beschreibung
`endpoint`erforderlich	WebhookEndpointDto
`secret`erforderlich	string	`whsec_<base64>`: shown once, never again.

DailyHolidayDto

A holiday of a daily report day.

Feld	Typ	Beschreibung
`half`	string \| null
`key`erforderlich	string
`name`erforderlich	string	English name; `nameTr` is the Turkish one.
`nameTr`erforderlich	string

DayAbsenceDto

The dominant absence of a day (/v1/reports/users/{userId}/daily days[].absence).

Feld	Typ	Beschreibung
`color`erforderlich	string
`fraction`erforderlich	number (double)	The day's approved absence coverage (0–1).
`half`	string \| null
`typeKey`	string \| null
`typeName`	string \| null
`unit`erforderlich	string

DayAttendanceDto

Attendance of the day on the day plan.

Feld	Typ	Beschreibung
`expectedEnd`	string (date-time) \| null
`expectedStart`	string (date-time) \| null
`flexible`erforderlich	boolean
`lateByMs`erforderlich	integer (int64)
`lateToleranceMinutes`erforderlich	integer (int32)
`leftEarly`erforderlich	boolean
`leftEarlyByMs`erforderlich	integer (int64)
`status`erforderlich	string	`onTime`, `late`, `absent`, `notStarted`, `dayOff`, `onLeave`, `holiday`.
`targetMs`erforderlich	integer (int64)	The plan's target (the Effectiveness % denominator).
`workday`erforderlich	boolean

DayPlanDto

The day plan of one user's day.

Feld	Typ	Beschreibung
`absences`erforderlich	PlanAbsenceDto[]	Approved and pending absences covering the day (only approved ones change the numbers).
`expectedEnd`	string (date-time) \| null
`expectedStart`	string (date-time) \| null
`expectedWorkMs`erforderlich	integer (int64)	Overtime target (`base × (1 − fLeave)`).
`holiday`	HolidayRefDto \| null
`kind`erforderlich	string	`schedule`, `shift`, `dayOff` or `holiday`.
`leaveFraction`erforderlich	number (double)	The approved absence coverage `f` (0–1).
`shifts`erforderlich	PlanShiftDto[]	Shifts starting on the day, by start.
`targetMs`erforderlich	integer (int64)	Effectiveness % denominator (`base × (1 − f)`).
`workday`erforderlich	boolean

DayProductivityDto

A day's time by productivity level (productive + unproductive + neutral = workedMs).

Feld	Typ	Beschreibung
`effectivenessPct`	number (double) \| null	productive ÷ target × 100 (not capped); `null` without a target.
`neutralMs`erforderlich	integer (int64)
`productiveMs`erforderlich	integer (int64)
`productivityPct`	number (double) \| null	productive ÷ worked × 100, one decimal; `null` without worked time.
`targetMs`erforderlich	integer (int64)
`unproductiveMs`erforderlich	integer (int64)

DayTotalDto

One local day of a summary.

Feld	Typ	Beschreibung
`activeMs`erforderlich	integer (int64)
`activeUserCount`erforderlich	integer (int32)
`atWorkMs`erforderlich	integer (int64)
`date`erforderlich	string (date)
`idleMs`erforderlich	integer (int64)
`neutralMs`erforderlich	integer (int64)
`offlineMs`erforderlich	integer (int64)
`privateMs`erforderlich	integer (int64)
`productiveMs`erforderlich	integer (int64)
`productivityPct`	number (double) \| null
`unproductiveMs`erforderlich	integer (int64)

DomainTotalDto

Feld	Typ	Beschreibung
`activeMs`erforderlich	integer (int64)
`categoryKey`	string \| null
`domain`erforderlich	string
`level`	string \| null
`percentage`erforderlich	number (double)

DomainUsageDto

Feld	Typ	Beschreibung
`activeMs`erforderlich	integer (int64)
`categoryKey`	string \| null
`domain`erforderlich	string
`level`	string \| null
`levelSource`	string \| null

EmailVerificationDto

Where the person stands with the e-mail verification (owner decision 3 Oct 2026, focus_auth::email_gate).

Feld	Typ	Beschreibung
`dueAt`	string (date-time) \| null	The deadline of an unverified account (`Identity__EmailVerificationGraceHours` after its creation).
`state`erforderlich	string	`verified`, `not_required` (an account that never has to verify: invited, imported, SCIM, IdP-verified), `pending` (unverified, before `dueAt`) or `overdue` (after `dueAt`: every request but a few answers 403 `email_verification_required`).

ExportDefinitionDto

What an export contains (FAZ4 §6.1; focus_contracts::reports::export::ExportDefinition on the wire); a saved template stores it without the date range. Every field is optional so that the validator reports what is wrong (422 validation_failed with errors[{field, code}]).

Feld	Typ	Beschreibung
`columns`	string[] \| null	Column keys of the dataset in file order (1–40; a PDF at most 12).
`csvDialect`	string \| null	`standard` (default) or `excel-tr` (csv only).
`dataset`	string \| null
`durationFormat`	string \| null	`hms` (default), `hours` or `minutes`.
`filters`	ExportFiltersDto \| null
`format`	string \| null	`xlsx`, `csv` or `pdf`.
`groupBy`	string \| null	`day`, `week`, `month`, `range` or `none` (the dataset decides).
`options`	ExportOptionsDto \| null

ExportFiltersDto

Who is exported: a team, some users, or (neither) everyone the requester can see.

Feld	Typ	Beschreibung
`includeInactiveUsers`	boolean
`teamId`	string \| null
`userIds`	string \| null[] \| null

ExportJobDto

An export job as the panel lists and polls it.

Feld	Typ	Beschreibung
`createdAt`erforderlich	string (date-time)
`dataset`erforderlich	string
`errorCode`	string \| null	`too_many_rows`, `too_many_rows_for_pdf`, `access_lost`, `feature_not_in_plan`, `canceled`, `internal_error`.
`expiresAt`	string (date-time) \| null
`fileName`	string \| null
`fileSize`	integer (int64) \| null
`finishedAt`	string (date-time) \| null
`format`erforderlich	string
`from`erforderlich	string (date)
`groupBy`	string \| null
`id`erforderlich	string (uuid)
`locale`erforderlich	string
`progress`erforderlich	integer (int32)	0–100.
`rowCount`	integer (int32) \| null
`startedAt`	string (date-time) \| null
`status`erforderlich	string	`queued`, `running`, `succeeded`, `failed`, `canceled`, `expired`.
`templateId`	string (uuid) \| null
`templateKey`	string \| null
`templateName`	string \| null	The saved template's name, while it still exists.
`to`erforderlich	string (date)

ExportOptionsDto

Dataset options; each applies to one dataset and is ignored by the others.

Feld	Typ	Beschreibung
`include`	string \| null	`titles`: `titles`, `urls` or `both` (default).
`includeCosts`	boolean \| null	`projects` (Faz 6): fill the rate, amount and currency columns (needs `projects.costs.read`, else 403).
`includeOpen`	boolean \| null	`shifts`: also open shifts.
`splitByUser`	boolean \| null	`applications`: one row per user and target.
`statuses`	string \| null[] \| null	`offline_time` / `absence`: status filter (default `approved`).
`targetType`	string \| null	`applications`: `app` (default), `domain` or `host`.

FieldError

One field error of a 400/422 body.

Feld	Typ	Beschreibung
`code`erforderlich	string	Stable snake_case code (`required`, `too_long`, `invalid`, ...).
`field`erforderlich	string	JSON path of the field in camelCase (`name`, `items[2].start`), or the parameter/header name.
`message`	string \| null

HolidayRefDto

A holiday of a day (both names; name is the English one).

Feld	Typ	Beschreibung
`half`	string \| null
`key`erforderlich	string	Built-in key (`republic_day`, …) or `custom`.
`name`erforderlich	string
`nameEn`erforderlich	string
`nameTr`erforderlich	string
`source`	string \| null	`builtin` or `tenant`.

HostUsageDto

Feld	Typ	Beschreibung
`activeMs`erforderlich	integer (int64)
`domain`	string \| null
`host`erforderlich	string
`level`erforderlich	string
`levelSource`erforderlich	string
`matchedKey`	string \| null	Key of the matching domain rule; `null` for the default.

InvitationEmail

What happened to the invitation e-mail.

Feld	Typ	Beschreibung
`acceptUrl`	string \| null	The acceptance link, only when no e-mail is sent (`not_configured`, `suppressed_reserved`) and only in the fresh answer (share it by hand).
`status`erforderlich	string	`queued`; `not_configured` when no e-mail provider is set up; `suppressed_reserved` when the address is an RFC 2606 / RFC 6761 reserved name (`example.com`, `*.test`, …) that is never e-mailed. Clients treat `suppressed_reserved` like `not_configured`: nothing arrives, share `acceptUrl` by hand.

InvitationRef

{"id","expiresAt"} of a created or re-sent invitation.

Feld	Typ	Beschreibung
`expiresAt`erforderlich	string
`id`erforderlich	string (uuid)

InvitationResult

The answer of POST /v1/invitations and POST /v1/invitations/{id}/resend.

Feld	Typ	Beschreibung
`email`erforderlich	InvitationEmail
`invitation`erforderlich	InvitationRef
`member`erforderlich	MemberDto

LevelContextDto

Which rules the single level of an aggregate list follows (FAZ2 §5 "Listelerde hangi kural").

Feld	Typ	Beschreibung
`kind`erforderlich	string	`user` (a `userId` filter: that user's current team), `team` (a `teamId` filter) or `company`.
`teamId`	string (uuid) \| null

MeDto

GET /v1/me.

Feld	Typ	Beschreibung
`access`erforderlich	AccessDto
`capabilities`erforderlich	CapabilitiesDto
`effectiveTimeZone`erforderlich	string
`membership`erforderlich	MeMembership
`organization`erforderlich	MeOrganization
`organizations`erforderlich	OrganizationChoice[]
`session`	MeSession \| null
`user`erforderlich	MeUser

MeMembership

The membership in the current organization.

Feld	Typ	Beschreibung
`id`erforderlich	string (uuid)
`isTracked`erforderlich	boolean
`joinedAt`	string \| null
`role`erforderlich	string
`status`erforderlich	string
`teamId`	string (uuid) \| null
`teamName`	string \| null
`timeZone`	string \| null
`viewerTeamIds`erforderlich	string (uuid)[]

MeOrganization

The current organization.

Feld	Typ	Beschreibung
`defaultLocale`erforderlich	string
`id`erforderlich	string (uuid)
`name`erforderlich	string
`slug`erforderlich	string
`status`erforderlich	string
`timeZone`erforderlich	string

MeSession

The current session.

Feld	Typ	Beschreibung
`absoluteExpiresAt`erforderlich	string
`amr`erforderlich	string[]
`authTime`erforderlich	string
`clientId`erforderlich	string
`id`erforderlich	string (uuid)
`idleExpiresAt`erforderlich	string

MeUser

The person (GET /v1/me → user).

Feld	Typ	Beschreibung
`email`erforderlich	string
`emailVerification`erforderlich	EmailVerificationDto	The e-mail verification gate (owner decision 3 Oct 2026).
`emailVerified`erforderlich	boolean
`fullName`	string \| null
`id`erforderlich	string (uuid)
`locale`erforderlich	string

MemberDto

A membership with its person (MemberDto).

Feld	Typ	Beschreibung
`createdAt`erforderlich	string
`email`erforderlich	string
`emailVerified`erforderlich	boolean
`fullName`	string \| null
`id`erforderlich	string (uuid)
`invitation`	MemberInvitationDto \| null
`isTracked`erforderlich	boolean
`joinedAt`	string \| null
`locale`erforderlich	string
`role`erforderlich	string	`owner`, `admin`, `team_admin`, `manager`, `employee`.
`status`erforderlich	string	`invited`, `active`, `suspended`, `left`.
`teamId`	string (uuid) \| null
`teamName`	string \| null
`timeZone`	string \| null
`unassignedManager`erforderlich	boolean	A Manager with neither a team nor viewer teams (sees the whole company until assigned).
`userId`erforderlich	string (uuid)
`viewerTeamIds`erforderlich	string (uuid)[]

MemberInvitationDto

The invitation of an invited member.

Feld	Typ	Beschreibung
`emailStatus`	string \| null	`queued`, `sending`, `sent`, `failed`, `suppressed`, `not_configured`, `suppressed_reserved` (an RFC 2606 / RFC 6761 reserved domain, never e-mailed), or `null` before the first e-mail.
`expiresAt`erforderlich	string
`id`erforderlich	string (uuid)
`lastSentAt`erforderlich	string
`sentCount`erforderlich	integer (int32)

MemberPage

A page of members (OpenAPI).

Feld	Typ	Beschreibung
`items`erforderlich	MemberDto[]
`nextCursor`	string \| null

MemberRefDto

A member as a reference (current row): the connecting Admin of a connection, the owner of a webhook endpoint.

Feld	Typ	Beschreibung
`active`erforderlich	boolean	The membership is active and (for an endpoint or a tenant connection) still an Owner or Admin.
`name`	string \| null
`userId`erforderlich	string (uuid)

NamedRefDto

A reference by id and display name (a client, a person, a task).

Feld	Typ	Beschreibung
`id`erforderlich	string (uuid)
`name`erforderlich	string

OrganizationChoice

One organization of the person (sec.user_memberships).

Feld	Typ	Beschreibung
`current`erforderlich	boolean
`id`erforderlich	string (uuid)
`name`erforderlich	string
`role`erforderlich	string
`selectable`erforderlich	boolean	Can this session's sign-in method open it (design §4.5.3)?

PatchMember

PATCH /v1/members/{id}.

Feld	Typ	Beschreibung
`isTracked`	boolean \| null
`role`	string \| null	`admin`, `team_admin`, `manager` or `employee` (the Owner is only transferred).
`teamId`	string (uuid) \| null	Primary team; `null` removes it.
`timeZone`	string \| null	IANA zone of the membership; `null` follows the organization.
`viewerTeamIds`	string (uuid)[] \| null	Extra read-only teams (Manager and TeamAdmin only).

PatchTeam

PATCH /v1/teams/{id}.

Feld	Typ	Beschreibung
`description`	string \| null
`name`	string \| null

PeriodReportDto

GET /v1/reports/productivity.

Feld	Typ	Beschreibung
`from`erforderlich	string (date)
`groupBy`erforderlich	string
`levelContext`erforderlich	LevelContextDto
`periods`erforderlich	ReportPeriodDto[]
`subject`erforderlich	ReportSubjectDto
`teams`erforderlich	TeamPeriodsDto[]	Only for the company subject: every visible team over its current members.
`to`erforderlich	string (date)
`totals`erforderlich	ReportFiguresDto

PlanAbsenceDto

Feld	Typ	Beschreibung
`color`erforderlich	string
`countsAsWorked`erforderlich	boolean	`timeEffect == worked`.
`endTime`	string \| null
`half`	string \| null
`id`erforderlich	string (uuid)
`startTime`	string \| null	Local start and end of an `hours` absence.
`status`erforderlich	string	`approved` or `pending`.
`timeEffect`erforderlich	string	`leave`, `worked` or `none`.
`typeKey`	string \| null
`typeName`	string \| null	`null` for a built-in type that was not renamed (the UI translates `typeKey`).
`unit`erforderlich	string	`days`, `half_day` or `hours`.

PlanShiftDto

Feld	Typ	Beschreibung
`color`	string \| null
`end`erforderlich	string (date-time)
`endTime`erforderlich	string	Local end; before the start for a night shift.
`id`erforderlich	string (uuid)
`location`erforderlich	string
`minMinutes`erforderlich	integer (int32)
`start`erforderlich	string (date-time)
`startTime`erforderlich	string	Local start (`HH:mm`, the shift's zone).

Problem

RFC 9457 problem details (application/problem+json).

Feld	Typ	Beschreibung
`action`	string \| null	Permission key of a 403 (`teams.create`).
`code`erforderlich	string	Stable snake_case error code (catalog `error-codes.json`).
`detail`	string \| null
`errors`	FieldError[] \| null
`requiredPlan`	string \| null	Lowest plan that includes the feature (402 `feature_not_in_plan`).
`retryAfterSeconds`	integer (int32) \| null	Seconds to wait (429, 503; also the `Retry-After` header).
`status`erforderlich	integer (int32)
`title`erforderlich	string	English title of the code (clients translate `code`).
`traceId`	string \| null	W3C trace id of the request.
`type`erforderlich	string	Help page of the error code: `https://workify360.com/help/errors/<code>/`.

ProjectAmountDto

The amounts of one currency (rates are applied per allocation day and layer).

Feld	Typ	Beschreibung
`billableMinor`erforderlich	integer (int64)	The billable hours at their rate.
`costMinor`erforderlich	integer (int64)	Every allocated hour at its rate.
`currency`erforderlich	string

ProjectBudgetUsageDto

The use of a project's budget, all time.

Feld	Typ	Beschreibung
`budgetMinor`	integer (int64) \| null	`null` unless `costsIncluded`.
`budgetMinutes`	integer (int64) \| null
`kind`erforderlich	string	`hours` or `amount`.
`projectId`erforderlich	string (uuid)
`usedMinor`	integer (int64) \| null	The cost in the project's currency; `null` unless `costsIncluded`.
`usedMs`erforderlich	integer (int64)
`usedRatio`	string \| null	Used / budget, 4 decimals (`null` for an amount budget without `costsIncluded`).

ProjectDto

A project.

Feld	Typ	Beschreibung
`access`erforderlich	string	`everyone` or `members`.
`archived`erforderlich	boolean
`budget`	BudgetDto \| null
`client`	NamedRefDto \| null
`code`	string \| null
`color`	string \| null
`createdAt`erforderlich	string (date-time)
`currency`erforderlich	string	The currency of the project's rates and amount budget.
`description`	string \| null
`endDate`	string (date) \| null
`id`erforderlich	string (uuid)
`isBillable`erforderlich	boolean
`memberCount`erforderlich	integer (int64)
`myRole`	string \| null	The caller's role in the project team (`member`, `manager`), `null` outside it.
`name`erforderlich	string
`permissions`erforderlich	ProjectPermissionsDto
`spentMs`erforderlich	integer (int64)	Every allocation of the project, all time.
`startDate`	string (date) \| null
`status`erforderlich	string	`active`, `on_hold` or `completed`.
`taskCount`erforderlich	integer (int64)
`updatedAt`erforderlich	string (date-time)

ProjectPage

GET /v1/projects.

Feld	Typ	Beschreibung
`items`erforderlich	ProjectDto[]
`nextCursor`	string \| null

ProjectPermissionsDto

What the caller may do with a project (decided from the current rows, §5.3).

Feld	Typ	Beschreibung
`archive`erforderlich	boolean
`delete`erforderlich	boolean	Only a project without time.
`edit`erforderlich	boolean	The project's fields (Owners and Admins).
`manageMembers`erforderlich	boolean	The team (an Admin or the project's manager; only an Admin changes managers).
`manageTasks`erforderlich	boolean	Tasks (an Admin or the project's manager).
`track`erforderlich	boolean	The caller may track time on it now.

ProjectRefDto

A project reference of an allocation.

Feld	Typ	Beschreibung
`color`	string \| null	`#RRGGBB`.
`id`erforderlich	string (uuid)
`name`erforderlich	string

ProjectReportDto

GET /v1/reports/projects.

Feld	Typ	Beschreibung
`budgets`erforderlich	ProjectBudgetUsageDto[]
`costsIncluded`erforderlich	boolean	The caller sees rates and amounts (`projects.costs.read`).
`from`erforderlich	string (date)
`groupBy`erforderlich	string[]
`rows`erforderlich	ProjectReportRowDto[]
`to`erforderlich	string (date)
`totals`erforderlich	ProjectReportTotalsDto

ProjectReportKeysDto

The dimensions of a row (the ones not grouped by are null).

Feld	Typ	Beschreibung
`clientId`	string (uuid) \| null
`clientName`	string \| null
`date`	string (date) \| null	The allocation's local day (`groupBy` `day`).
`projectId`	string (uuid) \| null
`projectName`	string \| null
`taskId`	string (uuid) \| null
`taskName`	string \| null
`userId`	string (uuid) \| null
`userName`	string \| null

ProjectReportRowDto

One row of the project report.

Feld	Typ	Beschreibung
`allocatedMs`erforderlich	integer (int64)
`amounts`	ProjectAmountDto[] \| null	`null` unless `costsIncluded`.
`billableMs`erforderlich	integer (int64)
`keys`erforderlich	ProjectReportKeysDto
`nonBillableMs`erforderlich	integer (int64)
`productiveMs`	integer (int64) \| null	With `includeProductive` only.
`unratedMs`erforderlich	integer (int64)	Time without any rate (it is left out of the amounts).

ProjectReportTotalsDto

The totals of the report.

Feld	Typ	Beschreibung
`allocatedMs`erforderlich	integer (int64)
`amounts`	ProjectAmountDto[] \| null
`billableMs`erforderlich	integer (int64)
`nonBillableMs`erforderlich	integer (int64)
`productiveMs`	integer (int64) \| null
`unratedMs`erforderlich	integer (int64)

ProjectRequest

POST /v1/projects; PUT /v1/projects/{id} sends the whole body.

Feld	Typ	Beschreibung
`access`	string \| null	`everyone` (default) or `members`.
`budget`	BudgetRequest \| null
`clientId`	string (uuid) \| null
`code`	string \| null	`[A-Za-z0-9._-]{1,32}`, unique among active projects.
`color`	string \| null	`#RRGGBB`.
`currency`	string \| null	`TRY`, `USD` or `EUR`; locked once the project has rates or invoice lines (409 `project_currency_locked`).
`description`	string \| null
`endDate`	string (date) \| null
`isBillable`	boolean \| null	Default true.
`name`	string \| null
`startDate`	string (date) \| null
`status`	string \| null	`active` (default), `on_hold` or `completed`.

ReportFiguresDto

Figures of a group of users over a period (sums raw, percentages the users' average, counters user-days).

Feld	Typ	Beschreibung
`absenceCreditMs`erforderlich	integer (int64)
`absentDays`erforderlich	integer (int32)
`activeMs`erforderlich	integer (int64)
`activeUserCount`erforderlich	integer (int32)
`effectivenessPct`	number (double) \| null
`idleMs`erforderlich	integer (int64)
`lateDays`erforderlich	integer (int32)
`leaveDays`erforderlich	number (double)
`leftEarlyDays`erforderlich	integer (int32)
`neutralMs`erforderlich	integer (int64)
`offlineMs`erforderlich	integer (int64)
`overtimeDays`erforderlich	integer (int32)
`overtimeMs`erforderlich	integer (int64)
`productiveMs`erforderlich	integer (int64)
`productivityPct`	number (double) \| null
`targetMs`erforderlich	integer (int64)
`unproductiveMs`erforderlich	integer (int64)
`userCount`erforderlich	integer (int32)
`workedMs`erforderlich	integer (int64)

ReportPeriodDto

One period of a grouped report: its key and bounds, then the figures.

ReportScopeDto

What the caller can see (FAZ1 AccessPolicy.ScopeOf).

Feld	Typ	Beschreibung
`kind`erforderlich	string	`company`, `teams` or `self`.
`teamIds`erforderlich	string (uuid)[]	The visible teams of a `teams` scope, sorted; empty otherwise (company = all).
`unassignedFallback`erforderlich	boolean	A Manager without teams who sees the whole company until assigned.

ReportSubjectDto

Whom a report is about.

Feld	Typ	Beschreibung
`id`	string (uuid) \| null
`kind`erforderlich	string	`company`, `team` or `user`.
`name`	string \| null

RotatedWebhookSecretDto

RotatedWebhookSecretDto: the new signing secret, shown once.

Feld	Typ	Beschreibung
`previousSecretExpiresAt`erforderlich	string	Until then deliveries carry both signatures.
`secret`erforderlich	string	`whsec_<base64>`: shown once, never again.

ShiftBody

ShiftBody of POST /v1/shifts, the bulk items and PUT /v1/shifts/{id} (the whole body). Fields left null are filled from templateId.

Feld	Typ	Beschreibung
`breakMinutes`	integer (int32) \| null
`color`	string \| null
`date`	string (date) \| null
`endTime`	string \| null
`location`	string \| null
`minMinutes`	integer (int32) \| null	`null` = the template's, else duration − break.
`note`	string \| null
`startTime`	string \| null
`teamId`	string (uuid) \| null	Required for an open shift; ignored for an assigned one (the user's current team is written).
`templateId`	string (uuid) \| null
`userId`	string (uuid) \| null	`null` = an open shift.

ShiftDto

A shift: local fields, UTC instants, the caller's permissions.

Feld	Typ	Beschreibung
`breakMinutes`erforderlich	integer (int32)
`color`	string \| null
`createdAt`erforderlich	string (date-time)
`createdBy`erforderlich	CalendarUserRefDto
`crossesMidnight`erforderlich	boolean
`date`erforderlich	string (date)
`durationMinutes`erforderlich	integer (int32)
`end`erforderlich	string (date-time)
`endTime`erforderlich	string
`id`erforderlich	string (uuid)
`location`erforderlich	string
`minMinutes`erforderlich	integer (int32)
`note`	string \| null
`open`erforderlich	boolean	No user assigned.
`permissions`erforderlich	ShiftPermissionsDto
`source`erforderlich	string	`manual`, `template`, `copy` or `request`.
`start`erforderlich	string (date-time)
`startTime`erforderlich	string
`teamId`	string (uuid) \| null	Open shift: its team; assigned: the user's team when it was written.
`teamName`	string \| null
`templateId`	string (uuid) \| null
`templateName`	string \| null
`timeZone`erforderlich	string
`updatedAt`erforderlich	string (date-time)
`user`	CalendarUserRefDto \| null
`userId`	string (uuid) \| null	`null` for an open shift.

ShiftListDto

GET /v1/shifts (the shifts **starting** in the range).

Feld	Typ	Beschreibung
`items`erforderlich	ShiftDto[]

ShiftPermissionsDto

Feld	Typ	Beschreibung
`canDelete`erforderlich	boolean
`canEdit`erforderlich	boolean
`canPickUp`erforderlich	boolean
`canRequestSwap`erforderlich	boolean

SummaryDto

The summary of the visible users over a range.

Feld	Typ	Beschreibung
`absenceCreditMs`erforderlich	integer (int64)
`absentDays`erforderlich	integer (int32)
`activeMs`erforderlich	integer (int64)
`activeUserCount`erforderlich	integer (int32)
`atWorkMs`erforderlich	integer (int64)
`days`erforderlich	DayTotalDto[]
`deletedMs`erforderlich	integer (int64)
`domains`erforderlich	DomainTotalDto[]	Top 10.
`effectivenessPct`	number (double) \| null	Average of the users' range Effectiveness % (inactive tracked users included).
`from`erforderlich	string (date)
`holidayDays`erforderlich	number (double)
`idleMs`erforderlich	integer (int64)
`inactiveUsers`erforderlich	UserTotalDto[]	Tracked users without activity in the range (zero totals, attendance fields), by user id.
`lateDays`erforderlich	integer (int32)
`leaveDays`erforderlich	number (double)
`leftEarlyDays`erforderlich	integer (int32)
`levelContext`erforderlich	LevelContextDto
`meetingMs`erforderlich	integer (int64)
`neutralMs`erforderlich	integer (int64)
`offlineMs`erforderlich	integer (int64)
`overtimeMs`erforderlich	integer (int64)
`privateMs`erforderlich	integer (int64)
`productiveMs`erforderlich	integer (int64)
`productivityPct`	number (double) \| null	Average of the users' range Productivity %.
`scope`erforderlich	ReportScopeDto
`shiftDays`erforderlich	integer (int32)
`teams`erforderlich	TeamTotalDto[]	By current team: named teams by name, the `teamId: null` row last.
`to`erforderlich	string (date)
`topApps`erforderlich	AppTotalDto[]	Top 10; `name` is "Offline time" for the reserved offline keys.
`unproductiveMs`erforderlich	integer (int64)
`users`erforderlich	UserTotalDto[]	One row per user with a computed day in the range, by `activeMs`.
`workedMs`erforderlich	integer (int64)

TargetItemDto

Feld	Typ	Beschreibung
`activeMs`erforderlich	integer (int64)
`categoryKey`	string \| null
`categorySource`erforderlich	string	`tenant`, `builtin` or `none`.
`domain`	string \| null
`level`erforderlich	string
`levelSource`erforderlich	string	`team`, `company` or `default`.
`matchedKey`	string \| null
`name`erforderlich	string
`percentage`erforderlich	number (double)
`targetKey`erforderlich	string
`targetType`erforderlich	string	`app` for apps, `domain` for domains and hosts.
`userCount`erforderlich	integer (int32)

TargetListDto

The "Apps & URLs" list.

Feld	Typ	Beschreibung
`from`erforderlich	string (date)
`items`erforderlich	TargetItemDto[]	By active time descending, then key.
`levelContext`erforderlich	LevelContextDto
`nextCursor`	string \| null
`to`erforderlich	string (date)
`total`erforderlich	integer (int32)	Targets matching the filters (before paging).
`totalActiveMs`erforderlich	integer (int64)	Active time over every target of the type before the filters (the percentage base).
`type`erforderlich	string	`app`, `domain` or `host`.

TaskDto

A task.

Feld	Typ	Beschreibung
`archived`erforderlich	boolean
`assignee`	NamedRefDto \| null
`createdAt`erforderlich	string (date-time)
`description`	string \| null
`dueDate`	string (date) \| null
`effectiveBillable`erforderlich	boolean
`estimateMinutes`	integer (int64) \| null
`id`erforderlich	string (uuid)
`isBillable`	boolean \| null	`null` takes the project's value.
`name`erforderlich	string
`permissions`erforderlich	TaskPermissionsDto
`projectId`erforderlich	string (uuid)
`sortOrder`erforderlich	integer (int64)
`spentMs`erforderlich	integer (int64)
`status`erforderlich	string	`open`, `in_progress` or `done`.
`updatedAt`erforderlich	string (date-time)

TaskPage

GET /v1/projects/{id}/tasks.

Feld	Typ	Beschreibung
`items`erforderlich	TaskDto[]
`nextCursor`	string \| null

TaskPermissionsDto

What the caller may do with a task.

Feld	Typ	Beschreibung
`delete`erforderlich	boolean	Only a task without time.
`edit`erforderlich	boolean

TaskRequest

POST /v1/projects/{id}/tasks; PUT /v1/tasks/{id} sends the whole body.

Feld	Typ	Beschreibung
`assigneeUserId`	string (uuid) \| null	Must be able to track time on the project (422 `project_not_trackable`).
`description`	string \| null
`dueDate`	string (date) \| null
`estimateMinutes`	integer (int64) \| null	1–1 000 000.
`isBillable`	boolean \| null	`null` takes the project's value.
`name`	string \| null
`sortOrder`	integer (int64) \| null
`status`	string \| null	`open` (default), `in_progress` or `done`.

TeamDto

A team with its size and leads (TeamDto).

Feld	Typ	Beschreibung
`archivedAt`	string \| null
`createdAt`erforderlich	string
`description`	string \| null
`id`erforderlich	string (uuid)
`leads`erforderlich	object[]	TeamAdmins and Managers of the team: `[{membershipId, userId, fullName, role}]`.
`memberCount`erforderlich	integer (int64)	Members whose primary team this is (left members excluded).
`name`erforderlich	string
`updatedAt`erforderlich	string

TeamPage

A page of teams (OpenAPI).

Feld	Typ	Beschreibung
`items`erforderlich	TeamDto[]
`nextCursor`	string \| null

TeamPeriodsDto

Feld	Typ	Beschreibung
`periods`erforderlich	ReportPeriodDto[]
`teamId`erforderlich	string (uuid)
`teamName`	string \| null
`totals`erforderlich	ReportFiguresDto

TeamTotalDto

One team row of a summary (current teams; percentages the members' average).

Feld	Typ	Beschreibung
`absenceCreditMs`erforderlich	integer (int64)
`absentDays`erforderlich	integer (int32)
`activeMs`erforderlich	integer (int64)
`activeUserCount`erforderlich	integer (int32)
`effectivenessPct`	number (double) \| null
`holidayDays`erforderlich	number (double)
`idleMs`erforderlich	integer (int64)
`lateDays`erforderlich	integer (int32)
`leaveDays`erforderlich	number (double)
`leftEarlyDays`erforderlich	integer (int32)
`memberCount`erforderlich	integer (int32)
`neutralMs`erforderlich	integer (int64)
`offlineMs`erforderlich	integer (int64)
`overtimeMs`erforderlich	integer (int64)
`productiveMs`erforderlich	integer (int64)
`productivityPct`	number (double) \| null
`shiftDays`erforderlich	integer (int32)
`teamId`	string (uuid) \| null	`null` for the users without a team.
`teamName`	string \| null
`unproductiveMs`erforderlich	integer (int64)
`workedMs`erforderlich	integer (int64)

TimeEntryDecisionRequest

POST /v1/time-entries/{id}/decision.

Feld	Typ	Beschreibung
`decision`	string \| null	`approve` or `reject`.
`note`	string \| null	At most 500 characters.

TimeEntryDto

An offline entry or a deletion (design §8.2).

Feld	Typ	Beschreibung
`createdAt`erforderlich	string (date-time)
`createdBy`erforderlich	TimeEntryUserRefDto
`date`erforderlich	string (date)	The user's local day of the entry, in the zone effective when it was written.
`decidedAt`	string (date-time) \| null
`decidedBy`	TimeEntryUserRefDto \| null
`decisionNote`	string \| null
`description`	string \| null
`durationMs`erforderlich	integer (int64)
`end`erforderlich	string (date-time)
`id`erforderlich	string (uuid)
`kind`erforderlich	string	`offline` or `deletion`.
`level`	string \| null	Offline: `productive`, `neutral` or `unproductive`; deletion: `null`.
`permissions`erforderlich	TimeEntryPermissionsDto
`projectId`	string (uuid) \| null	Always `null` until projects (Phase 6).
`source`erforderlich	string	`manual` (Phase 8 adds `calendar`).
`start`erforderlich	string (date-time)
`status`erforderlich	string	`pending`, `approved` or `rejected`.
`timeZone`erforderlich	string
`updatedAt`erforderlich	string (date-time)
`userId`erforderlich	string (uuid)

TimeEntryPage

GET /v1/time-entries: by start.

Feld	Typ	Beschreibung
`items`erforderlich	TimeEntryDto[]
`nextCursor`	string \| null

TimeEntryPermissionsDto

What the caller may do with the entry (TimeEntryPolicy.PermissionsFor), the same on every endpoint.

Feld	Typ	Beschreibung
`canApprove`erforderlich	boolean
`canDelete`erforderlich	boolean
`canEdit`erforderlich	boolean

TimeEntryUserRefDto

A user reference of an entry (fullName from the directory; null when unknown).

Feld	Typ	Beschreibung
`fullName`	string \| null
`id`erforderlich	string (uuid)

TimeIntervalDto

A UTC interval without any detail (e.g. a private interval).

Feld	Typ	Beschreibung
`end`erforderlich	string (date-time)
`start`erforderlich	string (date-time)

TimerAtRequest

POST /v1/me/timer/stop and /discard.

Feld	Typ	Beschreibung
`at`	string (date-time) \| null

TimerCommandResultDto

The result of a command (200 also when it did not apply).

Feld	Typ	Beschreibung
`applied`erforderlich	boolean
`closed`erforderlich	AllocationDto[]	The allocations written from the segment this command closed (may be empty).
`reason`	string \| null	`stale`, `not_running` or `unchanged`; `null` when applied.
`timer`erforderlich	TimerDto

TimerDto

GET /v1/me/timer (ETag: "v<rowVersion>", "v0" before the first command).

Feld	Typ	Beschreibung
`autoStopAt`	string (date-time) \| null	`startedAt` + 24 hours.
`effectiveBillable`	boolean \| null
`isBillable`	boolean \| null
`last`	TimerLastDto \| null
`note`	string \| null
`project`	TimerProjectDto \| null
`segmentId`	string (uuid) \| null
`serverTime`erforderlich	string (date-time)	The server's clock (clients compute the elapsed time against it).
`source`	string \| null	`web`, `desktop` or `api`.
`startedAt`	string (date-time) \| null
`state`erforderlich	string	`running` or `stopped`.
`task`	NamedRefDto \| null

TimerLastDto

The segment that ended last.

Feld	Typ	Beschreibung
`endReason`erforderlich	string	`stop`, `switch`, `autostop` or `discard`.
`endedAt`erforderlich	string (date-time)
`segmentId`erforderlich	string (uuid)
`startedAt`erforderlich	string (date-time)

TimerProjectDto

The project of the running segment.

Feld	Typ	Beschreibung
`clientName`	string \| null
`color`	string \| null
`id`erforderlich	string (uuid)
`name`erforderlich	string

TimerStartRequest

POST /v1/me/timer/start (Idempotency-Key: the client's command id): start, or switch while running.

Feld	Typ	Beschreibung
`at`	string (date-time) \| null	The client's clock when the command was given (default: the server's now; at most 5 minutes ahead, at most 7 days back).
`isBillable`	boolean \| null
`note`	string \| null
`projectId`	string (uuid) \| null
`source`	string \| null	`web` (default), `desktop` or `api`.
`taskId`	string (uuid) \| null

UpdateTimeEntryRequest

PUT /v1/time-entries/{id}: the whole editable body (kind and user never change; If-Match instead of version).

Feld	Typ	Beschreibung
`description`	string \| null
`end`	string (date-time) \| null
`level`	string \| null
`projectId`	string (uuid) \| null
`start`	string (date-time) \| null

UpdateWebhookEndpointRequest

PATCH /v1/webhook-endpoints/{id} (If-Match).

Feld	Typ	Beschreibung
`description`	string \| null	`null` clears it.
`eventTypes`	string[] \| null
`status`	string \| null	`active` (also opens a `disabled` endpoint and resets its failure counters) or `paused`.
`takeOver`	boolean \| null	`true`: the caller becomes the endpoint's owner (lifts an `owner_inactive` pause).
`url`	string \| null

UserDailyDto

A user's days: computed days plus the workdays without activity up to the user's today.

Feld	Typ	Beschreibung
`days`erforderlich	UserDayDto[]
`from`erforderlich	string (date)
`teamId`	string (uuid) \| null	The user's current primary team (its rules classify every day).
`timeZone`erforderlich	string
`to`erforderlich	string (date)
`userId`erforderlich	string (uuid)

UserDayDto

Feld	Typ	Beschreibung
`absence`	DayAbsenceDto \| null
`absenceCreditMs`erforderlich	integer (int64)
`activeMs`erforderlich	integer (int64)
`afkCoverage`erforderlich	boolean
`arrivalAt`	string (date-time) \| null
`atWorkMs`erforderlich	integer (int64)
`attendanceStatus`	string \| null	`onTime`, `late`, `absent`, `notStarted`, `dayOff`, `onLeave`, `holiday`; `null` outside the directory.
`classified`erforderlich	boolean
`date`erforderlich	string (date)
`dayOffWorkedMs`erforderlich	integer (int64)
`deletedMs`erforderlich	integer (int64)
`effectivenessPct`	number (double) \| null
`eventCount`erforderlich	integer (int64)
`expectedWorkMs`erforderlich	integer (int64)
`holiday`	DailyHolidayDto \| null
`idleMs`erforderlich	integer (int64)
`lateByMs`erforderlich	integer (int64)
`leftAt`	string (date-time) \| null
`leftEarly`erforderlich	boolean
`leftEarlyByMs`erforderlich	integer (int64)
`meetingMs`erforderlich	integer (int64)
`neutralMs`erforderlich	integer (int64)
`offlineMs`erforderlich	integer (int64)
`overtimeMs`erforderlich	integer (int64)
`planKind`	string \| null	`schedule`, `shift`, `dayOff` or `holiday`.
`privateMs`erforderlich	integer (int64)
`productiveMs`erforderlich	integer (int64)
`productivityPct`	number (double) \| null
`shiftCount`erforderlich	integer (int32)
`targetMs`erforderlich	integer (int64)
`topApp`	string \| null	Display name of the app with the most active time.
`unproductiveMs`erforderlich	integer (int64)
`workday`	boolean \| null
`workedMs`erforderlich	integer (int64)

UserTotalDto

One user of a summary.

Feld	Typ	Beschreibung
`absenceCreditMs`erforderlich	integer (int64)
`absentDays`	integer (int32) \| null	Only for tracked users.
`activeDays`erforderlich	integer (int32)	Local days with active time.
`activeMs`erforderlich	integer (int64)
`arrivalAt`	string (date-time) \| null	Earliest arrival and latest leave in the range.
`atWorkMs`erforderlich	integer (int64)
`classifiedDays`erforderlich	integer (int32)
`dayOffWorkedMs`erforderlich	integer (int64)
`deletedMs`erforderlich	integer (int64)
`effectivenessPct`	number (double) \| null	`null` without a target and for users missing from the directory.
`email`	string \| null
`eventCount`erforderlich	integer (int64)
`fullName`	string \| null
`holidayDays`erforderlich	number (double)
`idleMs`erforderlich	integer (int64)
`lateDays`	integer (int32) \| null
`leaveDays`erforderlich	number (double)
`leftAt`	string (date-time) \| null
`leftEarlyDays`	integer (int32) \| null
`meetingMs`erforderlich	integer (int64)
`neutralMs`erforderlich	integer (int64)
`offlineMs`erforderlich	integer (int64)
`overtimeDays`erforderlich	integer (int32)
`overtimeMs`erforderlich	integer (int64)
`privateMs`erforderlich	integer (int64)
`productiveMs`erforderlich	integer (int64)
`productivityPct`	number (double) \| null
`shiftDays`erforderlich	integer (int32)
`targetMs`	integer (int64) \| null
`teamId`	string (uuid) \| null
`teamName`	string \| null
`timeZone`erforderlich	string
`unproductiveMs`erforderlich	integer (int64)
`userId`erforderlich	string (uuid)
`workdays`	integer (int32) \| null
`workedMs`erforderlich	integer (int64)

WebhookDeliveryDetailDto

GET /v1/webhook-endpoints/{id}/deliveries/{deliveryId}: the delivery and the body that was (or is) sent.

WebhookDeliveryDto

WebhookDeliveryDto.

Feld	Typ	Beschreibung
`attempts`erforderlich	integer (int32)
`createdAt`erforderlich	string
`deliveredAt`	string \| null
`eventId`erforderlich	string (uuid)	The `webhook-id` header.
`eventType`erforderlich	string
`id`erforderlich	string	A 64-bit integer as a string.
`lastDurationMs`	integer (int32) \| null
`lastError`	string \| null	`timeout`, `connect`, `tls`, `not_allowed`, `http_<code>`, `not_in_plan`, `owner_inactive`.
`lastStatusCode`	integer (int32) \| null
`nextAttemptAt`	string \| null
`status`erforderlich	string	`pending`, `succeeded`, `failed`, `dead`.

WebhookDeliveryPage

GET /v1/webhook-endpoints/{id}/deliveries (newest first).

Feld	Typ	Beschreibung
`items`erforderlich	WebhookDeliveryDto[]
`nextCursor`	string \| null

WebhookEndpointDto

WebhookEndpointDto.

Feld	Typ	Beschreibung
`createdAt`erforderlich	string
`description`	string \| null
`eventTypes`erforderlich	string[]
`id`erforderlich	string (uuid)
`owner`erforderlich	MemberRefDto	The member who owns the endpoint (G1: a delivery needs an active Owner or Admin owner).
`previousSecretExpiresAt`	string \| null	After a rotation the previous secret still signs until then (24 hours).
`secretPrefix`erforderlich	string	The first 8 characters of the signing secret (`whsec_Kx`); never the secret.
`stats`erforderlich	WebhookEndpointStatsDto
`status`erforderlich	string	`active`, `paused`, `disabled`.
`statusReason`	string \| null	`manual`, `owner_inactive`, `failing`, `gone`; `null` while active.
`updatedAt`erforderlich	string
`url`erforderlich	string
`version`erforderlich	integer (int64)	`row_version` (`ETag: "v<n>"`, `If-Match` of `PATCH`).

WebhookEndpointPage

GET /v1/webhook-endpoints.

Feld	Typ	Beschreibung
`items`erforderlich	WebhookEndpointDto[]
`nextCursor`	string \| null

WebhookEndpointStatsDto

The delivery statistics of an endpoint.

Feld	Typ	Beschreibung
`consecutiveFailures`erforderlich	integer (int32)
`lastFailureAt`	string \| null
`lastSuccessAt`	string \| null

WebhookEventDto

One event type of GET /v1/webhook-events.

Feld	Typ	Beschreibung
`available`erforderlich	boolean	The tenant's plan has the feature: an endpoint may subscribe.
`description`erforderlich	string	One English sentence (the panel translates by `type`).
`feature`	string \| null	The plan feature the event needs (`null`: every plan with `api_access`).
`object`erforderlich	string	The `data.object` of the delivery body.
`type`erforderlich	string	`<object>.<verb>`, e.g. `time_entry.approved`.

WebhookEventsDto

GET /v1/webhook-events.

Feld	Typ	Beschreibung
`items`erforderlich	WebhookEventDto[]

WebhookTestDto

202 of POST /v1/webhook-endpoints/{id}/test.

Feld	Typ	Beschreibung
`deliveryId`erforderlich	string	The delivery of the test event (a string: the deliveries' id is a 64-bit integer).

Referenz der öffentlichen API

Authentifizierung

Scopes

Rate-Limits

Fehler

Webhooks

Operationen

Abwesenheiten

GET /v1/absences Scope: reports:read

Parameter

POST /v1/absences Scope: time:write

Parameter

POST /v1/absences/{id}/decision Scope: time:write

Parameter

Aktivität

GET /v1/activity/day Scope: reports:read

Parameter

Zeitzuweisungen

GET /v1/allocations Scope: reports:read

Parameter

POST /v1/allocations Scope: time:write

Parameter

Exporte

POST /v1/exports Scope: reports:read

Parameter

GET /v1/exports/{id} Scope: reports:read

Parameter

Eigenes Profil

GET /v1/me Scope: me

Mitglieder

POST /v1/invitations Scope: org:admin

Parameter

GET /v1/members Scope: org:admin

Parameter

GET /v1/members/{id} Scope: org:admin

Parameter

PATCH /v1/members/{id} Scope: org:admin

Parameter

POST /v1/members/{id}/reactivate Scope: org:admin

Parameter

POST /v1/members/{id}/suspend Scope: org:admin

Parameter

Projekte

GET /v1/projects Scope: reports:read

Parameter

POST /v1/projects Scope: org:admin

Parameter

GET /v1/projects/{id} Scope: reports:read

Parameter

PUT /v1/projects/{id} Scope: org:admin

Parameter

Berichte

GET /v1/reports/productivity Scope: reports:read

Parameter

GET /v1/reports/projects Scope: reports:read

Parameter

GET /v1/reports/summary Scope: reports:read

Parameter

GET /v1/reports/targets Scope: reports:read

Parameter

GET /v1/reports/users/{userId}/daily Scope: reports:read

Parameter

Schichten

GET /v1/shifts Scope: reports:read

Parameter

POST /v1/shifts Scope: time:write

Parameter

Aufgaben

GET /v1/projects/{id}/tasks Scope: reports:read

Parameter

POST /v1/projects/{id}/tasks Scope: time:write

Parameter

GET /v1/tasks/{id} Scope: reports:read

Parameter

PUT /v1/tasks/{id} Scope: time:write

Parameter

Teams

GET /v1/teams Scope: reports:read

Parameter

POST /v1/teams Scope: org:admin

GET `/v1/absences` Scope: `reports:read`

POST `/v1/absences` Scope: `time:write`

POST `/v1/absences/{id}/decision` Scope: `time:write`

GET `/v1/activity/day` Scope: `reports:read`

GET `/v1/allocations` Scope: `reports:read`

POST `/v1/allocations` Scope: `time:write`

POST `/v1/exports` Scope: `reports:read`

GET `/v1/exports/{id}` Scope: `reports:read`

GET `/v1/me` Scope: `me`

POST `/v1/invitations` Scope: `org:admin`

GET `/v1/members` Scope: `org:admin`

GET `/v1/members/{id}` Scope: `org:admin`

PATCH `/v1/members/{id}` Scope: `org:admin`

POST `/v1/members/{id}/reactivate` Scope: `org:admin`

POST `/v1/members/{id}/suspend` Scope: `org:admin`

GET `/v1/projects` Scope: `reports:read`

POST `/v1/projects` Scope: `org:admin`

GET `/v1/projects/{id}` Scope: `reports:read`

PUT `/v1/projects/{id}` Scope: `org:admin`

GET `/v1/reports/productivity` Scope: `reports:read`

GET `/v1/reports/projects` Scope: `reports:read`

GET `/v1/reports/summary` Scope: `reports:read`

GET `/v1/reports/targets` Scope: `reports:read`

GET `/v1/reports/users/{userId}/daily` Scope: `reports:read`

GET `/v1/shifts` Scope: `reports:read`

POST `/v1/shifts` Scope: `time:write`

GET `/v1/projects/{id}/tasks` Scope: `reports:read`

POST `/v1/projects/{id}/tasks` Scope: `time:write`

GET `/v1/tasks/{id}` Scope: `reports:read`

PUT `/v1/tasks/{id}` Scope: `time:write`

GET `/v1/teams` Scope: `reports:read`

POST `/v1/teams` Scope: `org:admin`

PATCH `/v1/teams/{id}` Scope: `org:admin`

GET `/v1/time-entries` Scope: `reports:read`

POST `/v1/time-entries` Scope: `time:write`

GET `/v1/time-entries/{id}` Scope: `reports:read`

PUT `/v1/time-entries/{id}` Scope: `time:write`

DELETE `/v1/time-entries/{id}` Scope: `time:write`

POST `/v1/time-entries/{id}/decision` Scope: `time:write`

GET `/v1/me/timer` Scope: `me`

POST `/v1/me/timer/start` Scope: `me`

POST `/v1/me/timer/stop` Scope: `me`

GET `/v1/webhook-endpoints` Scope: `webhooks:manage`

POST `/v1/webhook-endpoints` Scope: `webhooks:manage`

GET `/v1/webhook-endpoints/{id}` Scope: `webhooks:manage`

PATCH `/v1/webhook-endpoints/{id}` Scope: `webhooks:manage`

DELETE `/v1/webhook-endpoints/{id}` Scope: `webhooks:manage`

GET `/v1/webhook-endpoints/{id}/deliveries` Scope: `webhooks:manage`

GET `/v1/webhook-endpoints/{id}/deliveries/{deliveryId}` Scope: `webhooks:manage`

POST `/v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retry` Scope: `webhooks:manage`

POST `/v1/webhook-endpoints/{id}/rotate-secret` Scope: `webhooks:manage`

POST `/v1/webhook-endpoints/{id}/test` Scope: `webhooks:manage`

GET `/v1/webhook-events` Scope: `webhooks:manage`