Referensi API publik

API publik Workify360 Focus memungkinkan skrip dan alat Anda sendiri membaca laporan dan data waktu serta melakukan perubahan dengan aturan yang sama seperti di dasbor. API publik, kunci API, dan webhook adalah bagian dari paket Premium.

Operasi di halaman ini dijaga agar tetap kompatibel dengan versi sebelumnya. Dokumen OpenAPI yang dapat dibaca mesin untuk operasi yang sama:

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

Dihasilkan dari kontrak API versi 0.1.0 (c95fb97bb49a).

Autentikasi

Kirim kunci API pribadi di header Authorization pada setiap permintaan. Kunci adalah milik orang yang membuatnya, bertindak sebagai orang tersebut, dan tidak pernah melakukan lebih dari yang diizinkan oleh perannya saat ini. Permintaan dengan kunci yang tidak ada, salah, kedaluwarsa, atau dicabut akan mendapat 401 dengan kode unauthorized.

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

Cara membuat, menetapkan scope, dan mencabut kunci: Kunci API dan API publik

Scope

Setiap operasi memerlukan satu scope, yang ditampilkan di sebelahnya. Sebuah kunci dapat menjangkau suatu operasi jika memiliki scope tersebut dan peran, tim, serta paket pemiliknya saat ini mengizinkan permintaan itu, persis seperti di dasbor.

Scope	Yang diizinkan
`me`	Profil Anda sendiri dan timer Anda
`reports:read`	Membaca laporan, entri waktu, ketidakhadiran, shift, tim, proyek, tugas, dan ekspor
`time:write`	Menambahkan dan mengubah entri waktu, ketidakhadiran, shift, tugas, dan waktu yang ditetapkan ke tugas, serta memutuskan permintaan
`org:admin`	Mengelola anggota, tim, undangan, dan proyek
`webhooks:manage`	Mengelola endpoint webhook

Batas laju

Setiap kunci dapat mengirim 600 unit per menit dan sebuah organisasi 1.800 unit untuk semua kuncinya secara bersama-sama. Permintaan yang mengubah sesuatu (apa pun selain GET dan HEAD) dihitung sebagai dua unit, permintaan lainnya sebagai satu unit. Sebuah kunci juga dapat mengirim paling banyak 60 unit sekaligus, yang diisi ulang 10 per detik: lebih dari 60 pembacaan (atau 30 perubahan) secara beruntun akan mendapat 429 meskipun masih di bawah 600 per menit.

Header	Arti
`RateLimit: "key";r=598;t=2`	Pada setiap respons yang dihitung: unit yang tersisa untuk kunci dan jumlah detik sampai unit penuh kembali
`RateLimit-Policy: "key";q=600;w=60, "tenant";q=1800;w=60`	Pada setiap respons yang dihitung: batas per menit untuk kunci dan untuk organisasi
`Retry-After: 12`	Dengan 429 (kode `rate_limited`): jumlah detik yang harus ditunggu sebelum permintaan berikutnya

Error

Error adalah dokumen masalah RFC 9457 (Content-Type: application/problem+json). code adalah kode snake_case yang stabil untuk digunakan dalam pemrograman; title adalah teks bahasa Inggris untuk log. type adalah alamat bantuan untuk kode tersebut, https://workify360.com/help/errors/<code>/ dengan setiap _ ditulis sebagai -, yang membuka artikel bantuan yang menjelaskan kode tersebut jika kode itu memilikinya.

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

Beberapa dokumen masalah memuat field tambahan: errors (error per field dari 422 validation_failed), action (izin yang dirujuk oleh 403 forbidden), requiredPlan (402 feature_not_in_plan), retryAfterSeconds (429 dan 503), dan traceId (sebutkan saat Anda menghubungi dukungan).

Status	Kode	Kapan
400	`invalid_request`	Format parameter salah atau parameter tidak ada
401	`unauthorized`	Kunci tidak ada, salah, kedaluwarsa, atau dicabut, atau pemiliknya telah keluar dari organisasi
402	`feature_not_in_plan`, `subscription_read_only`	Paket tidak mencakup fitur tersebut, atau langganan dalam mode hanya-baca
403	`forbidden`, `feature_not_enabled`	Kunci tidak memiliki scope tersebut, atau peran, tim, atau pengaturan pemiliknya saat ini tidak mengizinkan permintaan itu
412	`version_conflict`	Versi `If-Match` bukan lagi versi terkini; baca kembali resource tersebut
422	`validation_failed`	Body tidak valid; `errors` mencantumkan field-field yang bermasalah
428	`precondition_required`	Operasi memerlukan header `If-Match` dengan versi yang Anda baca
429	`rate_limited`	Terlalu banyak permintaan; tunggu sejumlah detik yang tertera di `Retry-After`

Kode yang memiliki artikel bantuan ditampilkan sebagai tautan di daftar operasi.

Webhook

Alih-alih memanggil API berulang kali, endpoint milik Anda dapat menerima permintaan HTTPS yang ditandatangani saat sesuatu berubah. Event, format permintaan, cara memverifikasi tanda tangan di Node.js dan Python, percobaan ulang, serta rotasi secret dijelaskan di artikel bantuan: Webhook

Operasi

Dikelompokkan berdasarkan area. Ringkasan dan deskripsi field berasal dari kontrak API.

Ketidakhadiran

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

List absences overlapping a range.

Parameter

Nama	Lokasi	Tipe	Deskripsi
`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)

Respons

200 AbsencePage

Error

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

Nama	Lokasi	Tipe	Deskripsi
`Idempotency-Key`wajib	header	string	Required: the same key and body return the first answer

Body permintaan

AbsenceRequest

Respons

201 AbsenceDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Id
`If-Match`wajib	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Body permintaan

CalendarDecisionRequest

Respons

200 AbsenceDto

Error

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)

Aktivitas

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

Nama	Lokasi	Tipe	Deskripsi
`date`	query	string (date)	The user's local day (required).
`userId`	query	string (uuid)	Default: the caller; another user must be visible (else 403).

Respons

200 ActivityDayDto

Error

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

Alokasi waktu

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

Nama	Lokasi	Tipe	Deskripsi
`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).

Respons

200 AllocationPage

Error

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

Nama	Lokasi	Tipe	Deskripsi
`Idempotency-Key`	header	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Body permintaan

AllocationCreateRequest

Respons

201 AllocationCreatedDto

Error

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

Ekspor

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

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

Parameter

Nama	Lokasi	Tipe	Deskripsi
`Idempotency-Key`wajib	header	string	Required: the same key and body return the first answer

Body permintaan

CreateExportRequest

Respons

202 ExportJobDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Id

Respons

200 ExportJobDto

Error

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

Saya

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

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

Respons

200 MeDto

Error

401 unauthorized

Anggota

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

Invite a person.

Parameter

Nama	Lokasi	Tipe	Deskripsi
`Idempotency-Key`wajib	header	string	Required: 1–255 printable ASCII characters

Body permintaan

CreateInvitation

Respons

201 InvitationResult

Error

409 already_member
422 validation_failed, idempotency_key_reused

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

List members.

Parameter

Nama	Lokasi	Tipe	Deskripsi
`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

Respons

200 MemberPage

Error

403 No right

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

One member.

Parameter

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Membership id

Respons

200 MemberDto

Error

404 member_not_found

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

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

Parameter

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Membership id
`If-Match`wajib	header	string	ETag of the member ("v<n>")

Body permintaan

PatchMember

Respons

200 MemberDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Membership id

Respons: 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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Membership id

Respons

200 MemberDto

Error

409 conflict (an invitation is revoked instead)

Proyek

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

Nama	Lokasi	Tipe	Deskripsi
`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).

Respons

200 ProjectPage

Error

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

Nama	Lokasi	Tipe	Deskripsi
`Idempotency-Key`	header	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Body permintaan

ProjectRequest

Respons

201 ProjectDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Project id

Respons

200 ProjectDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Project id
`If-Match`wajib	header	string	The ETag the caller read (412 version_conflict when it changed)

Body permintaan

ProjectRequest

Respons

200 ProjectDto

Error

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)

Laporan

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

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

Parameter

Nama	Lokasi	Tipe	Deskripsi
`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)

Respons

200 PeriodReportDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`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).

Respons

200 ProjectReportDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`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).

Respons

200 SummaryDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`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.

Respons

200 TargetListDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`userId`wajib	path	string (uuid)	User
`from`	query	string (date)
`to`	query	string (date)	At most 93 days after `from`.

Respons

200 UserDailyDto

Error

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

Shift

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

List the shifts starting in a range.

Parameter

Nama	Lokasi	Tipe	Deskripsi
`from`	query	string (date)
`to`	query	string (date)
`teamId`	query	string (uuid)
`userId`	query	string (uuid)
`includeOpen`	query	boolean	Also open shifts (default true).

Respons

200 ShiftListDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`Idempotency-Key`wajib	header	string	Required: the same key and body return the first answer

Body permintaan

ShiftBody

Respons

201 ShiftDto

Error

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

Tugas

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

A visible project's tasks, by sort order.

Parameter

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	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).

Respons

200 TaskPage

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	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)

Body permintaan

TaskRequest

Respons

201 TaskDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Task id

Respons

200 TaskDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Task id
`If-Match`wajib	header	string	The ETag the caller read (412 version_conflict when it changed)

Body permintaan

TaskRequest

Respons

200 TaskDto

Error

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)

Tim

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

List teams.

Parameter

Nama	Lokasi	Tipe	Deskripsi
`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

Respons: 200 TeamPage

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

Create a team (the G1 endpoint).

Body permintaan

CreateTeam

Respons

201 TeamDto

Error

403 forbidden (action teams.create)
409 team_name_taken

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

Rename a team or change its description.

Parameter

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Team id
`If-Match`wajib	header	string	ETag of the team

Body permintaan

PatchTeam

Respons

200 TeamDto

Error

409 team_name_taken

Entri waktu

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

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

Parameter

Nama	Lokasi	Tipe	Deskripsi
`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.

Respons

200 TimeEntryPage

Error

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

Nama	Lokasi	Tipe	Deskripsi
`Idempotency-Key`wajib	header	string	Required: the same key and body return the first answer

Body permintaan

CreateTimeEntryRequest

Respons

201 TimeEntryDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Entry id

Respons

200 TimeEntryDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Entry id
`If-Match`wajib	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Body permintaan

UpdateTimeEntryRequest

Respons

200 TimeEntryDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Entry id
`If-Match`wajib	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Respons

204 (tanpa body)

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	Entry id
`If-Match`wajib	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Body permintaan

TimeEntryDecisionRequest

Respons

200 TimeEntryDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`If-None-Match`	header	string \| null	The ETag the caller holds (304 when unchanged)

Respons

200 TimerDto · 304 (tanpa body)

Error

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

Nama	Lokasi	Tipe	Deskripsi
`Idempotency-Key`	header	string \| null	The client's command id; a retry returns the first answer

Body permintaan

TimerStartRequest

Respons

200 TimerCommandResultDto

Error

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

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

Parameter

Nama	Lokasi	Tipe	Deskripsi
`Idempotency-Key`	header	string \| null	The client's command id; a retry returns the first answer

Body permintaan

TimerAtRequest

Respons

200 TimerCommandResultDto

Error

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

Webhook

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

The tenant's webhook endpoints.

Parameter

Nama	Lokasi	Tipe	Deskripsi
`cursor`	query	string
`limit`	query	integer (int32)	1–200, default 50.

Respons

200 WebhookEndpointPage

Error

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).

Body permintaan

CreateWebhookEndpointRequest

Respons

201 CreatedWebhookEndpointDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	The endpoint

Respons

200 WebhookEndpointDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	The endpoint
`If-Match`wajib	header	string	The endpoint's ETag (`"v<n>"`)

Body permintaan

UpdateWebhookEndpointRequest

Respons

200 WebhookEndpointDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	The endpoint

Respons

204 (tanpa body)

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	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.

Respons

200 WebhookDeliveryPage

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	The endpoint
`deliveryId`wajib	path	string	The delivery (a 64-bit integer)

Respons

200 WebhookDeliveryDetailDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	The endpoint
`deliveryId`wajib	path	string	The delivery (a 64-bit integer)

Respons

202 AcceptedDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	The endpoint

Respons

200 RotatedWebhookSecretDto

Error

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

Nama	Lokasi	Tipe	Deskripsi
`id`wajib	path	string (uuid)	The endpoint

Respons

202 WebhookTestDto

Error

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.

Respons

200 WebhookEventsDto

Error

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

Skema

Body permintaan dan respons yang digunakan oleh operasi. Field yang wajib ditandai.

AbsenceDto

An absence.

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

AbsencePage

GET /v1/absences.

Field	Tipe	Deskripsi
`items`wajib	AbsenceDto[]
`nextCursor`	string \| null

AbsencePermissionsDto

Field	Tipe	Deskripsi
`canApprove`wajib	boolean
`canCancel`wajib	boolean
`canEdit`wajib	boolean

AbsenceRequest

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

Field	Tipe	Deskripsi
`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.

Field	Tipe	Deskripsi
`color`wajib	string
`countsAsWorked`wajib	boolean
`deductsFromBalance`wajib	boolean
`id`wajib	string (uuid)
`key`	string \| null
`name`wajib	string
`paid`wajib	boolean
`timeEffect`wajib	string

AcceptedDto

202 Accepted of a queued job.

Field	Tipe	Deskripsi
`accepted`wajib	boolean	Always `true`.

AccessDto

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

Field	Tipe	Deskripsi
`assignableRoles`wajib	string[]
`canManageCompanySettings`wajib	boolean
`canManageTeams`wajib	boolean
`canManageUsers`wajib	boolean
`manageTeamIds`wajib	string[]
`scope`wajib	string	`company`, `teams` or `self`.
`unassignedFallback`wajib	boolean
`viewTeamIds`wajib	string[]

ActivityDayDto

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

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

ActivitySlotDto

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

Field	Tipe	Deskripsi
`activeMs`wajib	integer (int64)
`apps`wajib	AppUsageDto[]
`neutralMs`wajib	integer (int64)
`offlineMs`wajib	integer (int64)
`productiveMs`wajib	integer (int64)
`slotStart`wajib	string (date-time)
`unproductiveMs`wajib	integer (int64)

AffectedAllocationDto

An allocation replace changed.

Field	Tipe	Deskripsi
`change`wajib	string	`trimmed`, `split` or `deleted`.
`id`wajib	string (uuid)

AllocationCreateRequest

POST /v1/allocations (Idempotency-Key).

Field	Tipe	Deskripsi
`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.

Field	Tipe	Deskripsi
`affected`wajib	AffectedAllocationDto[]
`allocation`wajib	AllocationDto

AllocationDto

Time on a project.

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

AllocationPage

GET /v1/allocations.

Field	Tipe	Deskripsi
`items`wajib	AllocationDto[]
`nextCursor`	string \| null

AllocationPermissionsDto

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

Field	Tipe	Deskripsi
`delete`wajib	boolean
`edit`wajib	boolean

AppTotalDto

Field	Tipe	Deskripsi
`activeMs`wajib	integer (int64)
`appKey`wajib	string
`categoryKey`	string \| null
`level`	string \| null	Level in the response's `levelContext`.
`name`wajib	string
`percentage`wajib	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".

Field	Tipe	Deskripsi
`activeMs`wajib	integer (int64)
`appKey`wajib	string
`categoryKey`	string \| null
`level`	string \| null	The app's own rule (`productive`, `unproductive`, `neutral`).
`levelSource`	string \| null	`team`, `company`, `default` or `offline`.
`name`wajib	string

BudgetDto

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

Field	Tipe	Deskripsi
`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).

Field	Tipe	Deskripsi
`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).

Field	Tipe	Deskripsi
`decision`	string \| null
`note`	string \| null

CalendarPersonDto

A user with the current team.

Field	Tipe	Deskripsi
`fullName`	string \| null
`id`wajib	string (uuid)
`teamId`	string (uuid) \| null
`teamName`	string \| null

CalendarUserRefDto

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

Field	Tipe	Deskripsi
`fullName`	string \| null
`id`wajib	string (uuid)

CapabilitiesDto

Subscription capabilities.

Field	Tipe	Deskripsi
`features`wajib	string[]
`readOnly`wajib	boolean

CategoryUsageDto

Field	Tipe	Deskripsi
`activeMs`wajib	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.

Field	Tipe	Deskripsi
`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.

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

CreateTeam

POST /v1/teams.

Field	Tipe	Deskripsi
`description`	string \| null	At most 500 characters.
`name`wajib	string	1–100 characters, unique among active teams (Turkish case folding).

CreateTimeEntryRequest

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

Field	Tipe	Deskripsi
`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.

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

CreatedWebhookEndpointDto

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

Field	Tipe	Deskripsi
`endpoint`wajib	WebhookEndpointDto
`secret`wajib	string	`whsec_<base64>`: shown once, never again.

DailyHolidayDto

A holiday of a daily report day.

Field	Tipe	Deskripsi
`half`	string \| null
`key`wajib	string
`name`wajib	string	English name; `nameTr` is the Turkish one.
`nameTr`wajib	string

DayAbsenceDto

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

Field	Tipe	Deskripsi
`color`wajib	string
`fraction`wajib	number (double)	The day's approved absence coverage (0–1).
`half`	string \| null
`typeKey`	string \| null
`typeName`	string \| null
`unit`wajib	string

DayAttendanceDto

Attendance of the day on the day plan.

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

DayPlanDto

The day plan of one user's day.

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

DayProductivityDto

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

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

DayTotalDto

One local day of a summary.

Field	Tipe	Deskripsi
`activeMs`wajib	integer (int64)
`activeUserCount`wajib	integer (int32)
`atWorkMs`wajib	integer (int64)
`date`wajib	string (date)
`idleMs`wajib	integer (int64)
`neutralMs`wajib	integer (int64)
`offlineMs`wajib	integer (int64)
`privateMs`wajib	integer (int64)
`productiveMs`wajib	integer (int64)
`productivityPct`	number (double) \| null
`unproductiveMs`wajib	integer (int64)

DomainTotalDto

Field	Tipe	Deskripsi
`activeMs`wajib	integer (int64)
`categoryKey`	string \| null
`domain`wajib	string
`level`	string \| null
`percentage`wajib	number (double)

DomainUsageDto

Field	Tipe	Deskripsi
`activeMs`wajib	integer (int64)
`categoryKey`	string \| null
`domain`wajib	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).

Field	Tipe	Deskripsi
`dueAt`	string (date-time) \| null	The deadline of an unverified account (`Identity__EmailVerificationGraceHours` after its creation).
`state`wajib	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}]).

Field	Tipe	Deskripsi
`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.

Field	Tipe	Deskripsi
`includeInactiveUsers`	boolean
`teamId`	string \| null
`userIds`	string \| null[] \| null

ExportJobDto

An export job as the panel lists and polls it.

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

ExportOptionsDto

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

Field	Tipe	Deskripsi
`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.

Field	Tipe	Deskripsi
`code`wajib	string	Stable snake_case code (`required`, `too_long`, `invalid`, ...).
`field`wajib	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).

Field	Tipe	Deskripsi
`half`	string \| null
`key`wajib	string	Built-in key (`republic_day`, …) or `custom`.
`name`wajib	string
`nameEn`wajib	string
`nameTr`wajib	string
`source`	string \| null	`builtin` or `tenant`.

HostUsageDto

Field	Tipe	Deskripsi
`activeMs`wajib	integer (int64)
`domain`	string \| null
`host`wajib	string
`level`wajib	string
`levelSource`wajib	string
`matchedKey`	string \| null	Key of the matching domain rule; `null` for the default.

InvitationEmail

What happened to the invitation e-mail.

Field	Tipe	Deskripsi
`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`wajib	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.

Field	Tipe	Deskripsi
`expiresAt`wajib	string
`id`wajib	string (uuid)

InvitationResult

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

Field	Tipe	Deskripsi
`email`wajib	InvitationEmail
`invitation`wajib	InvitationRef
`member`wajib	MemberDto

LevelContextDto

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

Field	Tipe	Deskripsi
`kind`wajib	string	`user` (a `userId` filter: that user's current team), `team` (a `teamId` filter) or `company`.
`teamId`	string (uuid) \| null

MeDto

GET /v1/me.

Field	Tipe	Deskripsi
`access`wajib	AccessDto
`capabilities`wajib	CapabilitiesDto
`effectiveTimeZone`wajib	string
`membership`wajib	MeMembership
`organization`wajib	MeOrganization
`organizations`wajib	OrganizationChoice[]
`session`	MeSession \| null
`user`wajib	MeUser

MeMembership

The membership in the current organization.

Field	Tipe	Deskripsi
`id`wajib	string (uuid)
`isTracked`wajib	boolean
`joinedAt`	string \| null
`role`wajib	string
`status`wajib	string
`teamId`	string (uuid) \| null
`teamName`	string \| null
`timeZone`	string \| null
`viewerTeamIds`wajib	string (uuid)[]

MeOrganization

The current organization.

Field	Tipe	Deskripsi
`defaultLocale`wajib	string
`id`wajib	string (uuid)
`name`wajib	string
`slug`wajib	string
`status`wajib	string
`timeZone`wajib	string

MeSession

The current session.

Field	Tipe	Deskripsi
`absoluteExpiresAt`wajib	string
`amr`wajib	string[]
`authTime`wajib	string
`clientId`wajib	string
`id`wajib	string (uuid)
`idleExpiresAt`wajib	string

MeUser

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

Field	Tipe	Deskripsi
`email`wajib	string
`emailVerification`wajib	EmailVerificationDto	The e-mail verification gate (owner decision 3 Oct 2026).
`emailVerified`wajib	boolean
`fullName`	string \| null
`id`wajib	string (uuid)
`locale`wajib	string

MemberDto

A membership with its person (MemberDto).

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

MemberInvitationDto

The invitation of an invited member.

Field	Tipe	Deskripsi
`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`wajib	string
`id`wajib	string (uuid)
`lastSentAt`wajib	string
`sentCount`wajib	integer (int32)

MemberPage

A page of members (OpenAPI).

Field	Tipe	Deskripsi
`items`wajib	MemberDto[]
`nextCursor`	string \| null

MemberRefDto

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

Field	Tipe	Deskripsi
`active`wajib	boolean	The membership is active and (for an endpoint or a tenant connection) still an Owner or Admin.
`name`	string \| null
`userId`wajib	string (uuid)

NamedRefDto

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

Field	Tipe	Deskripsi
`id`wajib	string (uuid)
`name`wajib	string

OrganizationChoice

One organization of the person (sec.user_memberships).

Field	Tipe	Deskripsi
`current`wajib	boolean
`id`wajib	string (uuid)
`name`wajib	string
`role`wajib	string
`selectable`wajib	boolean	Can this session's sign-in method open it (design §4.5.3)?

PatchMember

PATCH /v1/members/{id}.

Field	Tipe	Deskripsi
`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}.

Field	Tipe	Deskripsi
`description`	string \| null
`name`	string \| null

PeriodReportDto

GET /v1/reports/productivity.

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

PlanAbsenceDto

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

PlanShiftDto

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

Problem

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

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

Field	Tipe	Deskripsi
`billableMinor`wajib	integer (int64)	The billable hours at their rate.
`costMinor`wajib	integer (int64)	Every allocated hour at its rate.
`currency`wajib	string

ProjectBudgetUsageDto

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

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

ProjectDto

A project.

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

ProjectPage

GET /v1/projects.

Field	Tipe	Deskripsi
`items`wajib	ProjectDto[]
`nextCursor`	string \| null

ProjectPermissionsDto

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

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

ProjectRefDto

A project reference of an allocation.

Field	Tipe	Deskripsi
`color`	string \| null	`#RRGGBB`.
`id`wajib	string (uuid)
`name`wajib	string

ProjectReportDto

GET /v1/reports/projects.

Field	Tipe	Deskripsi
`budgets`wajib	ProjectBudgetUsageDto[]
`costsIncluded`wajib	boolean	The caller sees rates and amounts (`projects.costs.read`).
`from`wajib	string (date)
`groupBy`wajib	string[]
`rows`wajib	ProjectReportRowDto[]
`to`wajib	string (date)
`totals`wajib	ProjectReportTotalsDto

ProjectReportKeysDto

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

Field	Tipe	Deskripsi
`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.

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

ProjectReportTotalsDto

The totals of the report.

Field	Tipe	Deskripsi
`allocatedMs`wajib	integer (int64)
`amounts`	ProjectAmountDto[] \| null
`billableMs`wajib	integer (int64)
`nonBillableMs`wajib	integer (int64)
`productiveMs`	integer (int64) \| null
`unratedMs`wajib	integer (int64)

ProjectRequest

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

Field	Tipe	Deskripsi
`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).

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

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

ReportSubjectDto

Whom a report is about.

Field	Tipe	Deskripsi
`id`	string (uuid) \| null
`kind`wajib	string	`company`, `team` or `user`.
`name`	string \| null

RotatedWebhookSecretDto

RotatedWebhookSecretDto: the new signing secret, shown once.

Field	Tipe	Deskripsi
`previousSecretExpiresAt`wajib	string	Until then deliveries carry both signatures.
`secret`wajib	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.

Field	Tipe	Deskripsi
`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.

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

Field	Tipe	Deskripsi
`items`wajib	ShiftDto[]

ShiftPermissionsDto

Field	Tipe	Deskripsi
`canDelete`wajib	boolean
`canEdit`wajib	boolean
`canPickUp`wajib	boolean
`canRequestSwap`wajib	boolean

SummaryDto

The summary of the visible users over a range.

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

TargetItemDto

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

TargetListDto

The "Apps & URLs" list.

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

TaskDto

A task.

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

TaskPage

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

Field	Tipe	Deskripsi
`items`wajib	TaskDto[]
`nextCursor`	string \| null

TaskPermissionsDto

What the caller may do with a task.

Field	Tipe	Deskripsi
`delete`wajib	boolean	Only a task without time.
`edit`wajib	boolean

TaskRequest

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

Field	Tipe	Deskripsi
`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).

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

TeamPage

A page of teams (OpenAPI).

Field	Tipe	Deskripsi
`items`wajib	TeamDto[]
`nextCursor`	string \| null

TeamPeriodsDto

Field	Tipe	Deskripsi
`periods`wajib	ReportPeriodDto[]
`teamId`wajib	string (uuid)
`teamName`	string \| null
`totals`wajib	ReportFiguresDto

TeamTotalDto

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

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

TimeEntryDecisionRequest

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

Field	Tipe	Deskripsi
`decision`	string \| null	`approve` or `reject`.
`note`	string \| null	At most 500 characters.

TimeEntryDto

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

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

TimeEntryPage

GET /v1/time-entries: by start.

Field	Tipe	Deskripsi
`items`wajib	TimeEntryDto[]
`nextCursor`	string \| null

TimeEntryPermissionsDto

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

Field	Tipe	Deskripsi
`canApprove`wajib	boolean
`canDelete`wajib	boolean
`canEdit`wajib	boolean

TimeEntryUserRefDto

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

Field	Tipe	Deskripsi
`fullName`	string \| null
`id`wajib	string (uuid)

TimeIntervalDto

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

Field	Tipe	Deskripsi
`end`wajib	string (date-time)
`start`wajib	string (date-time)

TimerAtRequest

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

Field	Tipe	Deskripsi
`at`	string (date-time) \| null

TimerCommandResultDto

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

Field	Tipe	Deskripsi
`applied`wajib	boolean
`closed`wajib	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`wajib	TimerDto

TimerDto

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

Field	Tipe	Deskripsi
`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`wajib	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`wajib	string	`running` or `stopped`.
`task`	NamedRefDto \| null

TimerLastDto

The segment that ended last.

Field	Tipe	Deskripsi
`endReason`wajib	string	`stop`, `switch`, `autostop` or `discard`.
`endedAt`wajib	string (date-time)
`segmentId`wajib	string (uuid)
`startedAt`wajib	string (date-time)

TimerProjectDto

The project of the running segment.

Field	Tipe	Deskripsi
`clientName`	string \| null
`color`	string \| null
`id`wajib	string (uuid)
`name`wajib	string

TimerStartRequest

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

Field	Tipe	Deskripsi
`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).

Field	Tipe	Deskripsi
`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).

Field	Tipe	Deskripsi
`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.

Field	Tipe	Deskripsi
`days`wajib	UserDayDto[]
`from`wajib	string (date)
`teamId`	string (uuid) \| null	The user's current primary team (its rules classify every day).
`timeZone`wajib	string
`to`wajib	string (date)
`userId`wajib	string (uuid)

UserDayDto

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

UserTotalDto

One user of a summary.

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

WebhookDeliveryDetailDto

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

WebhookDeliveryDto

WebhookDeliveryDto.

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

WebhookDeliveryPage

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

Field	Tipe	Deskripsi
`items`wajib	WebhookDeliveryDto[]
`nextCursor`	string \| null

WebhookEndpointDto

WebhookEndpointDto.

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

WebhookEndpointPage

GET /v1/webhook-endpoints.

Field	Tipe	Deskripsi
`items`wajib	WebhookEndpointDto[]
`nextCursor`	string \| null

WebhookEndpointStatsDto

The delivery statistics of an endpoint.

Field	Tipe	Deskripsi
`consecutiveFailures`wajib	integer (int32)
`lastFailureAt`	string \| null
`lastSuccessAt`	string \| null

WebhookEventDto

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

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

WebhookEventsDto

GET /v1/webhook-events.

Field	Tipe	Deskripsi
`items`wajib	WebhookEventDto[]

WebhookTestDto

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

Field	Tipe	Deskripsi
`deliveryId`wajib	string	The delivery of the test event (a string: the deliveries' id is a 64-bit integer).

Referensi API publik

Autentikasi

Scope

Batas laju

Error

Webhook

Operasi

Ketidakhadiran

GET /v1/absences Scope: reports:read

Parameter

POST /v1/absences Scope: time:write

Parameter

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

Parameter

Aktivitas

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

Parameter

Alokasi waktu

GET /v1/allocations Scope: reports:read

Parameter

POST /v1/allocations Scope: time:write

Parameter

Ekspor

POST /v1/exports Scope: reports:read

Parameter

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

Parameter

Saya

GET /v1/me Scope: me

Anggota

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

Proyek

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

Laporan

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

Shift

GET /v1/shifts Scope: reports:read

Parameter

POST /v1/shifts Scope: time:write

Parameter

Tugas

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

Tim

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`