Tài liệu tham chiếu API công khai

API công khai của Workify360 Focus cho phép các script và công cụ của riêng bạn đọc báo cáo, dữ liệu thời gian và thực hiện thay đổi theo cùng quy tắc như bảng điều khiển. API công khai, khóa API và webhook thuộc gói Premium.

Các thao tác trên trang này được duy trì tương thích ngược. Tài liệu OpenAPI dạng máy đọc được của cùng các thao tác này:

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

Được tạo từ đặc tả API phiên bản 0.1.0 (c95fb97bb49a).

Xác thực

Gửi khóa API cá nhân trong header Authorization của mọi yêu cầu. Mỗi khóa thuộc về người đã tạo ra nó, hành động với tư cách người đó và không bao giờ làm nhiều hơn những gì vai trò hiện tại của họ cho phép. Yêu cầu thiếu khóa, sai khóa, khóa hết hạn hoặc đã bị thu hồi sẽ nhận 401 với mã unauthorized.

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

Cách tạo, giới hạn phạm vi và thu hồi khóa: Khóa API và API công khai

Phạm vi quyền

Mỗi thao tác cần một phạm vi quyền, được ghi bên cạnh thao tác đó. Một khóa truy cập được thao tác khi nó có phạm vi quyền đó và vai trò, nhóm và gói hiện tại của chủ sở hữu khóa cho phép yêu cầu, giống hệt như trên bảng điều khiển.

Phạm vi	Cho phép gì
`me`	Hồ sơ của chính bạn và bộ đếm giờ của bạn
`reports:read`	Đọc báo cáo, mục thời gian, vắng mặt, ca làm việc, nhóm, dự án, công việc và bản xuất
`time:write`	Thêm và thay đổi mục thời gian, vắng mặt, ca làm việc, công việc và thời gian được gán cho công việc, và quyết định các yêu cầu
`org:admin`	Quản lý thành viên, nhóm, lời mời và dự án
`webhooks:manage`	Quản lý các endpoint webhook

Giới hạn tần suất

Mỗi khóa có thể gửi 600 đơn vị mỗi phút và một tổ chức 1.800 đơn vị cho tất cả các khóa cộng lại. Yêu cầu làm thay đổi dữ liệu (mọi yêu cầu ngoài GET và HEAD) được tính là hai đơn vị, mọi yêu cầu khác là một. Một khóa cũng chỉ có thể gửi tối đa 60 đơn vị cùng lúc, được nạp lại 10 đơn vị mỗi giây: hơn 60 lượt đọc (hoặc 30 lượt thay đổi) dồn dập sẽ nhận 429 ngay cả khi chưa đến 600 mỗi phút.

Header	Ý nghĩa
`RateLimit: "key";r=598;t=2`	Trên mọi phản hồi được tính: số đơn vị khóa còn lại và số giây cho đến khi được nạp đầy lại
`RateLimit-Policy: "key";q=600;w=60, "tenant";q=1800;w=60`	Trên mọi phản hồi được tính: giới hạn mỗi phút của khóa và của tổ chức
`Retry-After: 12`	Kèm 429 (mã `rate_limited`): số giây cần chờ trước yêu cầu tiếp theo

Lỗi

Lỗi là một tài liệu problem theo RFC 9457 (Content-Type: application/problem+json). code là mã snake_case ổn định để lập trình theo; title là văn bản tiếng Anh dùng cho log. type là địa chỉ trợ giúp của mã, https://workify360.com/help/errors/<code>/ với mỗi _ được viết thành -, mở ra bài viết trợ giúp giải thích mã đó nếu mã có bài viết.

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

Một số lỗi có thêm trường: errors (lỗi theo trường của 422 validation_failed), action (quyền mà 403 forbidden đề cập đến), requiredPlan (402 feature_not_in_plan), retryAfterSeconds (429 và 503) và traceId (hãy cung cấp khi bạn liên hệ bộ phận hỗ trợ).

Trạng thái	Mã	Khi nào
400	`invalid_request`	Một tham số sai định dạng hoặc bị thiếu
401	`unauthorized`	Khóa bị thiếu, sai, hết hạn hoặc đã bị thu hồi, hoặc chủ sở hữu khóa đã rời khỏi tổ chức
402	`feature_not_in_plan`, `subscription_read_only`	Gói không bao gồm tính năng này, hoặc gói đăng ký đang ở chế độ chỉ đọc
403	`forbidden`, `feature_not_enabled`	Khóa thiếu phạm vi quyền, hoặc vai trò, nhóm hay cài đặt hiện tại của chủ sở hữu khóa không cho phép yêu cầu
412	`version_conflict`	Phiên bản `If-Match` không còn là phiên bản hiện tại; hãy đọc lại tài nguyên
422	`validation_failed`	Nội dung yêu cầu không hợp lệ; `errors` liệt kê các trường
428	`precondition_required`	Thao tác cần header `If-Match` với phiên bản bạn đã đọc
429	`rate_limited`	Quá nhiều yêu cầu; hãy chờ số giây trong `Retry-After`

Các mã có bài viết trợ giúp được hiển thị dưới dạng liên kết trong danh sách thao tác.

Webhook

Thay vì hỏi API lặp đi lặp lại, một endpoint của bạn có thể nhận một yêu cầu HTTPS có chữ ký khi có thay đổi. Các sự kiện, định dạng yêu cầu, cách xác minh chữ ký bằng Node.js và Python, cơ chế thử lại và xoay vòng secret được giải thích trong bài viết trợ giúp: Webhook

Thao tác

Được nhóm theo lĩnh vực. Phần tóm tắt và mô tả trường lấy từ đặc tả API.

Vắng mặt

GET `/v1/absences` Phạm vi: `reports:read`

List absences overlapping a range.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`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)

Phản hồi

200 AbsencePage

Lỗi

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

POST `/v1/absences` Phạm vi: `time:write`

Request (or record) an absence.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`Idempotency-Key`bắt buộc	header	string	Required: the same key and body return the first answer

Nội dung yêu cầu

AbsenceRequest

Phản hồi

201 AbsenceDto

Lỗi

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` Phạm vi: `time:write`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Id
`If-Match`bắt buộc	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Nội dung yêu cầu

CalendarDecisionRequest

Phản hồi

200 AbsenceDto

Lỗi

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)

Hoạt động

GET `/v1/activity/day` Phạm vi: `reports:read`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`date`	query	string (date)	The user's local day (required).
`userId`	query	string (uuid)	Default: the caller; another user must be visible (else 403).

Phản hồi

200 ActivityDayDto

Lỗi

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

Phân bổ thời gian

GET `/v1/allocations` Phạm vi: `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).

Tham số

Tên	Vị trí	Kiểu	Mô tả
`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).

Phản hồi

200 AllocationPage

Lỗi

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` Phạm vi: `time:write`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`Idempotency-Key`	header	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Nội dung yêu cầu

AllocationCreateRequest

Phản hồi

201 AllocationCreatedDto

Lỗi

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

Bản xuất

POST `/v1/exports` Phạm vi: `reports:read`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`Idempotency-Key`bắt buộc	header	string	Required: the same key and body return the first answer

Nội dung yêu cầu

CreateExportRequest

Phản hồi

202 ExportJobDto

Lỗi

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}` Phạm vi: `reports:read`

One export job (poll every 2 s).

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Id

Phản hồi

200 ExportJobDto

Lỗi

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

Tôi

GET `/v1/me` Phạm vi: `me`

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

Phản hồi

200 MeDto

Lỗi

401 unauthorized

Thành viên

POST `/v1/invitations` Phạm vi: `org:admin`

Invite a person.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`Idempotency-Key`bắt buộc	header	string	Required: 1–255 printable ASCII characters

Nội dung yêu cầu

CreateInvitation

Phản hồi

201 InvitationResult

Lỗi

409 already_member
422 validation_failed, idempotency_key_reused

GET `/v1/members` Phạm vi: `org:admin`

List members.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`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

Phản hồi

200 MemberPage

Lỗi

403 No right

GET `/v1/members/{id}` Phạm vi: `org:admin`

One member.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Membership id

Phản hồi

200 MemberDto

Lỗi

404 member_not_found

PATCH `/v1/members/{id}` Phạm vi: `org:admin`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Membership id
`If-Match`bắt buộc	header	string	ETag of the member ("v<n>")

Nội dung yêu cầu

PatchMember

Phản hồi

200 MemberDto

Lỗi

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` Phạm vi: `org:admin`

Reactivate a suspended member.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Membership id

Phản hồi: 200 MemberDto

POST `/v1/members/{id}/suspend` Phạm vi: `org:admin`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Membership id

Phản hồi

200 MemberDto

Lỗi

409 conflict (an invitation is revoked instead)

Dự án

GET `/v1/projects` Phạm vi: `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).

Tham số

Tên	Vị trí	Kiểu	Mô tả
`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).

Phản hồi

200 ProjectPage

Lỗi

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

POST `/v1/projects` Phạm vi: `org:admin`

Add a project (Owners and Admins).

Tham số

Tên	Vị trí	Kiểu	Mô tả
`Idempotency-Key`	header	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Nội dung yêu cầu

ProjectRequest

Phản hồi

201 ProjectDto

Lỗi

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}` Phạm vi: `reports:read`

One project (invisible projects are 404).

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Project id

Phản hồi

200 ProjectDto

Lỗi

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

PUT `/v1/projects/{id}` Phạm vi: `org:admin`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Project id
`If-Match`bắt buộc	header	string	The ETag the caller read (412 version_conflict when it changed)

Nội dung yêu cầu

ProjectRequest

Phản hồi

200 ProjectDto

Lỗi

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)

Báo cáo

GET `/v1/reports/productivity` Phạm vi: `reports:read`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`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)

Phản hồi

200 PeriodReportDto

Lỗi

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` Phạm vi: `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.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`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).

Phản hồi

200 ProjectReportDto

Lỗi

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` Phạm vi: `reports:read`

The summary of the visible users over a range.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`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).

Phản hồi

200 SummaryDto

Lỗi

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` Phạm vi: `reports:read`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`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.

Phản hồi

200 TargetListDto

Lỗi

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` Phạm vi: `reports:read`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`userId`bắt buộc	path	string (uuid)	User
`from`	query	string (date)
`to`	query	string (date)	At most 93 days after `from`.

Phản hồi

200 UserDailyDto

Lỗi

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

Ca làm việc

GET `/v1/shifts` Phạm vi: `reports:read`

List the shifts starting in a range.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`from`	query	string (date)
`to`	query	string (date)
`teamId`	query	string (uuid)
`userId`	query	string (uuid)
`includeOpen`	query	boolean	Also open shifts (default true).

Phản hồi

200 ShiftListDto

Lỗi

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

POST `/v1/shifts` Phạm vi: `time:write`

Create a shift (assigned or open).

Tham số

Tên	Vị trí	Kiểu	Mô tả
`Idempotency-Key`bắt buộc	header	string	Required: the same key and body return the first answer

Nội dung yêu cầu

ShiftBody

Phản hồi

201 ShiftDto

Lỗi

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

Công việc

GET `/v1/projects/{id}/tasks` Phạm vi: `reports:read`

A visible project's tasks, by sort order.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	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).

Phản hồi

200 TaskPage

Lỗi

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` Phạm vi: `time:write`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	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)

Nội dung yêu cầu

TaskRequest

Phản hồi

201 TaskDto

Lỗi

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}` Phạm vi: `reports:read`

One task of a visible project.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Task id

Phản hồi

200 TaskDto

Lỗi

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

PUT `/v1/tasks/{id}` Phạm vi: `time:write`

Change a task (the whole body).

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Task id
`If-Match`bắt buộc	header	string	The ETag the caller read (412 version_conflict when it changed)

Nội dung yêu cầu

TaskRequest

Phản hồi

200 TaskDto

Lỗi

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)

Nhóm

GET `/v1/teams` Phạm vi: `reports:read`

List teams.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`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

Phản hồi: 200 TeamPage

POST `/v1/teams` Phạm vi: `org:admin`

Create a team (the G1 endpoint).

Nội dung yêu cầu

CreateTeam

Phản hồi

201 TeamDto

Lỗi

403 forbidden (action teams.create)
409 team_name_taken

PATCH `/v1/teams/{id}` Phạm vi: `org:admin`

Rename a team or change its description.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Team id
`If-Match`bắt buộc	header	string	ETag of the team

Nội dung yêu cầu

PatchTeam

Phản hồi

200 TeamDto

Lỗi

409 team_name_taken

Mục thời gian

GET `/v1/time-entries` Phạm vi: `reports:read`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`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.

Phản hồi

200 TimeEntryPage

Lỗi

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` Phạm vi: `time:write`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`Idempotency-Key`bắt buộc	header	string	Required: the same key and body return the first answer

Nội dung yêu cầu

CreateTimeEntryRequest

Phản hồi

201 TimeEntryDto

Lỗi

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}` Phạm vi: `reports:read`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Entry id

Phản hồi

200 TimeEntryDto

Lỗi

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

PUT `/v1/time-entries/{id}` Phạm vi: `time:write`

Replace an entry's editable fields.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Entry id
`If-Match`bắt buộc	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Nội dung yêu cầu

UpdateTimeEntryRequest

Phản hồi

200 TimeEntryDto

Lỗi

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}` Phạm vi: `time:write`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Entry id
`If-Match`bắt buộc	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Phản hồi

204 (không có nội dung)

Lỗi

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` Phạm vi: `time:write`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	Entry id
`If-Match`bắt buộc	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Nội dung yêu cầu

TimeEntryDecisionRequest

Phản hồi

200 TimeEntryDto

Lỗi

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)

Bộ đếm giờ

GET `/v1/me/timer` Phạm vi: `me`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`If-None-Match`	header	string \| null	The ETag the caller holds (304 when unchanged)

Phản hồi

200 TimerDto · 304 (không có nội dung)

Lỗi

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

POST `/v1/me/timer/start` Phạm vi: `me`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`Idempotency-Key`	header	string \| null	The client's command id; a retry returns the first answer

Nội dung yêu cầu

TimerStartRequest

Phản hồi

200 TimerCommandResultDto

Lỗi

POST `/v1/me/timer/stop` Phạm vi: `me`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`Idempotency-Key`	header	string \| null	The client's command id; a retry returns the first answer

Nội dung yêu cầu

TimerAtRequest

Phản hồi

200 TimerCommandResultDto

Lỗi

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` Phạm vi: `webhooks:manage`

The tenant's webhook endpoints.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`cursor`	query	string
`limit`	query	integer (int32)	1–200, default 50.

Phản hồi

200 WebhookEndpointPage

Lỗi

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

POST `/v1/webhook-endpoints` Phạm vi: `webhooks:manage`

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

Nội dung yêu cầu

CreateWebhookEndpointRequest

Phản hồi

201 CreatedWebhookEndpointDto

Lỗi

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}` Phạm vi: `webhooks:manage`

One webhook endpoint.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	The endpoint

Phản hồi

200 WebhookEndpointDto

Lỗi

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

PATCH `/v1/webhook-endpoints/{id}` Phạm vi: `webhooks:manage`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	The endpoint
`If-Match`bắt buộc	header	string	The endpoint's ETag (`"v<n>"`)

Nội dung yêu cầu

UpdateWebhookEndpointRequest

Phản hồi

200 WebhookEndpointDto

Lỗi

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}` Phạm vi: `webhooks:manage`

Delete an endpoint and its deliveries.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	The endpoint

Phản hồi

204 (không có nội dung)

Lỗi

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

GET `/v1/webhook-endpoints/{id}/deliveries` Phạm vi: `webhooks:manage`

The deliveries of an endpoint, newest first.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	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.

Phản hồi

200 WebhookDeliveryPage

Lỗi

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

GET `/v1/webhook-endpoints/{id}/deliveries/{deliveryId}` Phạm vi: `webhooks:manage`

One delivery with the body that was sent.

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	The endpoint
`deliveryId`bắt buộc	path	string	The delivery (a 64-bit integer)

Phản hồi

200 WebhookDeliveryDetailDto

Lỗi

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` Phạm vi: `webhooks:manage`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	The endpoint
`deliveryId`bắt buộc	path	string	The delivery (a 64-bit integer)

Phản hồi

202 AcceptedDto

Lỗi

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

POST `/v1/webhook-endpoints/{id}/rotate-secret` Phạm vi: `webhooks:manage`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	The endpoint

Phản hồi

200 RotatedWebhookSecretDto

Lỗi

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

POST `/v1/webhook-endpoints/{id}/test` Phạm vi: `webhooks:manage`

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

Tham số

Tên	Vị trí	Kiểu	Mô tả
`id`bắt buộc	path	string (uuid)	The endpoint

Phản hồi

202 WebhookTestDto

Lỗi

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

GET `/v1/webhook-events` Phạm vi: `webhooks:manage`

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

Phản hồi

200 WebhookEventsDto

Lỗi

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

Lược đồ

Nội dung yêu cầu và phản hồi mà các thao tác sử dụng. Các trường bắt buộc được đánh dấu.

AbsenceDto

An absence.

Trường	Kiểu	Mô tả
`createdAt`bắt buộc	string (date-time)
`createdBy`bắt buộc	CalendarUserRefDto
`days`bắt buộc	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`bắt buộc	object	The balance deduction per year, e.g. `{"2026": 3.5}`; empty for types that do not deduct.
`end`bắt buộc	string (date-time)
`endDate`bắt buộc	string (date)
`endTime`	string \| null
`half`	string \| null
`id`bắt buộc	string (uuid)
`note`	string \| null
`permissions`bắt buộc	AbsencePermissionsDto
`start`bắt buộc	string (date-time)	UTC coverage start.
`startDate`bắt buộc	string (date)
`startTime`	string \| null
`status`bắt buộc	string
`timeZone`bắt buộc	string
`type`bắt buộc	AbsenceTypeRefDto
`unit`bắt buộc	string
`updatedAt`bắt buộc	string (date-time)
`user`bắt buộc	CalendarPersonDto
`userId`bắt buộc	string (uuid)

AbsencePage

GET /v1/absences.

Trường	Kiểu	Mô tả
`items`bắt buộc	AbsenceDto[]
`nextCursor`	string \| null

AbsencePermissionsDto

Trường	Kiểu	Mô tả
`canApprove`bắt buộc	boolean
`canCancel`bắt buộc	boolean
`canEdit`bắt buộc	boolean

AbsenceRequest

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

Trường	Kiểu	Mô tả
`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.

Trường	Kiểu	Mô tả
`color`bắt buộc	string
`countsAsWorked`bắt buộc	boolean
`deductsFromBalance`bắt buộc	boolean
`id`bắt buộc	string (uuid)
`key`	string \| null
`name`bắt buộc	string
`paid`bắt buộc	boolean
`timeEffect`bắt buộc	string

AcceptedDto

202 Accepted of a queued job.

Trường	Kiểu	Mô tả
`accepted`bắt buộc	boolean	Always `true`.

AccessDto

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

Trường	Kiểu	Mô tả
`assignableRoles`bắt buộc	string[]
`canManageCompanySettings`bắt buộc	boolean
`canManageTeams`bắt buộc	boolean
`canManageUsers`bắt buộc	boolean
`manageTeamIds`bắt buộc	string[]
`scope`bắt buộc	string	`company`, `teams` or `self`.
`unassignedFallback`bắt buộc	boolean
`viewTeamIds`bắt buộc	string[]

ActivityDayDto

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

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

ActivitySlotDto

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

Trường	Kiểu	Mô tả
`activeMs`bắt buộc	integer (int64)
`apps`bắt buộc	AppUsageDto[]
`neutralMs`bắt buộc	integer (int64)
`offlineMs`bắt buộc	integer (int64)
`productiveMs`bắt buộc	integer (int64)
`slotStart`bắt buộc	string (date-time)
`unproductiveMs`bắt buộc	integer (int64)

AffectedAllocationDto

An allocation replace changed.

Trường	Kiểu	Mô tả
`change`bắt buộc	string	`trimmed`, `split` or `deleted`.
`id`bắt buộc	string (uuid)

AllocationCreateRequest

POST /v1/allocations (Idempotency-Key).

Trường	Kiểu	Mô tả
`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.

Trường	Kiểu	Mô tả
`affected`bắt buộc	AffectedAllocationDto[]
`allocation`bắt buộc	AllocationDto

AllocationDto

Time on a project.

Trường	Kiểu	Mô tả
`createdAt`bắt buộc	string (date-time)
`createdBy`bắt buộc	NamedRefDto
`durationMs`bắt buộc	integer (int64)
`effectiveBillable`bắt buộc	boolean
`endedAt`bắt buộc	string (date-time)
`id`bắt buộc	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`bắt buộc	string (date)	The start's day in the person's zone (rates, reports).
`note`	string \| null
`permissions`bắt buộc	AllocationPermissionsDto
`project`bắt buộc	ProjectRefDto
`source`bắt buộc	string	`timer`, `manual` or `assignment`.
`startedAt`bắt buộc	string (date-time)
`task`	NamedRefDto \| null
`timeZone`bắt buộc	string
`updatedAt`bắt buộc	string (date-time)
`userId`bắt buộc	string (uuid)
`version`bắt buộc	integer (int64)	The row version: `If-Match: "v<version>"` of a change (the same value as the resource's `ETag`).

AllocationPage

GET /v1/allocations.

Trường	Kiểu	Mô tả
`items`bắt buộc	AllocationDto[]
`nextCursor`	string \| null

AllocationPermissionsDto

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

Trường	Kiểu	Mô tả
`delete`bắt buộc	boolean
`edit`bắt buộc	boolean

AppTotalDto

Trường	Kiểu	Mô tả
`activeMs`bắt buộc	integer (int64)
`appKey`bắt buộc	string
`categoryKey`	string \| null
`level`	string \| null	Level in the response's `levelContext`.
`name`bắt buộc	string
`percentage`bắt buộc	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".

Trường	Kiểu	Mô tả
`activeMs`bắt buộc	integer (int64)
`appKey`bắt buộc	string
`categoryKey`	string \| null
`level`	string \| null	The app's own rule (`productive`, `unproductive`, `neutral`).
`levelSource`	string \| null	`team`, `company`, `default` or `offline`.
`name`bắt buộc	string

BudgetDto

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

Trường	Kiểu	Mô tả
`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).

Trường	Kiểu	Mô tả
`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).

Trường	Kiểu	Mô tả
`decision`	string \| null
`note`	string \| null

CalendarPersonDto

A user with the current team.

Trường	Kiểu	Mô tả
`fullName`	string \| null
`id`bắt buộc	string (uuid)
`teamId`	string (uuid) \| null
`teamName`	string \| null

CalendarUserRefDto

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

Trường	Kiểu	Mô tả
`fullName`	string \| null
`id`bắt buộc	string (uuid)

CapabilitiesDto

Subscription capabilities.

Trường	Kiểu	Mô tả
`features`bắt buộc	string[]
`readOnly`bắt buộc	boolean

CategoryUsageDto

Trường	Kiểu	Mô tả
`activeMs`bắt buộc	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.

Trường	Kiểu	Mô tả
`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.

Trường	Kiểu	Mô tả
`email`bắt buộc	string
`fullName`bắt buộc	string
`locale`	string \| null	Language of the e-mail and the acceptance page (`tr`, `en`); the organization's default otherwise.
`role`bắt buộc	string	`admin`, `team_admin`, `manager` or `employee`.
`teamId`	string (uuid) \| null
`timeZone`	string \| null
`viewerTeamIds`	string (uuid)[]

CreateTeam

POST /v1/teams.

Trường	Kiểu	Mô tả
`description`	string \| null	At most 500 characters.
`name`bắt buộc	string	1–100 characters, unique among active teams (Turkish case folding).

CreateTimeEntryRequest

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

Trường	Kiểu	Mô tả
`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.

Trường	Kiểu	Mô tả
`description`	string \| null	≤ 200 characters.
`eventTypes`bắt buộc	string[]	1–50 catalog event types of the tenant's plan.
`url`bắt buộc	string	`https://…` (≤ 2048; no user info, no fragment; every resolved address public).

CreatedWebhookEndpointDto

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

Trường	Kiểu	Mô tả
`endpoint`bắt buộc	WebhookEndpointDto
`secret`bắt buộc	string	`whsec_<base64>`: shown once, never again.

DailyHolidayDto

A holiday of a daily report day.

Trường	Kiểu	Mô tả
`half`	string \| null
`key`bắt buộc	string
`name`bắt buộc	string	English name; `nameTr` is the Turkish one.
`nameTr`bắt buộc	string

DayAbsenceDto

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

Trường	Kiểu	Mô tả
`color`bắt buộc	string
`fraction`bắt buộc	number (double)	The day's approved absence coverage (0–1).
`half`	string \| null
`typeKey`	string \| null
`typeName`	string \| null
`unit`bắt buộc	string

DayAttendanceDto

Attendance of the day on the day plan.

Trường	Kiểu	Mô tả
`expectedEnd`	string (date-time) \| null
`expectedStart`	string (date-time) \| null
`flexible`bắt buộc	boolean
`lateByMs`bắt buộc	integer (int64)
`lateToleranceMinutes`bắt buộc	integer (int32)
`leftEarly`bắt buộc	boolean
`leftEarlyByMs`bắt buộc	integer (int64)
`status`bắt buộc	string	`onTime`, `late`, `absent`, `notStarted`, `dayOff`, `onLeave`, `holiday`.
`targetMs`bắt buộc	integer (int64)	The plan's target (the Effectiveness % denominator).
`workday`bắt buộc	boolean

DayPlanDto

The day plan of one user's day.

Trường	Kiểu	Mô tả
`absences`bắt buộc	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`bắt buộc	integer (int64)	Overtime target (`base × (1 − fLeave)`).
`holiday`	HolidayRefDto \| null
`kind`bắt buộc	string	`schedule`, `shift`, `dayOff` or `holiday`.
`leaveFraction`bắt buộc	number (double)	The approved absence coverage `f` (0–1).
`shifts`bắt buộc	PlanShiftDto[]	Shifts starting on the day, by start.
`targetMs`bắt buộc	integer (int64)	Effectiveness % denominator (`base × (1 − f)`).
`workday`bắt buộc	boolean

DayProductivityDto

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

Trường	Kiểu	Mô tả
`effectivenessPct`	number (double) \| null	productive ÷ target × 100 (not capped); `null` without a target.
`neutralMs`bắt buộc	integer (int64)
`productiveMs`bắt buộc	integer (int64)
`productivityPct`	number (double) \| null	productive ÷ worked × 100, one decimal; `null` without worked time.
`targetMs`bắt buộc	integer (int64)
`unproductiveMs`bắt buộc	integer (int64)

DayTotalDto

One local day of a summary.

Trường	Kiểu	Mô tả
`activeMs`bắt buộc	integer (int64)
`activeUserCount`bắt buộc	integer (int32)
`atWorkMs`bắt buộc	integer (int64)
`date`bắt buộc	string (date)
`idleMs`bắt buộc	integer (int64)
`neutralMs`bắt buộc	integer (int64)
`offlineMs`bắt buộc	integer (int64)
`privateMs`bắt buộc	integer (int64)
`productiveMs`bắt buộc	integer (int64)
`productivityPct`	number (double) \| null
`unproductiveMs`bắt buộc	integer (int64)

DomainTotalDto

Trường	Kiểu	Mô tả
`activeMs`bắt buộc	integer (int64)
`categoryKey`	string \| null
`domain`bắt buộc	string
`level`	string \| null
`percentage`bắt buộc	number (double)

DomainUsageDto

Trường	Kiểu	Mô tả
`activeMs`bắt buộc	integer (int64)
`categoryKey`	string \| null
`domain`bắt buộc	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).

Trường	Kiểu	Mô tả
`dueAt`	string (date-time) \| null	The deadline of an unverified account (`Identity__EmailVerificationGraceHours` after its creation).
`state`bắt buộc	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}]).

Trường	Kiểu	Mô tả
`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.

Trường	Kiểu	Mô tả
`includeInactiveUsers`	boolean
`teamId`	string \| null
`userIds`	string \| null[] \| null

ExportJobDto

An export job as the panel lists and polls it.

Trường	Kiểu	Mô tả
`createdAt`bắt buộc	string (date-time)
`dataset`bắt buộc	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`bắt buộc	string
`from`bắt buộc	string (date)
`groupBy`	string \| null
`id`bắt buộc	string (uuid)
`locale`bắt buộc	string
`progress`bắt buộc	integer (int32)	0–100.
`rowCount`	integer (int32) \| null
`startedAt`	string (date-time) \| null
`status`bắt buộc	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`bắt buộc	string (date)

ExportOptionsDto

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

Trường	Kiểu	Mô tả
`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.

Trường	Kiểu	Mô tả
`code`bắt buộc	string	Stable snake_case code (`required`, `too_long`, `invalid`, ...).
`field`bắt buộc	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).

Trường	Kiểu	Mô tả
`half`	string \| null
`key`bắt buộc	string	Built-in key (`republic_day`, …) or `custom`.
`name`bắt buộc	string
`nameEn`bắt buộc	string
`nameTr`bắt buộc	string
`source`	string \| null	`builtin` or `tenant`.

HostUsageDto

Trường	Kiểu	Mô tả
`activeMs`bắt buộc	integer (int64)
`domain`	string \| null
`host`bắt buộc	string
`level`bắt buộc	string
`levelSource`bắt buộc	string
`matchedKey`	string \| null	Key of the matching domain rule; `null` for the default.

InvitationEmail

What happened to the invitation e-mail.

Trường	Kiểu	Mô tả
`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`bắt buộc	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.

Trường	Kiểu	Mô tả
`expiresAt`bắt buộc	string
`id`bắt buộc	string (uuid)

InvitationResult

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

Trường	Kiểu	Mô tả
`email`bắt buộc	InvitationEmail
`invitation`bắt buộc	InvitationRef
`member`bắt buộc	MemberDto

LevelContextDto

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

Trường	Kiểu	Mô tả
`kind`bắt buộc	string	`user` (a `userId` filter: that user's current team), `team` (a `teamId` filter) or `company`.
`teamId`	string (uuid) \| null

MeDto

GET /v1/me.

Trường	Kiểu	Mô tả
`access`bắt buộc	AccessDto
`capabilities`bắt buộc	CapabilitiesDto
`effectiveTimeZone`bắt buộc	string
`membership`bắt buộc	MeMembership
`organization`bắt buộc	MeOrganization
`organizations`bắt buộc	OrganizationChoice[]
`session`	MeSession \| null
`user`bắt buộc	MeUser

MeMembership

The membership in the current organization.

Trường	Kiểu	Mô tả
`id`bắt buộc	string (uuid)
`isTracked`bắt buộc	boolean
`joinedAt`	string \| null
`role`bắt buộc	string
`status`bắt buộc	string
`teamId`	string (uuid) \| null
`teamName`	string \| null
`timeZone`	string \| null
`viewerTeamIds`bắt buộc	string (uuid)[]

MeOrganization

The current organization.

Trường	Kiểu	Mô tả
`defaultLocale`bắt buộc	string
`id`bắt buộc	string (uuid)
`name`bắt buộc	string
`slug`bắt buộc	string
`status`bắt buộc	string
`timeZone`bắt buộc	string

MeSession

The current session.

Trường	Kiểu	Mô tả
`absoluteExpiresAt`bắt buộc	string
`amr`bắt buộc	string[]
`authTime`bắt buộc	string
`clientId`bắt buộc	string
`id`bắt buộc	string (uuid)
`idleExpiresAt`bắt buộc	string

MeUser

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

Trường	Kiểu	Mô tả
`email`bắt buộc	string
`emailVerification`bắt buộc	EmailVerificationDto	The e-mail verification gate (owner decision 3 Oct 2026).
`emailVerified`bắt buộc	boolean
`fullName`	string \| null
`id`bắt buộc	string (uuid)
`locale`bắt buộc	string

MemberDto

A membership with its person (MemberDto).

Trường	Kiểu	Mô tả
`createdAt`bắt buộc	string
`email`bắt buộc	string
`emailVerified`bắt buộc	boolean
`fullName`	string \| null
`id`bắt buộc	string (uuid)
`invitation`	MemberInvitationDto \| null
`isTracked`bắt buộc	boolean
`joinedAt`	string \| null
`locale`bắt buộc	string
`role`bắt buộc	string	`owner`, `admin`, `team_admin`, `manager`, `employee`.
`status`bắt buộc	string	`invited`, `active`, `suspended`, `left`.
`teamId`	string (uuid) \| null
`teamName`	string \| null
`timeZone`	string \| null
`unassignedManager`bắt buộc	boolean	A Manager with neither a team nor viewer teams (sees the whole company until assigned).
`userId`bắt buộc	string (uuid)
`viewerTeamIds`bắt buộc	string (uuid)[]

MemberInvitationDto

The invitation of an invited member.

Trường	Kiểu	Mô tả
`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`bắt buộc	string
`id`bắt buộc	string (uuid)
`lastSentAt`bắt buộc	string
`sentCount`bắt buộc	integer (int32)

MemberPage

A page of members (OpenAPI).

Trường	Kiểu	Mô tả
`items`bắt buộc	MemberDto[]
`nextCursor`	string \| null

MemberRefDto

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

Trường	Kiểu	Mô tả
`active`bắt buộc	boolean	The membership is active and (for an endpoint or a tenant connection) still an Owner or Admin.
`name`	string \| null
`userId`bắt buộc	string (uuid)

NamedRefDto

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

Trường	Kiểu	Mô tả
`id`bắt buộc	string (uuid)
`name`bắt buộc	string

OrganizationChoice

One organization of the person (sec.user_memberships).

Trường	Kiểu	Mô tả
`current`bắt buộc	boolean
`id`bắt buộc	string (uuid)
`name`bắt buộc	string
`role`bắt buộc	string
`selectable`bắt buộc	boolean	Can this session's sign-in method open it (design §4.5.3)?

PatchMember

PATCH /v1/members/{id}.

Trường	Kiểu	Mô tả
`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}.

Trường	Kiểu	Mô tả
`description`	string \| null
`name`	string \| null

PeriodReportDto

GET /v1/reports/productivity.

Trường	Kiểu	Mô tả
`from`bắt buộc	string (date)
`groupBy`bắt buộc	string
`levelContext`bắt buộc	LevelContextDto
`periods`bắt buộc	ReportPeriodDto[]
`subject`bắt buộc	ReportSubjectDto
`teams`bắt buộc	TeamPeriodsDto[]	Only for the company subject: every visible team over its current members.
`to`bắt buộc	string (date)
`totals`bắt buộc	ReportFiguresDto

PlanAbsenceDto

Trường	Kiểu	Mô tả
`color`bắt buộc	string
`countsAsWorked`bắt buộc	boolean	`timeEffect == worked`.
`endTime`	string \| null
`half`	string \| null
`id`bắt buộc	string (uuid)
`startTime`	string \| null	Local start and end of an `hours` absence.
`status`bắt buộc	string	`approved` or `pending`.
`timeEffect`bắt buộc	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`bắt buộc	string	`days`, `half_day` or `hours`.

PlanShiftDto

Trường	Kiểu	Mô tả
`color`	string \| null
`end`bắt buộc	string (date-time)
`endTime`bắt buộc	string	Local end; before the start for a night shift.
`id`bắt buộc	string (uuid)
`location`bắt buộc	string
`minMinutes`bắt buộc	integer (int32)
`start`bắt buộc	string (date-time)
`startTime`bắt buộc	string	Local start (`HH:mm`, the shift's zone).

Problem

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

Trường	Kiểu	Mô tả
`action`	string \| null	Permission key of a 403 (`teams.create`).
`code`bắt buộc	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`bắt buộc	integer (int32)
`title`bắt buộc	string	English title of the code (clients translate `code`).
`traceId`	string \| null	W3C trace id of the request.
`type`bắt buộc	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).

Trường	Kiểu	Mô tả
`billableMinor`bắt buộc	integer (int64)	The billable hours at their rate.
`costMinor`bắt buộc	integer (int64)	Every allocated hour at its rate.
`currency`bắt buộc	string

ProjectBudgetUsageDto

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

Trường	Kiểu	Mô tả
`budgetMinor`	integer (int64) \| null	`null` unless `costsIncluded`.
`budgetMinutes`	integer (int64) \| null
`kind`bắt buộc	string	`hours` or `amount`.
`projectId`bắt buộc	string (uuid)
`usedMinor`	integer (int64) \| null	The cost in the project's currency; `null` unless `costsIncluded`.
`usedMs`bắt buộc	integer (int64)
`usedRatio`	string \| null	Used / budget, 4 decimals (`null` for an amount budget without `costsIncluded`).

ProjectDto

A project.

Trường	Kiểu	Mô tả
`access`bắt buộc	string	`everyone` or `members`.
`archived`bắt buộc	boolean
`budget`	BudgetDto \| null
`client`	NamedRefDto \| null
`code`	string \| null
`color`	string \| null
`createdAt`bắt buộc	string (date-time)
`currency`bắt buộc	string	The currency of the project's rates and amount budget.
`description`	string \| null
`endDate`	string (date) \| null
`id`bắt buộc	string (uuid)
`isBillable`bắt buộc	boolean
`memberCount`bắt buộc	integer (int64)
`myRole`	string \| null	The caller's role in the project team (`member`, `manager`), `null` outside it.
`name`bắt buộc	string
`permissions`bắt buộc	ProjectPermissionsDto
`spentMs`bắt buộc	integer (int64)	Every allocation of the project, all time.
`startDate`	string (date) \| null
`status`bắt buộc	string	`active`, `on_hold` or `completed`.
`taskCount`bắt buộc	integer (int64)
`updatedAt`bắt buộc	string (date-time)

ProjectPage

GET /v1/projects.

Trường	Kiểu	Mô tả
`items`bắt buộc	ProjectDto[]
`nextCursor`	string \| null

ProjectPermissionsDto

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

Trường	Kiểu	Mô tả
`archive`bắt buộc	boolean
`delete`bắt buộc	boolean	Only a project without time.
`edit`bắt buộc	boolean	The project's fields (Owners and Admins).
`manageMembers`bắt buộc	boolean	The team (an Admin or the project's manager; only an Admin changes managers).
`manageTasks`bắt buộc	boolean	Tasks (an Admin or the project's manager).
`track`bắt buộc	boolean	The caller may track time on it now.

ProjectRefDto

A project reference of an allocation.

Trường	Kiểu	Mô tả
`color`	string \| null	`#RRGGBB`.
`id`bắt buộc	string (uuid)
`name`bắt buộc	string

ProjectReportDto

GET /v1/reports/projects.

Trường	Kiểu	Mô tả
`budgets`bắt buộc	ProjectBudgetUsageDto[]
`costsIncluded`bắt buộc	boolean	The caller sees rates and amounts (`projects.costs.read`).
`from`bắt buộc	string (date)
`groupBy`bắt buộc	string[]
`rows`bắt buộc	ProjectReportRowDto[]
`to`bắt buộc	string (date)
`totals`bắt buộc	ProjectReportTotalsDto

ProjectReportKeysDto

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

Trường	Kiểu	Mô tả
`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.

Trường	Kiểu	Mô tả
`allocatedMs`bắt buộc	integer (int64)
`amounts`	ProjectAmountDto[] \| null	`null` unless `costsIncluded`.
`billableMs`bắt buộc	integer (int64)
`keys`bắt buộc	ProjectReportKeysDto
`nonBillableMs`bắt buộc	integer (int64)
`productiveMs`	integer (int64) \| null	With `includeProductive` only.
`unratedMs`bắt buộc	integer (int64)	Time without any rate (it is left out of the amounts).

ProjectReportTotalsDto

The totals of the report.

Trường	Kiểu	Mô tả
`allocatedMs`bắt buộc	integer (int64)
`amounts`	ProjectAmountDto[] \| null
`billableMs`bắt buộc	integer (int64)
`nonBillableMs`bắt buộc	integer (int64)
`productiveMs`	integer (int64) \| null
`unratedMs`bắt buộc	integer (int64)

ProjectRequest

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

Trường	Kiểu	Mô tả
`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).

Trường	Kiểu	Mô tả
`absenceCreditMs`bắt buộc	integer (int64)
`absentDays`bắt buộc	integer (int32)
`activeMs`bắt buộc	integer (int64)
`activeUserCount`bắt buộc	integer (int32)
`effectivenessPct`	number (double) \| null
`idleMs`bắt buộc	integer (int64)
`lateDays`bắt buộc	integer (int32)
`leaveDays`bắt buộc	number (double)
`leftEarlyDays`bắt buộc	integer (int32)
`neutralMs`bắt buộc	integer (int64)
`offlineMs`bắt buộc	integer (int64)
`overtimeDays`bắt buộc	integer (int32)
`overtimeMs`bắt buộc	integer (int64)
`productiveMs`bắt buộc	integer (int64)
`productivityPct`	number (double) \| null
`targetMs`bắt buộc	integer (int64)
`unproductiveMs`bắt buộc	integer (int64)
`userCount`bắt buộc	integer (int32)
`workedMs`bắt buộc	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).

Trường	Kiểu	Mô tả
`kind`bắt buộc	string	`company`, `teams` or `self`.
`teamIds`bắt buộc	string (uuid)[]	The visible teams of a `teams` scope, sorted; empty otherwise (company = all).
`unassignedFallback`bắt buộc	boolean	A Manager without teams who sees the whole company until assigned.

ReportSubjectDto

Whom a report is about.

Trường	Kiểu	Mô tả
`id`	string (uuid) \| null
`kind`bắt buộc	string	`company`, `team` or `user`.
`name`	string \| null

RotatedWebhookSecretDto

RotatedWebhookSecretDto: the new signing secret, shown once.

Trường	Kiểu	Mô tả
`previousSecretExpiresAt`bắt buộc	string	Until then deliveries carry both signatures.
`secret`bắt buộc	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.

Trường	Kiểu	Mô tả
`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.

Trường	Kiểu	Mô tả
`breakMinutes`bắt buộc	integer (int32)
`color`	string \| null
`createdAt`bắt buộc	string (date-time)
`createdBy`bắt buộc	CalendarUserRefDto
`crossesMidnight`bắt buộc	boolean
`date`bắt buộc	string (date)
`durationMinutes`bắt buộc	integer (int32)
`end`bắt buộc	string (date-time)
`endTime`bắt buộc	string
`id`bắt buộc	string (uuid)
`location`bắt buộc	string
`minMinutes`bắt buộc	integer (int32)
`note`	string \| null
`open`bắt buộc	boolean	No user assigned.
`permissions`bắt buộc	ShiftPermissionsDto
`source`bắt buộc	string	`manual`, `template`, `copy` or `request`.
`start`bắt buộc	string (date-time)
`startTime`bắt buộc	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`bắt buộc	string
`updatedAt`bắt buộc	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).

Trường	Kiểu	Mô tả
`items`bắt buộc	ShiftDto[]

ShiftPermissionsDto

Trường	Kiểu	Mô tả
`canDelete`bắt buộc	boolean
`canEdit`bắt buộc	boolean
`canPickUp`bắt buộc	boolean
`canRequestSwap`bắt buộc	boolean

SummaryDto

The summary of the visible users over a range.

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

TargetItemDto

Trường	Kiểu	Mô tả
`activeMs`bắt buộc	integer (int64)
`categoryKey`	string \| null
`categorySource`bắt buộc	string	`tenant`, `builtin` or `none`.
`domain`	string \| null
`level`bắt buộc	string
`levelSource`bắt buộc	string	`team`, `company` or `default`.
`matchedKey`	string \| null
`name`bắt buộc	string
`percentage`bắt buộc	number (double)
`targetKey`bắt buộc	string
`targetType`bắt buộc	string	`app` for apps, `domain` for domains and hosts.
`userCount`bắt buộc	integer (int32)

TargetListDto

The "Apps & URLs" list.

Trường	Kiểu	Mô tả
`from`bắt buộc	string (date)
`items`bắt buộc	TargetItemDto[]	By active time descending, then key.
`levelContext`bắt buộc	LevelContextDto
`nextCursor`	string \| null
`to`bắt buộc	string (date)
`total`bắt buộc	integer (int32)	Targets matching the filters (before paging).
`totalActiveMs`bắt buộc	integer (int64)	Active time over every target of the type before the filters (the percentage base).
`type`bắt buộc	string	`app`, `domain` or `host`.

TaskDto

A task.

Trường	Kiểu	Mô tả
`archived`bắt buộc	boolean
`assignee`	NamedRefDto \| null
`createdAt`bắt buộc	string (date-time)
`description`	string \| null
`dueDate`	string (date) \| null
`effectiveBillable`bắt buộc	boolean
`estimateMinutes`	integer (int64) \| null
`id`bắt buộc	string (uuid)
`isBillable`	boolean \| null	`null` takes the project's value.
`name`bắt buộc	string
`permissions`bắt buộc	TaskPermissionsDto
`projectId`bắt buộc	string (uuid)
`sortOrder`bắt buộc	integer (int64)
`spentMs`bắt buộc	integer (int64)
`status`bắt buộc	string	`open`, `in_progress` or `done`.
`updatedAt`bắt buộc	string (date-time)

TaskPage

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

Trường	Kiểu	Mô tả
`items`bắt buộc	TaskDto[]
`nextCursor`	string \| null

TaskPermissionsDto

What the caller may do with a task.

Trường	Kiểu	Mô tả
`delete`bắt buộc	boolean	Only a task without time.
`edit`bắt buộc	boolean

TaskRequest

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

Trường	Kiểu	Mô tả
`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).

Trường	Kiểu	Mô tả
`archivedAt`	string \| null
`createdAt`bắt buộc	string
`description`	string \| null
`id`bắt buộc	string (uuid)
`leads`bắt buộc	object[]	TeamAdmins and Managers of the team: `[{membershipId, userId, fullName, role}]`.
`memberCount`bắt buộc	integer (int64)	Members whose primary team this is (left members excluded).
`name`bắt buộc	string
`updatedAt`bắt buộc	string

TeamPage

A page of teams (OpenAPI).

Trường	Kiểu	Mô tả
`items`bắt buộc	TeamDto[]
`nextCursor`	string \| null

TeamPeriodsDto

Trường	Kiểu	Mô tả
`periods`bắt buộc	ReportPeriodDto[]
`teamId`bắt buộc	string (uuid)
`teamName`	string \| null
`totals`bắt buộc	ReportFiguresDto

TeamTotalDto

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

Trường	Kiểu	Mô tả
`absenceCreditMs`bắt buộc	integer (int64)
`absentDays`bắt buộc	integer (int32)
`activeMs`bắt buộc	integer (int64)
`activeUserCount`bắt buộc	integer (int32)
`effectivenessPct`	number (double) \| null
`holidayDays`bắt buộc	number (double)
`idleMs`bắt buộc	integer (int64)
`lateDays`bắt buộc	integer (int32)
`leaveDays`bắt buộc	number (double)
`leftEarlyDays`bắt buộc	integer (int32)
`memberCount`bắt buộc	integer (int32)
`neutralMs`bắt buộc	integer (int64)
`offlineMs`bắt buộc	integer (int64)
`overtimeMs`bắt buộc	integer (int64)
`productiveMs`bắt buộc	integer (int64)
`productivityPct`	number (double) \| null
`shiftDays`bắt buộc	integer (int32)
`teamId`	string (uuid) \| null	`null` for the users without a team.
`teamName`	string \| null
`unproductiveMs`bắt buộc	integer (int64)
`workedMs`bắt buộc	integer (int64)

TimeEntryDecisionRequest

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

Trường	Kiểu	Mô tả
`decision`	string \| null	`approve` or `reject`.
`note`	string \| null	At most 500 characters.

TimeEntryDto

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

Trường	Kiểu	Mô tả
`createdAt`bắt buộc	string (date-time)
`createdBy`bắt buộc	TimeEntryUserRefDto
`date`bắt buộc	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`bắt buộc	integer (int64)
`end`bắt buộc	string (date-time)
`id`bắt buộc	string (uuid)
`kind`bắt buộc	string	`offline` or `deletion`.
`level`	string \| null	Offline: `productive`, `neutral` or `unproductive`; deletion: `null`.
`permissions`bắt buộc	TimeEntryPermissionsDto
`projectId`	string (uuid) \| null	Always `null` until projects (Phase 6).
`source`bắt buộc	string	`manual` (Phase 8 adds `calendar`).
`start`bắt buộc	string (date-time)
`status`bắt buộc	string	`pending`, `approved` or `rejected`.
`timeZone`bắt buộc	string
`updatedAt`bắt buộc	string (date-time)
`userId`bắt buộc	string (uuid)

TimeEntryPage

GET /v1/time-entries: by start.

Trường	Kiểu	Mô tả
`items`bắt buộc	TimeEntryDto[]
`nextCursor`	string \| null

TimeEntryPermissionsDto

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

Trường	Kiểu	Mô tả
`canApprove`bắt buộc	boolean
`canDelete`bắt buộc	boolean
`canEdit`bắt buộc	boolean

TimeEntryUserRefDto

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

Trường	Kiểu	Mô tả
`fullName`	string \| null
`id`bắt buộc	string (uuid)

TimeIntervalDto

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

Trường	Kiểu	Mô tả
`end`bắt buộc	string (date-time)
`start`bắt buộc	string (date-time)

TimerAtRequest

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

Trường	Kiểu	Mô tả
`at`	string (date-time) \| null

TimerCommandResultDto

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

Trường	Kiểu	Mô tả
`applied`bắt buộc	boolean
`closed`bắt buộc	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`bắt buộc	TimerDto

TimerDto

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

Trường	Kiểu	Mô tả
`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`bắt buộc	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`bắt buộc	string	`running` or `stopped`.
`task`	NamedRefDto \| null

TimerLastDto

The segment that ended last.

Trường	Kiểu	Mô tả
`endReason`bắt buộc	string	`stop`, `switch`, `autostop` or `discard`.
`endedAt`bắt buộc	string (date-time)
`segmentId`bắt buộc	string (uuid)
`startedAt`bắt buộc	string (date-time)

TimerProjectDto

The project of the running segment.

Trường	Kiểu	Mô tả
`clientName`	string \| null
`color`	string \| null
`id`bắt buộc	string (uuid)
`name`bắt buộc	string

TimerStartRequest

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

Trường	Kiểu	Mô tả
`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).

Trường	Kiểu	Mô tả
`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).

Trường	Kiểu	Mô tả
`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.

Trường	Kiểu	Mô tả
`days`bắt buộc	UserDayDto[]
`from`bắt buộc	string (date)
`teamId`	string (uuid) \| null	The user's current primary team (its rules classify every day).
`timeZone`bắt buộc	string
`to`bắt buộc	string (date)
`userId`bắt buộc	string (uuid)

UserDayDto

Trường	Kiểu	Mô tả
`absence`	DayAbsenceDto \| null
`absenceCreditMs`bắt buộc	integer (int64)
`activeMs`bắt buộc	integer (int64)
`afkCoverage`bắt buộc	boolean
`arrivalAt`	string (date-time) \| null
`atWorkMs`bắt buộc	integer (int64)
`attendanceStatus`	string \| null	`onTime`, `late`, `absent`, `notStarted`, `dayOff`, `onLeave`, `holiday`; `null` outside the directory.
`classified`bắt buộc	boolean
`date`bắt buộc	string (date)
`dayOffWorkedMs`bắt buộc	integer (int64)
`deletedMs`bắt buộc	integer (int64)
`effectivenessPct`	number (double) \| null
`eventCount`bắt buộc	integer (int64)
`expectedWorkMs`bắt buộc	integer (int64)
`holiday`	DailyHolidayDto \| null
`idleMs`bắt buộc	integer (int64)
`lateByMs`bắt buộc	integer (int64)
`leftAt`	string (date-time) \| null
`leftEarly`bắt buộc	boolean
`leftEarlyByMs`bắt buộc	integer (int64)
`meetingMs`bắt buộc	integer (int64)
`neutralMs`bắt buộc	integer (int64)
`offlineMs`bắt buộc	integer (int64)
`overtimeMs`bắt buộc	integer (int64)
`planKind`	string \| null	`schedule`, `shift`, `dayOff` or `holiday`.
`privateMs`bắt buộc	integer (int64)
`productiveMs`bắt buộc	integer (int64)
`productivityPct`	number (double) \| null
`shiftCount`bắt buộc	integer (int32)
`targetMs`bắt buộc	integer (int64)
`topApp`	string \| null	Display name of the app with the most active time.
`unproductiveMs`bắt buộc	integer (int64)
`workday`	boolean \| null
`workedMs`bắt buộc	integer (int64)

UserTotalDto

One user of a summary.

Trường	Kiểu	Mô tả
`absenceCreditMs`bắt buộc	integer (int64)
`absentDays`	integer (int32) \| null	Only for tracked users.
`activeDays`bắt buộc	integer (int32)	Local days with active time.
`activeMs`bắt buộc	integer (int64)
`arrivalAt`	string (date-time) \| null	Earliest arrival and latest leave in the range.
`atWorkMs`bắt buộc	integer (int64)
`classifiedDays`bắt buộc	integer (int32)
`dayOffWorkedMs`bắt buộc	integer (int64)
`deletedMs`bắt buộc	integer (int64)
`effectivenessPct`	number (double) \| null	`null` without a target and for users missing from the directory.
`email`	string \| null
`eventCount`bắt buộc	integer (int64)
`fullName`	string \| null
`holidayDays`bắt buộc	number (double)
`idleMs`bắt buộc	integer (int64)
`lateDays`	integer (int32) \| null
`leaveDays`bắt buộc	number (double)
`leftAt`	string (date-time) \| null
`leftEarlyDays`	integer (int32) \| null
`meetingMs`bắt buộc	integer (int64)
`neutralMs`bắt buộc	integer (int64)
`offlineMs`bắt buộc	integer (int64)
`overtimeDays`bắt buộc	integer (int32)
`overtimeMs`bắt buộc	integer (int64)
`privateMs`bắt buộc	integer (int64)
`productiveMs`bắt buộc	integer (int64)
`productivityPct`	number (double) \| null
`shiftDays`bắt buộc	integer (int32)
`targetMs`	integer (int64) \| null
`teamId`	string (uuid) \| null
`teamName`	string \| null
`timeZone`bắt buộc	string
`unproductiveMs`bắt buộc	integer (int64)
`userId`bắt buộc	string (uuid)
`workdays`	integer (int32) \| null
`workedMs`bắt buộc	integer (int64)

WebhookDeliveryDetailDto

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

WebhookDeliveryDto

WebhookDeliveryDto.

Trường	Kiểu	Mô tả
`attempts`bắt buộc	integer (int32)
`createdAt`bắt buộc	string
`deliveredAt`	string \| null
`eventId`bắt buộc	string (uuid)	The `webhook-id` header.
`eventType`bắt buộc	string
`id`bắt buộc	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`bắt buộc	string	`pending`, `succeeded`, `failed`, `dead`.

WebhookDeliveryPage

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

Trường	Kiểu	Mô tả
`items`bắt buộc	WebhookDeliveryDto[]
`nextCursor`	string \| null

WebhookEndpointDto

WebhookEndpointDto.

Trường	Kiểu	Mô tả
`createdAt`bắt buộc	string
`description`	string \| null
`eventTypes`bắt buộc	string[]
`id`bắt buộc	string (uuid)
`owner`bắt buộc	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`bắt buộc	string	The first 8 characters of the signing secret (`whsec_Kx`); never the secret.
`stats`bắt buộc	WebhookEndpointStatsDto
`status`bắt buộc	string	`active`, `paused`, `disabled`.
`statusReason`	string \| null	`manual`, `owner_inactive`, `failing`, `gone`; `null` while active.
`updatedAt`bắt buộc	string
`url`bắt buộc	string
`version`bắt buộc	integer (int64)	`row_version` (`ETag: "v<n>"`, `If-Match` of `PATCH`).

WebhookEndpointPage

GET /v1/webhook-endpoints.

Trường	Kiểu	Mô tả
`items`bắt buộc	WebhookEndpointDto[]
`nextCursor`	string \| null

WebhookEndpointStatsDto

The delivery statistics of an endpoint.

Trường	Kiểu	Mô tả
`consecutiveFailures`bắt buộc	integer (int32)
`lastFailureAt`	string \| null
`lastSuccessAt`	string \| null

WebhookEventDto

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

Trường	Kiểu	Mô tả
`available`bắt buộc	boolean	The tenant's plan has the feature: an endpoint may subscribe.
`description`bắt buộc	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`bắt buộc	string	The `data.object` of the delivery body.
`type`bắt buộc	string	`<object>.<verb>`, e.g. `time_entry.approved`.

WebhookEventsDto

GET /v1/webhook-events.

Trường	Kiểu	Mô tả
`items`bắt buộc	WebhookEventDto[]

WebhookTestDto

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

Trường	Kiểu	Mô tả
`deliveryId`bắt buộc	string	The delivery of the test event (a string: the deliveries' id is a 64-bit integer).

Tài liệu tham chiếu API công khai

Xác thực

Phạm vi quyền

Giới hạn tần suất

Lỗi

Webhook

Thao tác

Vắng mặt

GET /v1/absences Phạm vi: reports:read

Tham số

POST /v1/absences Phạm vi: time:write

Tham số

POST /v1/absences/{id}/decision Phạm vi: time:write

Tham số

Hoạt động

GET /v1/activity/day Phạm vi: reports:read

Tham số

Phân bổ thời gian

GET /v1/allocations Phạm vi: reports:read

Tham số

POST /v1/allocations Phạm vi: time:write

Tham số

Bản xuất

POST /v1/exports Phạm vi: reports:read

Tham số

GET /v1/exports/{id} Phạm vi: reports:read

Tham số

Tôi

GET /v1/me Phạm vi: me

Thành viên

POST /v1/invitations Phạm vi: org:admin

Tham số

GET /v1/members Phạm vi: org:admin

Tham số

GET /v1/members/{id} Phạm vi: org:admin

Tham số

PATCH /v1/members/{id} Phạm vi: org:admin

Tham số

POST /v1/members/{id}/reactivate Phạm vi: org:admin

Tham số

POST /v1/members/{id}/suspend Phạm vi: org:admin

Tham số

Dự án

GET /v1/projects Phạm vi: reports:read

Tham số

POST /v1/projects Phạm vi: org:admin

Tham số

GET /v1/projects/{id} Phạm vi: reports:read

Tham số

PUT /v1/projects/{id} Phạm vi: org:admin

Tham số

Báo cáo

GET /v1/reports/productivity Phạm vi: reports:read

Tham số

GET /v1/reports/projects Phạm vi: reports:read

Tham số

GET /v1/reports/summary Phạm vi: reports:read

Tham số

GET /v1/reports/targets Phạm vi: reports:read

Tham số

GET /v1/reports/users/{userId}/daily Phạm vi: reports:read

Tham số

Ca làm việc

GET /v1/shifts Phạm vi: reports:read

Tham số

POST /v1/shifts Phạm vi: time:write

Tham số

Công việc

GET /v1/projects/{id}/tasks Phạm vi: reports:read

Tham số

POST /v1/projects/{id}/tasks Phạm vi: time:write

Tham số

GET /v1/tasks/{id} Phạm vi: reports:read

Tham số

PUT /v1/tasks/{id} Phạm vi: time:write

Tham số

Nhóm

GET /v1/teams Phạm vi: reports:read

Tham số

POST /v1/teams Phạm vi: org:admin

GET `/v1/absences` Phạm vi: `reports:read`

POST `/v1/absences` Phạm vi: `time:write`

POST `/v1/absences/{id}/decision` Phạm vi: `time:write`

GET `/v1/activity/day` Phạm vi: `reports:read`

GET `/v1/allocations` Phạm vi: `reports:read`

POST `/v1/allocations` Phạm vi: `time:write`

POST `/v1/exports` Phạm vi: `reports:read`

GET `/v1/exports/{id}` Phạm vi: `reports:read`

GET `/v1/me` Phạm vi: `me`

POST `/v1/invitations` Phạm vi: `org:admin`

GET `/v1/members` Phạm vi: `org:admin`

GET `/v1/members/{id}` Phạm vi: `org:admin`

PATCH `/v1/members/{id}` Phạm vi: `org:admin`

POST `/v1/members/{id}/reactivate` Phạm vi: `org:admin`

POST `/v1/members/{id}/suspend` Phạm vi: `org:admin`

GET `/v1/projects` Phạm vi: `reports:read`

POST `/v1/projects` Phạm vi: `org:admin`

GET `/v1/projects/{id}` Phạm vi: `reports:read`

PUT `/v1/projects/{id}` Phạm vi: `org:admin`

GET `/v1/reports/productivity` Phạm vi: `reports:read`

GET `/v1/reports/projects` Phạm vi: `reports:read`

GET `/v1/reports/summary` Phạm vi: `reports:read`

GET `/v1/reports/targets` Phạm vi: `reports:read`

GET `/v1/reports/users/{userId}/daily` Phạm vi: `reports:read`

GET `/v1/shifts` Phạm vi: `reports:read`

POST `/v1/shifts` Phạm vi: `time:write`

GET `/v1/projects/{id}/tasks` Phạm vi: `reports:read`

POST `/v1/projects/{id}/tasks` Phạm vi: `time:write`

GET `/v1/tasks/{id}` Phạm vi: `reports:read`

PUT `/v1/tasks/{id}` Phạm vi: `time:write`

GET `/v1/teams` Phạm vi: `reports:read`

POST `/v1/teams` Phạm vi: `org:admin`

PATCH `/v1/teams/{id}` Phạm vi: `org:admin`

GET `/v1/time-entries` Phạm vi: `reports:read`

POST `/v1/time-entries` Phạm vi: `time:write`

GET `/v1/time-entries/{id}` Phạm vi: `reports:read`

PUT `/v1/time-entries/{id}` Phạm vi: `time:write`

DELETE `/v1/time-entries/{id}` Phạm vi: `time:write`

POST `/v1/time-entries/{id}/decision` Phạm vi: `time:write`

GET `/v1/me/timer` Phạm vi: `me`

POST `/v1/me/timer/start` Phạm vi: `me`

POST `/v1/me/timer/stop` Phạm vi: `me`

GET `/v1/webhook-endpoints` Phạm vi: `webhooks:manage`

POST `/v1/webhook-endpoints` Phạm vi: `webhooks:manage`

GET `/v1/webhook-endpoints/{id}` Phạm vi: `webhooks:manage`

PATCH `/v1/webhook-endpoints/{id}` Phạm vi: `webhooks:manage`

DELETE `/v1/webhook-endpoints/{id}` Phạm vi: `webhooks:manage`

GET `/v1/webhook-endpoints/{id}/deliveries` Phạm vi: `webhooks:manage`

GET `/v1/webhook-endpoints/{id}/deliveries/{deliveryId}` Phạm vi: `webhooks:manage`

POST `/v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retry` Phạm vi: `webhooks:manage`

POST `/v1/webhook-endpoints/{id}/rotate-secret` Phạm vi: `webhooks:manage`

POST `/v1/webhook-endpoints/{id}/test` Phạm vi: `webhooks:manage`

GET `/v1/webhook-events` Phạm vi: `webhooks:manage`