Dokumentacja publicznego API

Publiczne API Workify360 Focus pozwala twoim własnym skryptom i narzędziom odczytywać raporty i dane o czasie pracy oraz wprowadzać zmiany według tych samych zasad co w panelu. Publiczne API, klucze API i webhooki są częścią planu Premium.

Operacje opisane na tej stronie zachowują zgodność wsteczną. Dokument OpenAPI tych samych operacji w formacie do odczytu maszynowego:

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

Wygenerowano z kontraktu API w wersji 0.1.0 (c95fb97bb49a).

Uwierzytelnianie

Wysyłaj osobisty klucz API w nagłówku Authorization każdego żądania. Klucz należy do osoby, która go utworzyła, działa w jej imieniu i nigdy nie może więcej, niż pozwala jej bieżąca rola. Żądanie z brakującym, błędnym, wygasłym lub unieważnionym kluczem otrzymuje 401 z kodem unauthorized.

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

Jak tworzyć klucze, nadawać im zakresy i je unieważniać: Klucze API i publiczne API

Zakresy

Każda operacja wymaga jednego zakresu, podanego obok niej. Klucz ma dostęp do operacji, gdy posiada ten zakres, a bieżąca rola, zespoły i plan jego właściciela pozwalają na żądanie – dokładnie tak jak w panelu.

Zakres	Na co pozwala
`me`	Twój własny profil i twój timer
`reports:read`	Odczyt raportów, wpisów czasu, nieobecności, zmian, zespołów, projektów, zadań i eksportów
`time:write`	Dodawanie i zmienianie wpisów czasu, nieobecności, zmian, zadań i czasu przypisanego do zadań oraz rozpatrywanie wniosków
`org:admin`	Zarządzanie członkami, zespołami, zaproszeniami i projektami
`webhooks:manage`	Zarządzanie endpointami webhooków

Limity zapytań

Każdy klucz może wysłać 600 jednostek na minutę, a organizacja łącznie 1800 dla wszystkich swoich kluczy. Żądanie, które coś zmienia (każde inne niż GET i HEAD), liczy się jako dwie jednostki, każde pozostałe jako jedna. Klucz może też wysłać naraz najwyżej 60 jednostek, uzupełnianych w tempie 10 na sekundę: ponad 60 odczytów (lub 30 zmian) wysłanych jednocześnie otrzyma 429, nawet poniżej 600 na minutę.

Nagłówek	Znaczenie
`RateLimit: "key";r=598;t=2`	W każdej zliczanej odpowiedzi: jednostki, które zostały kluczowi, i liczba sekund do ich pełnego uzupełnienia
`RateLimit-Policy: "key";q=600;w=60, "tenant";q=1800;w=60`	W każdej zliczanej odpowiedzi: limity na minutę dla klucza i dla organizacji
`Retry-After: 12`	Przy 429 (kod `rate_limited`): liczba sekund, którą trzeba odczekać przed kolejnym żądaniem

Błędy

Błąd jest dokumentem problemu zgodnym z RFC 9457 (Content-Type: application/problem+json). code to stały kod w formacie snake_case, na którym można opierać logikę programu; title to angielski tekst do logów. type to adres pomocy dla danego kodu, https://workify360.com/help/errors/<code>/, w którym każdy znak _ zapisany jest jako -; otwiera on artykuł pomocy wyjaśniający kod, jeśli taki artykuł istnieje.

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"
}

Niektóre problemy zawierają dodatkowe pola: errors (błędy pól przy 422 validation_failed), action (uprawnienie, którego dotyczy 403 forbidden), requiredPlan (402 feature_not_in_plan), retryAfterSeconds (429 i 503) oraz traceId (podaj go, kontaktując się z pomocą techniczną).

Status	Kod	Kiedy
400	`invalid_request`	Parametr ma nieprawidłowy format lub go brakuje
401	`unauthorized`	Brak klucza, klucz jest błędny, wygasł lub został unieważniony albo jego właściciel opuścił organizację
402	`feature_not_in_plan`, `subscription_read_only`	Plan nie obejmuje tej funkcji lub subskrypcja jest w trybie tylko do odczytu
403	`forbidden`, `feature_not_enabled`	Klucz nie ma wymaganego zakresu lub bieżąca rola, zespoły bądź ustawienia jego właściciela nie pozwalają na żądanie
412	`version_conflict`	Wersja z `If-Match` nie jest już aktualna; odczytaj zasób ponownie
422	`validation_failed`	Treść żądania jest nieprawidłowa; `errors` wymienia pola
428	`precondition_required`	Operacja wymaga nagłówka `If-Match` z odczytaną wersją
429	`rate_limited`	Zbyt wiele żądań; odczekaj liczbę sekund podaną w `Retry-After`

Kody, które mają artykuł pomocy, są linkami na liście operacji.

Webhooki

Zamiast raz po raz odpytywać API, twój endpoint może otrzymywać podpisane żądanie HTTPS, gdy coś się zmieni. Zdarzenia, format żądania, weryfikację podpisu w Node.js i Pythonie, ponawianie prób oraz rotację sekretu opisuje artykuł pomocy: Webhooki

Operacje

Pogrupowane według obszarów. Podsumowania i opisy pól pochodzą z kontraktu API.

Nieobecności

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

List absences overlapping a range.

Parametry

Nazwa	Miejsce	Typ	Opis
`from`	zapytanie	string (date)
`to`	zapytanie	string (date)	At most 366 days after `from`.
`userId`	zapytanie	string (uuid)
`teamId`	zapytanie	string (uuid)
`status`	zapytanie	string
`typeId`	zapytanie	string (uuid)
`cursor`	zapytanie	string
`limit`	zapytanie	integer (int32)

Odpowiedzi

200 AbsencePage

Błędy

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

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

Request (or record) an absence.

Parametry

Nazwa	Miejsce	Typ	Opis
`Idempotency-Key`wymagany	nagłówek	string	Required: the same key and body return the first answer

Treść żądania

AbsenceRequest

Odpowiedzi

201 AbsenceDto

Błędy

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` Zakres: `time:write`

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

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Id
`If-Match`wymagany	nagłówek	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Treść żądania

CalendarDecisionRequest

Odpowiedzi

200 AbsenceDto

Błędy

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)

Aktywność

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

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

Parametry

Nazwa	Miejsce	Typ	Opis
`date`	zapytanie	string (date)	The user's local day (required).
`userId`	zapytanie	string (uuid)	Default: the caller; another user must be visible (else 403).

Odpowiedzi

200 ActivityDayDto

Błędy

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

Przydziały czasu

GET `/v1/allocations` Zakres: `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).

Parametry

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

Odpowiedzi

200 AllocationPage

Błędy

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` Zakres: `time:write`

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

Parametry

Nazwa	Miejsce	Typ	Opis
`Idempotency-Key`	nagłówek	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Treść żądania

AllocationCreateRequest

Odpowiedzi

201 AllocationCreatedDto

Błędy

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

Eksporty

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

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

Parametry

Nazwa	Miejsce	Typ	Opis
`Idempotency-Key`wymagany	nagłówek	string	Required: the same key and body return the first answer

Treść żądania

CreateExportRequest

Odpowiedzi

202 ExportJobDto

Błędy

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}` Zakres: `reports:read`

One export job (poll every 2 s).

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Id

Odpowiedzi

200 ExportJobDto

Błędy

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

Mój profil

GET `/v1/me` Zakres: `me`

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

Odpowiedzi

200 MeDto

Błędy

401 unauthorized

Członkowie

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

Invite a person.

Parametry

Nazwa	Miejsce	Typ	Opis
`Idempotency-Key`wymagany	nagłówek	string	Required: 1–255 printable ASCII characters

Treść żądania

CreateInvitation

Odpowiedzi

201 InvitationResult

Błędy

409 already_member
422 validation_failed, idempotency_key_reused

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

List members.

Parametry

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

Odpowiedzi

200 MemberPage

Błędy

403 No right

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

One member.

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Membership id

Odpowiedzi

200 MemberDto

Błędy

404 member_not_found

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

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

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Membership id
`If-Match`wymagany	nagłówek	string	ETag of the member ("v<n>")

Treść żądania

PatchMember

Odpowiedzi

200 MemberDto

Błędy

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` Zakres: `org:admin`

Reactivate a suspended member.

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Membership id

Odpowiedzi: 200 MemberDto

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

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

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Membership id

Odpowiedzi

200 MemberDto

Błędy

409 conflict (an invitation is revoked instead)

Projekty

GET `/v1/projects` Zakres: `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).

Parametry

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

Odpowiedzi

200 ProjectPage

Błędy

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

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

Add a project (Owners and Admins).

Parametry

Nazwa	Miejsce	Typ	Opis
`Idempotency-Key`	nagłówek	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Treść żądania

ProjectRequest

Odpowiedzi

201 ProjectDto

Błędy

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}` Zakres: `reports:read`

One project (invisible projects are 404).

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Project id

Odpowiedzi

200 ProjectDto

Błędy

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

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

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

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Project id
`If-Match`wymagany	nagłówek	string	The ETag the caller read (412 version_conflict when it changed)

Treść żądania

ProjectRequest

Odpowiedzi

200 ProjectDto

Błędy

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)

Raporty

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

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

Parametry

Nazwa	Miejsce	Typ	Opis
`from`	zapytanie	string (date)
`to`	zapytanie	string (date)	`day` 93 days, `week`, `month` and `range` 366.
`groupBy`	zapytanie	string	`day`, `week`, `month` or `range`.
`teamId`	zapytanie	string (uuid)
`userId`	zapytanie	string (uuid)

Odpowiedzi

200 PeriodReportDto

Błędy

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` Zakres: `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.

Parametry

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

Odpowiedzi

200 ProjectReportDto

Błędy

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` Zakres: `reports:read`

The summary of the visible users over a range.

Parametry

Nazwa	Miejsce	Typ	Opis
`from`	zapytanie	string (date)
`to`	zapytanie	string (date)	At most 93 days after `from`.
`teamId`	zapytanie	string (uuid)	Only the team's current members; the team must be visible (else 403).

Odpowiedzi

200 SummaryDto

Błędy

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` Zakres: `reports:read`

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

Parametry

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

Odpowiedzi

200 TargetListDto

Błędy

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` Zakres: `reports:read`

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

Parametry

Nazwa	Miejsce	Typ	Opis
`userId`wymagany	ścieżka	string (uuid)	User
`from`	zapytanie	string (date)
`to`	zapytanie	string (date)	At most 93 days after `from`.

Odpowiedzi

200 UserDailyDto

Błędy

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

Zmiany

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

List the shifts starting in a range.

Parametry

Nazwa	Miejsce	Typ	Opis
`from`	zapytanie	string (date)
`to`	zapytanie	string (date)
`teamId`	zapytanie	string (uuid)
`userId`	zapytanie	string (uuid)
`includeOpen`	zapytanie	boolean	Also open shifts (default true).

Odpowiedzi

200 ShiftListDto

Błędy

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

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

Create a shift (assigned or open).

Parametry

Nazwa	Miejsce	Typ	Opis
`Idempotency-Key`wymagany	nagłówek	string	Required: the same key and body return the first answer

Treść żądania

ShiftBody

Odpowiedzi

201 ShiftDto

Błędy

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

Zadania

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

A visible project's tasks, by sort order.

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Project id
`status`	zapytanie	string	`open`, `in_progress` or `done`.
`assigneeUserId`	zapytanie	string (uuid)
`includeArchived`	zapytanie	boolean
`cursor`	zapytanie	string
`limit`	zapytanie	integer (int32)	1–500 (default 200).

Odpowiedzi

200 TaskPage

Błędy

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` Zakres: `time:write`

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

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Project id
`Idempotency-Key`	nagłówek	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Treść żądania

TaskRequest

Odpowiedzi

201 TaskDto

Błędy

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}` Zakres: `reports:read`

One task of a visible project.

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Task id

Odpowiedzi

200 TaskDto

Błędy

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

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

Change a task (the whole body).

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Task id
`If-Match`wymagany	nagłówek	string	The ETag the caller read (412 version_conflict when it changed)

Treść żądania

TaskRequest

Odpowiedzi

200 TaskDto

Błędy

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)

Zespoły

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

List teams.

Parametry

Nazwa	Miejsce	Typ	Opis
`includeArchived`	zapytanie	boolean	Also archived teams (default false)
`cursor`	zapytanie	string	Opaque cursor of the next page
`limit`	zapytanie	integer (int32)	1–200, default 50

Odpowiedzi: 200 TeamPage

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

Create a team (the G1 endpoint).

Treść żądania

CreateTeam

Odpowiedzi

201 TeamDto

Błędy

403 forbidden (action teams.create)
409 team_name_taken

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

Rename a team or change its description.

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Team id
`If-Match`wymagany	nagłówek	string	ETag of the team

Treść żądania

PatchTeam

Odpowiedzi

200 TeamDto

Błędy

409 team_name_taken

Wpisy czasu

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

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

Parametry

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

Odpowiedzi

200 TimeEntryPage

Błędy

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` Zakres: `time:write`

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

Parametry

Nazwa	Miejsce	Typ	Opis
`Idempotency-Key`wymagany	nagłówek	string	Required: the same key and body return the first answer

Treść żądania

CreateTimeEntryRequest

Odpowiedzi

201 TimeEntryDto

Błędy

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}` Zakres: `reports:read`

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

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Entry id

Odpowiedzi

200 TimeEntryDto

Błędy

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

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

Replace an entry's editable fields.

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Entry id
`If-Match`wymagany	nagłówek	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Treść żądania

UpdateTimeEntryRequest

Odpowiedzi

200 TimeEntryDto

Błędy

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}` Zakres: `time:write`

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

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Entry id
`If-Match`wymagany	nagłówek	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Odpowiedzi

204 (bez treści)

Błędy

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` Zakres: `time:write`

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

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	Entry id
`If-Match`wymagany	nagłówek	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Treść żądania

TimeEntryDecisionRequest

Odpowiedzi

200 TimeEntryDto

Błędy

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` Zakres: `me`

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

Parametry

Nazwa	Miejsce	Typ	Opis
`If-None-Match`	nagłówek	string \| null	The ETag the caller holds (304 when unchanged)

Odpowiedzi

200 TimerDto · 304 (bez treści)

Błędy

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

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

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

Parametry

Nazwa	Miejsce	Typ	Opis
`Idempotency-Key`	nagłówek	string \| null	The client's command id; a retry returns the first answer

Treść żądania

TimerStartRequest

Odpowiedzi

200 TimerCommandResultDto

Błędy

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

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

Parametry

Nazwa	Miejsce	Typ	Opis
`Idempotency-Key`	nagłówek	string \| null	The client's command id; a retry returns the first answer

Treść żądania

TimerAtRequest

Odpowiedzi

200 TimerCommandResultDto

Błędy

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

Webhooki

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

The tenant's webhook endpoints.

Parametry

Nazwa	Miejsce	Typ	Opis
`cursor`	zapytanie	string
`limit`	zapytanie	integer (int32)	1–200, default 50.

Odpowiedzi

200 WebhookEndpointPage

Błędy

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

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

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

Treść żądania

CreateWebhookEndpointRequest

Odpowiedzi

201 CreatedWebhookEndpointDto

Błędy

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}` Zakres: `webhooks:manage`

One webhook endpoint.

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	The endpoint

Odpowiedzi

200 WebhookEndpointDto

Błędy

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

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

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

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	The endpoint
`If-Match`wymagany	nagłówek	string	The endpoint's ETag (`"v<n>"`)

Treść żądania

UpdateWebhookEndpointRequest

Odpowiedzi

200 WebhookEndpointDto

Błędy

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}` Zakres: `webhooks:manage`

Delete an endpoint and its deliveries.

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	The endpoint

Odpowiedzi

204 (bez treści)

Błędy

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

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

The deliveries of an endpoint, newest first.

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	The endpoint
`status`	zapytanie	string	`pending`, `succeeded`, `failed`, `dead`.
`eventType`	zapytanie	string
`cursor`	zapytanie	string	Opaque cursor of the next page.
`limit`	zapytanie	integer (int32)	1–200, default 50.

Odpowiedzi

200 WebhookDeliveryPage

Błędy

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

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

One delivery with the body that was sent.

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	The endpoint
`deliveryId`wymagany	ścieżka	string	The delivery (a 64-bit integer)

Odpowiedzi

200 WebhookDeliveryDetailDto

Błędy

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` Zakres: `webhooks:manage`

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

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	The endpoint
`deliveryId`wymagany	ścieżka	string	The delivery (a 64-bit integer)

Odpowiedzi

202 AcceptedDto

Błędy

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

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

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

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	The endpoint

Odpowiedzi

200 RotatedWebhookSecretDto

Błędy

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

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

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

Parametry

Nazwa	Miejsce	Typ	Opis
`id`wymagany	ścieżka	string (uuid)	The endpoint

Odpowiedzi

202 WebhookTestDto

Błędy

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

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

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

Odpowiedzi

200 WebhookEventsDto

Błędy

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

Schematy

Treści żądań i odpowiedzi używane przez operacje. Pola wymagane są oznaczone.

AbsenceDto

An absence.

Pole	Typ	Opis
`createdAt`wymagany	string (date-time)
`createdBy`wymagany	CalendarUserRefDto
`days`wymagany	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`wymagany	object	The balance deduction per year, e.g. `{"2026": 3.5}`; empty for types that do not deduct.
`end`wymagany	string (date-time)
`endDate`wymagany	string (date)
`endTime`	string \| null
`half`	string \| null
`id`wymagany	string (uuid)
`note`	string \| null
`permissions`wymagany	AbsencePermissionsDto
`start`wymagany	string (date-time)	UTC coverage start.
`startDate`wymagany	string (date)
`startTime`	string \| null
`status`wymagany	string
`timeZone`wymagany	string
`type`wymagany	AbsenceTypeRefDto
`unit`wymagany	string
`updatedAt`wymagany	string (date-time)
`user`wymagany	CalendarPersonDto
`userId`wymagany	string (uuid)

AbsencePage

GET /v1/absences.

Pole	Typ	Opis
`items`wymagany	AbsenceDto[]
`nextCursor`	string \| null

AbsencePermissionsDto

Pole	Typ	Opis
`canApprove`wymagany	boolean
`canCancel`wymagany	boolean
`canEdit`wymagany	boolean

AbsenceRequest

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

Pole	Typ	Opis
`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.

Pole	Typ	Opis
`color`wymagany	string
`countsAsWorked`wymagany	boolean
`deductsFromBalance`wymagany	boolean
`id`wymagany	string (uuid)
`key`	string \| null
`name`wymagany	string
`paid`wymagany	boolean
`timeEffect`wymagany	string

AcceptedDto

202 Accepted of a queued job.

Pole	Typ	Opis
`accepted`wymagany	boolean	Always `true`.

AccessDto

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

Pole	Typ	Opis
`assignableRoles`wymagany	string[]
`canManageCompanySettings`wymagany	boolean
`canManageTeams`wymagany	boolean
`canManageUsers`wymagany	boolean
`manageTeamIds`wymagany	string[]
`scope`wymagany	string	`company`, `teams` or `self`.
`unassignedFallback`wymagany	boolean
`viewTeamIds`wymagany	string[]

ActivityDayDto

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

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

ActivitySlotDto

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

Pole	Typ	Opis
`activeMs`wymagany	integer (int64)
`apps`wymagany	AppUsageDto[]
`neutralMs`wymagany	integer (int64)
`offlineMs`wymagany	integer (int64)
`productiveMs`wymagany	integer (int64)
`slotStart`wymagany	string (date-time)
`unproductiveMs`wymagany	integer (int64)

AffectedAllocationDto

An allocation replace changed.

Pole	Typ	Opis
`change`wymagany	string	`trimmed`, `split` or `deleted`.
`id`wymagany	string (uuid)

AllocationCreateRequest

POST /v1/allocations (Idempotency-Key).

Pole	Typ	Opis
`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.

Pole	Typ	Opis
`affected`wymagany	AffectedAllocationDto[]
`allocation`wymagany	AllocationDto

AllocationDto

Time on a project.

Pole	Typ	Opis
`createdAt`wymagany	string (date-time)
`createdBy`wymagany	NamedRefDto
`durationMs`wymagany	integer (int64)
`effectiveBillable`wymagany	boolean
`endedAt`wymagany	string (date-time)
`id`wymagany	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`wymagany	string (date)	The start's day in the person's zone (rates, reports).
`note`	string \| null
`permissions`wymagany	AllocationPermissionsDto
`project`wymagany	ProjectRefDto
`source`wymagany	string	`timer`, `manual` or `assignment`.
`startedAt`wymagany	string (date-time)
`task`	NamedRefDto \| null
`timeZone`wymagany	string
`updatedAt`wymagany	string (date-time)
`userId`wymagany	string (uuid)
`version`wymagany	integer (int64)	The row version: `If-Match: "v<version>"` of a change (the same value as the resource's `ETag`).

AllocationPage

GET /v1/allocations.

Pole	Typ	Opis
`items`wymagany	AllocationDto[]
`nextCursor`	string \| null

AllocationPermissionsDto

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

Pole	Typ	Opis
`delete`wymagany	boolean
`edit`wymagany	boolean

AppTotalDto

Pole	Typ	Opis
`activeMs`wymagany	integer (int64)
`appKey`wymagany	string
`categoryKey`	string \| null
`level`	string \| null	Level in the response's `levelContext`.
`name`wymagany	string
`percentage`wymagany	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".

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

BudgetDto

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

Pole	Typ	Opis
`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).

Pole	Typ	Opis
`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).

Pole	Typ	Opis
`decision`	string \| null
`note`	string \| null

CalendarPersonDto

A user with the current team.

Pole	Typ	Opis
`fullName`	string \| null
`id`wymagany	string (uuid)
`teamId`	string (uuid) \| null
`teamName`	string \| null

CalendarUserRefDto

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

Pole	Typ	Opis
`fullName`	string \| null
`id`wymagany	string (uuid)

CapabilitiesDto

Subscription capabilities.

Pole	Typ	Opis
`features`wymagany	string[]
`readOnly`wymagany	boolean

CategoryUsageDto

Pole	Typ	Opis
`activeMs`wymagany	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.

Pole	Typ	Opis
`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.

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

CreateTeam

POST /v1/teams.

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

CreateTimeEntryRequest

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

Pole	Typ	Opis
`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.

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

CreatedWebhookEndpointDto

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

Pole	Typ	Opis
`endpoint`wymagany	WebhookEndpointDto
`secret`wymagany	string	`whsec_<base64>`: shown once, never again.

DailyHolidayDto

A holiday of a daily report day.

Pole	Typ	Opis
`half`	string \| null
`key`wymagany	string
`name`wymagany	string	English name; `nameTr` is the Turkish one.
`nameTr`wymagany	string

DayAbsenceDto

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

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

DayAttendanceDto

Attendance of the day on the day plan.

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

DayPlanDto

The day plan of one user's day.

Pole	Typ	Opis
`absences`wymagany	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`wymagany	integer (int64)	Overtime target (`base × (1 − fLeave)`).
`holiday`	HolidayRefDto \| null
`kind`wymagany	string	`schedule`, `shift`, `dayOff` or `holiday`.
`leaveFraction`wymagany	number (double)	The approved absence coverage `f` (0–1).
`shifts`wymagany	PlanShiftDto[]	Shifts starting on the day, by start.
`targetMs`wymagany	integer (int64)	Effectiveness % denominator (`base × (1 − f)`).
`workday`wymagany	boolean

DayProductivityDto

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

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

DayTotalDto

One local day of a summary.

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

DomainTotalDto

Pole	Typ	Opis
`activeMs`wymagany	integer (int64)
`categoryKey`	string \| null
`domain`wymagany	string
`level`	string \| null
`percentage`wymagany	number (double)

DomainUsageDto

Pole	Typ	Opis
`activeMs`wymagany	integer (int64)
`categoryKey`	string \| null
`domain`wymagany	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).

Pole	Typ	Opis
`dueAt`	string (date-time) \| null	The deadline of an unverified account (`Identity__EmailVerificationGraceHours` after its creation).
`state`wymagany	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}]).

Pole	Typ	Opis
`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.

Pole	Typ	Opis
`includeInactiveUsers`	boolean
`teamId`	string \| null
`userIds`	string \| null[] \| null

ExportJobDto

An export job as the panel lists and polls it.

Pole	Typ	Opis
`createdAt`wymagany	string (date-time)
`dataset`wymagany	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`wymagany	string
`from`wymagany	string (date)
`groupBy`	string \| null
`id`wymagany	string (uuid)
`locale`wymagany	string
`progress`wymagany	integer (int32)	0–100.
`rowCount`	integer (int32) \| null
`startedAt`	string (date-time) \| null
`status`wymagany	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`wymagany	string (date)

ExportOptionsDto

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

Pole	Typ	Opis
`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.

Pole	Typ	Opis
`code`wymagany	string	Stable snake_case code (`required`, `too_long`, `invalid`, ...).
`field`wymagany	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).

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

HostUsageDto

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

InvitationEmail

What happened to the invitation e-mail.

Pole	Typ	Opis
`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`wymagany	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.

Pole	Typ	Opis
`expiresAt`wymagany	string
`id`wymagany	string (uuid)

InvitationResult

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

Pole	Typ	Opis
`email`wymagany	InvitationEmail
`invitation`wymagany	InvitationRef
`member`wymagany	MemberDto

LevelContextDto

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

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

MeDto

GET /v1/me.

Pole	Typ	Opis
`access`wymagany	AccessDto
`capabilities`wymagany	CapabilitiesDto
`effectiveTimeZone`wymagany	string
`membership`wymagany	MeMembership
`organization`wymagany	MeOrganization
`organizations`wymagany	OrganizationChoice[]
`session`	MeSession \| null
`user`wymagany	MeUser

MeMembership

The membership in the current organization.

Pole	Typ	Opis
`id`wymagany	string (uuid)
`isTracked`wymagany	boolean
`joinedAt`	string \| null
`role`wymagany	string
`status`wymagany	string
`teamId`	string (uuid) \| null
`teamName`	string \| null
`timeZone`	string \| null
`viewerTeamIds`wymagany	string (uuid)[]

MeOrganization

The current organization.

Pole	Typ	Opis
`defaultLocale`wymagany	string
`id`wymagany	string (uuid)
`name`wymagany	string
`slug`wymagany	string
`status`wymagany	string
`timeZone`wymagany	string

MeSession

The current session.

Pole	Typ	Opis
`absoluteExpiresAt`wymagany	string
`amr`wymagany	string[]
`authTime`wymagany	string
`clientId`wymagany	string
`id`wymagany	string (uuid)
`idleExpiresAt`wymagany	string

MeUser

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

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

MemberDto

A membership with its person (MemberDto).

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

MemberInvitationDto

The invitation of an invited member.

Pole	Typ	Opis
`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`wymagany	string
`id`wymagany	string (uuid)
`lastSentAt`wymagany	string
`sentCount`wymagany	integer (int32)

MemberPage

A page of members (OpenAPI).

Pole	Typ	Opis
`items`wymagany	MemberDto[]
`nextCursor`	string \| null

MemberRefDto

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

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

NamedRefDto

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

Pole	Typ	Opis
`id`wymagany	string (uuid)
`name`wymagany	string

OrganizationChoice

One organization of the person (sec.user_memberships).

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

PatchMember

PATCH /v1/members/{id}.

Pole	Typ	Opis
`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}.

Pole	Typ	Opis
`description`	string \| null
`name`	string \| null

PeriodReportDto

GET /v1/reports/productivity.

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

PlanAbsenceDto

Pole	Typ	Opis
`color`wymagany	string
`countsAsWorked`wymagany	boolean	`timeEffect == worked`.
`endTime`	string \| null
`half`	string \| null
`id`wymagany	string (uuid)
`startTime`	string \| null	Local start and end of an `hours` absence.
`status`wymagany	string	`approved` or `pending`.
`timeEffect`wymagany	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`wymagany	string	`days`, `half_day` or `hours`.

PlanShiftDto

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

Problem

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

Pole	Typ	Opis
`action`	string \| null	Permission key of a 403 (`teams.create`).
`code`wymagany	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`wymagany	integer (int32)
`title`wymagany	string	English title of the code (clients translate `code`).
`traceId`	string \| null	W3C trace id of the request.
`type`wymagany	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).

Pole	Typ	Opis
`billableMinor`wymagany	integer (int64)	The billable hours at their rate.
`costMinor`wymagany	integer (int64)	Every allocated hour at its rate.
`currency`wymagany	string

ProjectBudgetUsageDto

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

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

ProjectDto

A project.

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

ProjectPage

GET /v1/projects.

Pole	Typ	Opis
`items`wymagany	ProjectDto[]
`nextCursor`	string \| null

ProjectPermissionsDto

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

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

ProjectRefDto

A project reference of an allocation.

Pole	Typ	Opis
`color`	string \| null	`#RRGGBB`.
`id`wymagany	string (uuid)
`name`wymagany	string

ProjectReportDto

GET /v1/reports/projects.

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

ProjectReportKeysDto

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

Pole	Typ	Opis
`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.

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

ProjectReportTotalsDto

The totals of the report.

Pole	Typ	Opis
`allocatedMs`wymagany	integer (int64)
`amounts`	ProjectAmountDto[] \| null
`billableMs`wymagany	integer (int64)
`nonBillableMs`wymagany	integer (int64)
`productiveMs`	integer (int64) \| null
`unratedMs`wymagany	integer (int64)

ProjectRequest

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

Pole	Typ	Opis
`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).

Pole	Typ	Opis
`absenceCreditMs`wymagany	integer (int64)
`absentDays`wymagany	integer (int32)
`activeMs`wymagany	integer (int64)
`activeUserCount`wymagany	integer (int32)
`effectivenessPct`	number (double) \| null
`idleMs`wymagany	integer (int64)
`lateDays`wymagany	integer (int32)
`leaveDays`wymagany	number (double)
`leftEarlyDays`wymagany	integer (int32)
`neutralMs`wymagany	integer (int64)
`offlineMs`wymagany	integer (int64)
`overtimeDays`wymagany	integer (int32)
`overtimeMs`wymagany	integer (int64)
`productiveMs`wymagany	integer (int64)
`productivityPct`	number (double) \| null
`targetMs`wymagany	integer (int64)
`unproductiveMs`wymagany	integer (int64)
`userCount`wymagany	integer (int32)
`workedMs`wymagany	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).

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

ReportSubjectDto

Whom a report is about.

Pole	Typ	Opis
`id`	string (uuid) \| null
`kind`wymagany	string	`company`, `team` or `user`.
`name`	string \| null

RotatedWebhookSecretDto

RotatedWebhookSecretDto: the new signing secret, shown once.

Pole	Typ	Opis
`previousSecretExpiresAt`wymagany	string	Until then deliveries carry both signatures.
`secret`wymagany	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.

Pole	Typ	Opis
`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.

Pole	Typ	Opis
`breakMinutes`wymagany	integer (int32)
`color`	string \| null
`createdAt`wymagany	string (date-time)
`createdBy`wymagany	CalendarUserRefDto
`crossesMidnight`wymagany	boolean
`date`wymagany	string (date)
`durationMinutes`wymagany	integer (int32)
`end`wymagany	string (date-time)
`endTime`wymagany	string
`id`wymagany	string (uuid)
`location`wymagany	string
`minMinutes`wymagany	integer (int32)
`note`	string \| null
`open`wymagany	boolean	No user assigned.
`permissions`wymagany	ShiftPermissionsDto
`source`wymagany	string	`manual`, `template`, `copy` or `request`.
`start`wymagany	string (date-time)
`startTime`wymagany	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`wymagany	string
`updatedAt`wymagany	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).

Pole	Typ	Opis
`items`wymagany	ShiftDto[]

ShiftPermissionsDto

Pole	Typ	Opis
`canDelete`wymagany	boolean
`canEdit`wymagany	boolean
`canPickUp`wymagany	boolean
`canRequestSwap`wymagany	boolean

SummaryDto

The summary of the visible users over a range.

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

TargetItemDto

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

TargetListDto

The "Apps & URLs" list.

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

TaskDto

A task.

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

TaskPage

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

Pole	Typ	Opis
`items`wymagany	TaskDto[]
`nextCursor`	string \| null

TaskPermissionsDto

What the caller may do with a task.

Pole	Typ	Opis
`delete`wymagany	boolean	Only a task without time.
`edit`wymagany	boolean

TaskRequest

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

Pole	Typ	Opis
`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).

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

TeamPage

A page of teams (OpenAPI).

Pole	Typ	Opis
`items`wymagany	TeamDto[]
`nextCursor`	string \| null

TeamPeriodsDto

Pole	Typ	Opis
`periods`wymagany	ReportPeriodDto[]
`teamId`wymagany	string (uuid)
`teamName`	string \| null
`totals`wymagany	ReportFiguresDto

TeamTotalDto

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

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

TimeEntryDecisionRequest

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

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

TimeEntryDto

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

Pole	Typ	Opis
`createdAt`wymagany	string (date-time)
`createdBy`wymagany	TimeEntryUserRefDto
`date`wymagany	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`wymagany	integer (int64)
`end`wymagany	string (date-time)
`id`wymagany	string (uuid)
`kind`wymagany	string	`offline` or `deletion`.
`level`	string \| null	Offline: `productive`, `neutral` or `unproductive`; deletion: `null`.
`permissions`wymagany	TimeEntryPermissionsDto
`projectId`	string (uuid) \| null	Always `null` until projects (Phase 6).
`source`wymagany	string	`manual` (Phase 8 adds `calendar`).
`start`wymagany	string (date-time)
`status`wymagany	string	`pending`, `approved` or `rejected`.
`timeZone`wymagany	string
`updatedAt`wymagany	string (date-time)
`userId`wymagany	string (uuid)

TimeEntryPage

GET /v1/time-entries: by start.

Pole	Typ	Opis
`items`wymagany	TimeEntryDto[]
`nextCursor`	string \| null

TimeEntryPermissionsDto

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

Pole	Typ	Opis
`canApprove`wymagany	boolean
`canDelete`wymagany	boolean
`canEdit`wymagany	boolean

TimeEntryUserRefDto

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

Pole	Typ	Opis
`fullName`	string \| null
`id`wymagany	string (uuid)

TimeIntervalDto

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

Pole	Typ	Opis
`end`wymagany	string (date-time)
`start`wymagany	string (date-time)

TimerAtRequest

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

Pole	Typ	Opis
`at`	string (date-time) \| null

TimerCommandResultDto

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

Pole	Typ	Opis
`applied`wymagany	boolean
`closed`wymagany	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`wymagany	TimerDto

TimerDto

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

Pole	Typ	Opis
`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`wymagany	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`wymagany	string	`running` or `stopped`.
`task`	NamedRefDto \| null

TimerLastDto

The segment that ended last.

Pole	Typ	Opis
`endReason`wymagany	string	`stop`, `switch`, `autostop` or `discard`.
`endedAt`wymagany	string (date-time)
`segmentId`wymagany	string (uuid)
`startedAt`wymagany	string (date-time)

TimerProjectDto

The project of the running segment.

Pole	Typ	Opis
`clientName`	string \| null
`color`	string \| null
`id`wymagany	string (uuid)
`name`wymagany	string

TimerStartRequest

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

Pole	Typ	Opis
`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).

Pole	Typ	Opis
`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).

Pole	Typ	Opis
`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.

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

UserDayDto

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

UserTotalDto

One user of a summary.

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

WebhookDeliveryDetailDto

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

WebhookDeliveryDto

WebhookDeliveryDto.

Pole	Typ	Opis
`attempts`wymagany	integer (int32)
`createdAt`wymagany	string
`deliveredAt`	string \| null
`eventId`wymagany	string (uuid)	The `webhook-id` header.
`eventType`wymagany	string
`id`wymagany	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`wymagany	string	`pending`, `succeeded`, `failed`, `dead`.

WebhookDeliveryPage

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

Pole	Typ	Opis
`items`wymagany	WebhookDeliveryDto[]
`nextCursor`	string \| null

WebhookEndpointDto

WebhookEndpointDto.

Pole	Typ	Opis
`createdAt`wymagany	string
`description`	string \| null
`eventTypes`wymagany	string[]
`id`wymagany	string (uuid)
`owner`wymagany	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`wymagany	string	The first 8 characters of the signing secret (`whsec_Kx`); never the secret.
`stats`wymagany	WebhookEndpointStatsDto
`status`wymagany	string	`active`, `paused`, `disabled`.
`statusReason`	string \| null	`manual`, `owner_inactive`, `failing`, `gone`; `null` while active.
`updatedAt`wymagany	string
`url`wymagany	string
`version`wymagany	integer (int64)	`row_version` (`ETag: "v<n>"`, `If-Match` of `PATCH`).

WebhookEndpointPage

GET /v1/webhook-endpoints.

Pole	Typ	Opis
`items`wymagany	WebhookEndpointDto[]
`nextCursor`	string \| null

WebhookEndpointStatsDto

The delivery statistics of an endpoint.

Pole	Typ	Opis
`consecutiveFailures`wymagany	integer (int32)
`lastFailureAt`	string \| null
`lastSuccessAt`	string \| null

WebhookEventDto

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

Pole	Typ	Opis
`available`wymagany	boolean	The tenant's plan has the feature: an endpoint may subscribe.
`description`wymagany	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`wymagany	string	The `data.object` of the delivery body.
`type`wymagany	string	`<object>.<verb>`, e.g. `time_entry.approved`.

WebhookEventsDto

GET /v1/webhook-events.

Pole	Typ	Opis
`items`wymagany	WebhookEventDto[]

WebhookTestDto

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

Pole	Typ	Opis
`deliveryId`wymagany	string	The delivery of the test event (a string: the deliveries' id is a 64-bit integer).

Dokumentacja publicznego API

Uwierzytelnianie

Zakresy

Limity zapytań

Błędy

Webhooki

Operacje

Nieobecności

GET /v1/absences Zakres: reports:read

Parametry

POST /v1/absences Zakres: time:write

Parametry

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

Parametry

Aktywność

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

Parametry

Przydziały czasu

GET /v1/allocations Zakres: reports:read

Parametry

POST /v1/allocations Zakres: time:write

Parametry

Eksporty

POST /v1/exports Zakres: reports:read

Parametry

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

Parametry

Mój profil

GET /v1/me Zakres: me

Członkowie

POST /v1/invitations Zakres: org:admin

Parametry

GET /v1/members Zakres: org:admin

Parametry

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

Parametry

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

Parametry

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

Parametry

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

Parametry

Projekty

GET /v1/projects Zakres: reports:read

Parametry

POST /v1/projects Zakres: org:admin

Parametry

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

Parametry

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

Parametry

Raporty

GET /v1/reports/productivity Zakres: reports:read

Parametry

GET /v1/reports/projects Zakres: reports:read

Parametry

GET /v1/reports/summary Zakres: reports:read

Parametry

GET /v1/reports/targets Zakres: reports:read

Parametry

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

Parametry

Zmiany

GET /v1/shifts Zakres: reports:read

Parametry

POST /v1/shifts Zakres: time:write

Parametry

Zadania

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

Parametry

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

Parametry

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

Parametry

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

Parametry

Zespoły

GET /v1/teams Zakres: reports:read

Parametry

POST /v1/teams Zakres: org:admin

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

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

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

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

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

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

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

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

GET `/v1/me` Zakres: `me`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

GET `/v1/me/timer` Zakres: `me`

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

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

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

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

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

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

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

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

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

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

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

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

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