Genel API referansı

Workify360 Focus genel API'si kendi betiklerinizin ve araçlarınızın raporları ve zaman verilerini okumasını ve panelle aynı kurallarla değişiklik yapmasını sağlar. Genel API, API anahtarları ve webhook'lar Premium paketin parçasıdır.

Bu sayfadaki işlemler geriye uyumlu tutulur. Aynı işlemlerin makinece okunabilir OpenAPI belgesi:

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

API sözleşmesinin 0.1.0 sürümünden (c95fb97bb49a) üretildi.

Kimlik doğrulama

Her istekte Authorization başlığında kişisel bir API anahtarı gönderin. Anahtar onu oluşturan kişiye aittir, o kişi olarak çalışır ve kişinin güncel rolünün izin verdiğinden fazlasını asla yapmaz. Anahtarı eksik, yanlış, süresi dolmuş ya da iptal edilmiş istek unauthorized koduyla 401 alır.

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

Anahtar oluşturma, kapsam seçme ve iptal etme: API anahtarları ve genel API

Kapsamlar

Her işlem yanında gösterilen tek bir kapsam ister. Anahtar bu kapsamı taşıyorsa ve sahibinin güncel rolü, takımları ve paketi isteğe, panelde olduğu gibi, izin veriyorsa işleme erişir.

Kapsam	Neye izin verir
`me`	Kendi profiliniz ve zamanlayıcınız
`reports:read`	Raporları, zaman kayıtlarını, devamsızlıkları, vardiyaları, takımları, projeleri, görevleri ve dışa aktarmaları okuma
`time:write`	Zaman kayıtları, devamsızlıklar, vardiyalar, görevler ve görevlere atanan süre eklemek ve değiştirmek, talepleri karara bağlamak
`org:admin`	Üyeleri, takımları, davetleri ve projeleri yönetmek
`webhooks:manage`	Webhook uçlarını yönetmek

İstek sınırları

Her anahtar dakikada 600, bir organizasyon bütün anahtarlarıyla birlikte dakikada 1.800 birim gönderebilir. Bir şeyi değiştiren istek (GET ve HEAD dışındaki her şey) iki birim, diğer her istek bir birim sayılır. Bir anahtar ayrıca bir seferde en çok 60 birim gönderebilir; bu hak saniyede 10 birim dolar: art arda 60'tan fazla okuma (ya da 30'dan fazla değişiklik) dakikada 600'ün altında kalsa da 429 alır.

Başlık	Anlamı
`RateLimit: "key";r=598;t=2`	Sayılan her yanıtta: anahtarın kalan hakkı ve hakkın yeniden dolmasına kalan saniye
`RateLimit-Policy: "key";q=600;w=60, "tenant";q=1800;w=60`	Sayılan her yanıtta: anahtarın ve organizasyonun dakikalık sınırları
`Retry-After: 12`	429 ile (`rate_limited` kodu): sonraki istekten önce beklenecek saniye

Hatalar

Hata bir RFC 9457 sorun belgesidir (Content-Type: application/problem+json). code, programınızda kullanacağınız kalıcı, snake_case bir koddur; title kayıtlar için İngilizce bir metindir. type kodun yardım adresidir: her _ yerine - yazılmış https://workify360.com/help/errors/<kod>/ adresi, kodun bir yardım makalesi varsa onu açar.

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

Bazı sorunlar başka alanlar da taşır: errors (422 validation_failed için alan hataları), action (403 forbidden yanıtının ilgili olduğu izin), requiredPlan (402 feature_not_in_plan), retryAfterSeconds (429 ve 503) ve traceId (destekle iletişime geçerken bunu belirtin).

Durum	Kod	Ne zaman
400	`invalid_request`	Bir parametre bozuk ya da eksik
401	`unauthorized`	Anahtar eksik, yanlış, süresi dolmuş ya da iptal edilmiş veya sahibi organizasyondan ayrılmış
402	`feature_not_in_plan`, `subscription_read_only`	Paket bu özelliği içermiyor ya da abonelik salt okunur
403	`forbidden`, `feature_not_enabled`	Anahtarda kapsam yok ya da sahibinin güncel rolü, takımları veya ayarlar isteğe izin vermiyor
412	`version_conflict`	`If-Match` sürümü artık güncel değil; kaynağı yeniden okuyun
422	`validation_failed`	Gövde geçersiz; `errors` alanları listeler
428	`precondition_required`	İşlem, okuduğunuz sürümle bir `If-Match` başlığı ister
429	`rate_limited`	Çok fazla istek; `Retry-After` başlığındaki saniye kadar bekleyin

Yardım makalesi olan kodlar işlem listesinde bağlantıdır.

Webhook'lar

API'ye tekrar tekrar sormak yerine, bir şey değiştiğinde sizin bir ucunuz imzalı bir HTTPS isteği alabilir. Olaylar, istek biçimi, imzanın Node.js ve Python ile doğrulanması, yeniden denemeler ve sırrın yenilenmesi yardım makalesinde anlatılır: Webhook'lar

İşlemler

Alanlara göre gruplanmıştır. İşlem özetleri ve alan açıklamaları API sözleşmesinden İngilizce gelir.

Devamsızlıklar

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

List absences overlapping a range.

Parametreler

Ad	Yer	Tür	Açıklama
`from`	sorgu	string (date)
`to`	sorgu	string (date)	At most 366 days after `from`.
`userId`	sorgu	string (uuid)
`teamId`	sorgu	string (uuid)
`status`	sorgu	string
`typeId`	sorgu	string (uuid)
`cursor`	sorgu	string
`limit`	sorgu	integer (int32)

Yanıtlar

200 AbsencePage

Hatalar

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

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

Request (or record) an absence.

Parametreler

Ad	Yer	Tür	Açıklama
`Idempotency-Key`zorunlu	başlık	string	Required: the same key and body return the first answer

İstek gövdesi

AbsenceRequest

Yanıtlar

201 AbsenceDto

Hatalar

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Id
`If-Match`zorunlu	başlık	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

İstek gövdesi

CalendarDecisionRequest

Yanıtlar

200 AbsenceDto

Hatalar

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)

Etkinlik

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`date`	sorgu	string (date)	The user's local day (required).
`userId`	sorgu	string (uuid)	Default: the caller; another user must be visible (else 403).

Yanıtlar

200 ActivityDayDto

Hatalar

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

Süre atamaları

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

Parametreler

Ad	Yer	Tür	Açıklama
`userId`	sorgu	string (uuid)	Default: the caller.
`from`	sorgu	string (date)	Local date, included.
`to`	sorgu	string (date)	Local date, included; at most 93 days after `from`.
`projectId`	sorgu	string (uuid)
`cursor`	sorgu	string
`limit`	sorgu	integer (int32)	1–200 (default 200).

Yanıtlar

200 AllocationPage

Hatalar

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`Idempotency-Key`	başlık	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

İstek gövdesi

AllocationCreateRequest

Yanıtlar

201 AllocationCreatedDto

Hatalar

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

Dışa aktarmalar

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`Idempotency-Key`zorunlu	başlık	string	Required: the same key and body return the first answer

İstek gövdesi

CreateExportRequest

Yanıtlar

202 ExportJobDto

Hatalar

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

One export job (poll every 2 s).

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Id

Yanıtlar

200 ExportJobDto

Hatalar

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

Ben

GET `/v1/me` Kapsam: `me`

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

Yanıtlar

200 MeDto

Hatalar

401 unauthorized

Üyeler

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

Invite a person.

Parametreler

Ad	Yer	Tür	Açıklama
`Idempotency-Key`zorunlu	başlık	string	Required: 1–255 printable ASCII characters

İstek gövdesi

CreateInvitation

Yanıtlar

201 InvitationResult

Hatalar

409 already_member
422 validation_failed, idempotency_key_reused

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

List members.

Parametreler

Ad	Yer	Tür	Açıklama
`status`	sorgu	string	Comma-separated statuses (default active,invited,suspended)
`teamId`	sorgu	string (uuid)	Primary team
`role`	sorgu	string	owner, admin, team_admin, manager or employee
`q`	sorgu	string	Part of the name or e-mail (Turkish case folding)
`cursor`	sorgu	string	Opaque cursor of the next page
`limit`	sorgu	integer (int32)	1–200, default 50

Yanıtlar

200 MemberPage

Hatalar

403 No right

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

One member.

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Membership id

Yanıtlar

200 MemberDto

Hatalar

404 member_not_found

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Membership id
`If-Match`zorunlu	başlık	string	ETag of the member ("v<n>")

İstek gövdesi

PatchMember

Yanıtlar

200 MemberDto

Hatalar

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

Reactivate a suspended member.

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Membership id

Yanıtlar: 200 MemberDto

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Membership id

Yanıtlar

200 MemberDto

Hatalar

409 conflict (an invitation is revoked instead)

Projeler

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

Parametreler

Ad	Yer	Tür	Açıklama
`status`	sorgu	string	`active`, `on_hold` or `completed`.
`clientId`	sorgu	string (uuid)
`q`	sorgu	string	Name or code search (case-insensitive).
`includeArchived`	sorgu	boolean
`mine`	sorgu	boolean	Only the projects the caller may track time on.
`cursor`	sorgu	string
`limit`	sorgu	integer (int32)	1–200 (default 50).

Yanıtlar

200 ProjectPage

Hatalar

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

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

Add a project (Owners and Admins).

Parametreler

Ad	Yer	Tür	Açıklama
`Idempotency-Key`	başlık	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

İstek gövdesi

ProjectRequest

Yanıtlar

201 ProjectDto

Hatalar

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

One project (invisible projects are 404).

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Project id

Yanıtlar

200 ProjectDto

Hatalar

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

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Project id
`If-Match`zorunlu	başlık	string	The ETag the caller read (412 version_conflict when it changed)

İstek gövdesi

ProjectRequest

Yanıtlar

200 ProjectDto

Hatalar

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)

Raporlar

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`from`	sorgu	string (date)
`to`	sorgu	string (date)	`day` 93 days, `week`, `month` and `range` 366.
`groupBy`	sorgu	string	`day`, `week`, `month` or `range`.
`teamId`	sorgu	string (uuid)
`userId`	sorgu	string (uuid)

Yanıtlar

200 PeriodReportDto

Hatalar

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

Parametreler

Ad	Yer	Tür	Açıklama
`from`	sorgu	string (date)	Local date, included.
`to`	sorgu	string (date)	Local date, included; at most 366 days after `from`.
`groupBy`	sorgu	string	One or two of `project` (default), `task`, `user`, `client`, `day`, comma separated.
`projectIds`	sorgu	string	Comma-separated project ids.
`clientId`	sorgu	string (uuid)
`userIds`	sorgu	string	Comma-separated user ids (visible people only).
`teamId`	sorgu	string (uuid)
`billable`	sorgu	string	`all` (default), `billable` or `nonBillable`.
`includeProductive`	sorgu	boolean	Also compute the productive time within the allocations (costly; default false).

Yanıtlar

200 ProjectReportDto

Hatalar

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

The summary of the visible users over a range.

Parametreler

Ad	Yer	Tür	Açıklama
`from`	sorgu	string (date)
`to`	sorgu	string (date)	At most 93 days after `from`.
`teamId`	sorgu	string (uuid)	Only the team's current members; the team must be visible (else 403).

Yanıtlar

200 SummaryDto

Hatalar

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`from`	sorgu	string (date)
`to`	sorgu	string (date)
`type`	sorgu	string	`app`, `domain` or `host`.
`teamId`	sorgu	string (uuid)
`userId`	sorgu	string (uuid)
`q`	sorgu	string	Search in the key and the name (.NET `search`).
`level`	sorgu	string	`productive`, `unproductive` or `neutral`.
`categoryKey`	sorgu	string
`unclassified`	sorgu	boolean	Only targets without a category.
`cursor`	sorgu	string
`limit`	sorgu	integer (int32)	1–200, default 50.

Yanıtlar

200 TargetListDto

Hatalar

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`userId`zorunlu	yol	string (uuid)	User
`from`	sorgu	string (date)
`to`	sorgu	string (date)	At most 93 days after `from`.

Yanıtlar

200 UserDailyDto

Hatalar

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

Vardiyalar

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

List the shifts starting in a range.

Parametreler

Ad	Yer	Tür	Açıklama
`from`	sorgu	string (date)
`to`	sorgu	string (date)
`teamId`	sorgu	string (uuid)
`userId`	sorgu	string (uuid)
`includeOpen`	sorgu	boolean	Also open shifts (default true).

Yanıtlar

200 ShiftListDto

Hatalar

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

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

Create a shift (assigned or open).

Parametreler

Ad	Yer	Tür	Açıklama
`Idempotency-Key`zorunlu	başlık	string	Required: the same key and body return the first answer

İstek gövdesi

ShiftBody

Yanıtlar

201 ShiftDto

Hatalar

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

Görevler

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

A visible project's tasks, by sort order.

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Project id
`status`	sorgu	string	`open`, `in_progress` or `done`.
`assigneeUserId`	sorgu	string (uuid)
`includeArchived`	sorgu	boolean
`cursor`	sorgu	string
`limit`	sorgu	integer (int32)	1–500 (default 200).

Yanıtlar

200 TaskPage

Hatalar

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Project id
`Idempotency-Key`	başlık	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

İstek gövdesi

TaskRequest

Yanıtlar

201 TaskDto

Hatalar

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

One task of a visible project.

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Task id

Yanıtlar

200 TaskDto

Hatalar

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

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

Change a task (the whole body).

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Task id
`If-Match`zorunlu	başlık	string	The ETag the caller read (412 version_conflict when it changed)

İstek gövdesi

TaskRequest

Yanıtlar

200 TaskDto

Hatalar

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)

Takımlar

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

List teams.

Parametreler

Ad	Yer	Tür	Açıklama
`includeArchived`	sorgu	boolean	Also archived teams (default false)
`cursor`	sorgu	string	Opaque cursor of the next page
`limit`	sorgu	integer (int32)	1–200, default 50

Yanıtlar: 200 TeamPage

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

Create a team (the G1 endpoint).

İstek gövdesi

CreateTeam

Yanıtlar

201 TeamDto

Hatalar

403 forbidden (action teams.create)
409 team_name_taken

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

Rename a team or change its description.

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Team id
`If-Match`zorunlu	başlık	string	ETag of the team

İstek gövdesi

PatchTeam

Yanıtlar

200 TeamDto

Hatalar

409 team_name_taken

Zaman kayıtları

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`userId`	sorgu	string (uuid)	Default: the caller.
`from`	sorgu	string (date)	The entry's local day, required.
`to`	sorgu	string (date)	At most 93 days after `from`.
`kind`	sorgu	string	`offline` or `deletion`.
`status`	sorgu	string	`pending`, `approved` or `rejected`.
`cursor`	sorgu	string
`limit`	sorgu	integer (int32)	1–500.

Yanıtlar

200 TimeEntryPage

Hatalar

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`Idempotency-Key`zorunlu	başlık	string	Required: the same key and body return the first answer

İstek gövdesi

CreateTimeEntryRequest

Yanıtlar

201 TimeEntryDto

Hatalar

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Entry id

Yanıtlar

200 TimeEntryDto

Hatalar

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

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

Replace an entry's editable fields.

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Entry id
`If-Match`zorunlu	başlık	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

İstek gövdesi

UpdateTimeEntryRequest

Yanıtlar

200 TimeEntryDto

Hatalar

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Entry id
`If-Match`zorunlu	başlık	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Yanıtlar

204 (gövde yok)

Hatalar

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	Entry id
`If-Match`zorunlu	başlık	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

İstek gövdesi

TimeEntryDecisionRequest

Yanıtlar

200 TimeEntryDto

Hatalar

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)

Zamanlayıcı

GET `/v1/me/timer` Kapsam: `me`

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

Parametreler

Ad	Yer	Tür	Açıklama
`If-None-Match`	başlık	string \| null	The ETag the caller holds (304 when unchanged)

Yanıtlar

200 TimerDto · 304 (gövde yok)

Hatalar

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

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`Idempotency-Key`	başlık	string \| null	The client's command id; a retry returns the first answer

İstek gövdesi

TimerStartRequest

Yanıtlar

200 TimerCommandResultDto

Hatalar

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`Idempotency-Key`	başlık	string \| null	The client's command id; a retry returns the first answer

İstek gövdesi

TimerAtRequest

Yanıtlar

200 TimerCommandResultDto

Hatalar

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'lar

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

The tenant's webhook endpoints.

Parametreler

Ad	Yer	Tür	Açıklama
`cursor`	sorgu	string
`limit`	sorgu	integer (int32)	1–200, default 50.

Yanıtlar

200 WebhookEndpointPage

Hatalar

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

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

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

İstek gövdesi

CreateWebhookEndpointRequest

Yanıtlar

201 CreatedWebhookEndpointDto

Hatalar

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

One webhook endpoint.

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	The endpoint

Yanıtlar

200 WebhookEndpointDto

Hatalar

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

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	The endpoint
`If-Match`zorunlu	başlık	string	The endpoint's ETag (`"v<n>"`)

İstek gövdesi

UpdateWebhookEndpointRequest

Yanıtlar

200 WebhookEndpointDto

Hatalar

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

Delete an endpoint and its deliveries.

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	The endpoint

Yanıtlar

204 (gövde yok)

Hatalar

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

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

The deliveries of an endpoint, newest first.

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	The endpoint
`status`	sorgu	string	`pending`, `succeeded`, `failed`, `dead`.
`eventType`	sorgu	string
`cursor`	sorgu	string	Opaque cursor of the next page.
`limit`	sorgu	integer (int32)	1–200, default 50.

Yanıtlar

200 WebhookDeliveryPage

Hatalar

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

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

One delivery with the body that was sent.

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	The endpoint
`deliveryId`zorunlu	yol	string	The delivery (a 64-bit integer)

Yanıtlar

200 WebhookDeliveryDetailDto

Hatalar

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	The endpoint
`deliveryId`zorunlu	yol	string	The delivery (a 64-bit integer)

Yanıtlar

202 AcceptedDto

Hatalar

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

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	The endpoint

Yanıtlar

200 RotatedWebhookSecretDto

Hatalar

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

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

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

Parametreler

Ad	Yer	Tür	Açıklama
`id`zorunlu	yol	string (uuid)	The endpoint

Yanıtlar

202 WebhookTestDto

Hatalar

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

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

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

Yanıtlar

200 WebhookEventsDto

Hatalar

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

Şemalar

İşlemlerin kullandığı istek ve yanıt gövdeleri. Zorunlu alanlar işaretlidir.

AbsenceDto

An absence.

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

AbsencePage

GET /v1/absences.

Alan	Tür	Açıklama
`items`zorunlu	AbsenceDto[]
`nextCursor`	string \| null

AbsencePermissionsDto

Alan	Tür	Açıklama
`canApprove`zorunlu	boolean
`canCancel`zorunlu	boolean
`canEdit`zorunlu	boolean

AbsenceRequest

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

Alan	Tür	Açıklama
`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.

Alan	Tür	Açıklama
`color`zorunlu	string
`countsAsWorked`zorunlu	boolean
`deductsFromBalance`zorunlu	boolean
`id`zorunlu	string (uuid)
`key`	string \| null
`name`zorunlu	string
`paid`zorunlu	boolean
`timeEffect`zorunlu	string

AcceptedDto

202 Accepted of a queued job.

Alan	Tür	Açıklama
`accepted`zorunlu	boolean	Always `true`.

AccessDto

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

Alan	Tür	Açıklama
`assignableRoles`zorunlu	string[]
`canManageCompanySettings`zorunlu	boolean
`canManageTeams`zorunlu	boolean
`canManageUsers`zorunlu	boolean
`manageTeamIds`zorunlu	string[]
`scope`zorunlu	string	`company`, `teams` or `self`.
`unassignedFallback`zorunlu	boolean
`viewTeamIds`zorunlu	string[]

ActivityDayDto

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

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

ActivitySlotDto

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

Alan	Tür	Açıklama
`activeMs`zorunlu	integer (int64)
`apps`zorunlu	AppUsageDto[]
`neutralMs`zorunlu	integer (int64)
`offlineMs`zorunlu	integer (int64)
`productiveMs`zorunlu	integer (int64)
`slotStart`zorunlu	string (date-time)
`unproductiveMs`zorunlu	integer (int64)

AffectedAllocationDto

An allocation replace changed.

Alan	Tür	Açıklama
`change`zorunlu	string	`trimmed`, `split` or `deleted`.
`id`zorunlu	string (uuid)

AllocationCreateRequest

POST /v1/allocations (Idempotency-Key).

Alan	Tür	Açıklama
`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.

Alan	Tür	Açıklama
`affected`zorunlu	AffectedAllocationDto[]
`allocation`zorunlu	AllocationDto

AllocationDto

Time on a project.

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

AllocationPage

GET /v1/allocations.

Alan	Tür	Açıklama
`items`zorunlu	AllocationDto[]
`nextCursor`	string \| null

AllocationPermissionsDto

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

Alan	Tür	Açıklama
`delete`zorunlu	boolean
`edit`zorunlu	boolean

AppTotalDto

Alan	Tür	Açıklama
`activeMs`zorunlu	integer (int64)
`appKey`zorunlu	string
`categoryKey`	string \| null
`level`	string \| null	Level in the response's `levelContext`.
`name`zorunlu	string
`percentage`zorunlu	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".

Alan	Tür	Açıklama
`activeMs`zorunlu	integer (int64)
`appKey`zorunlu	string
`categoryKey`	string \| null
`level`	string \| null	The app's own rule (`productive`, `unproductive`, `neutral`).
`levelSource`	string \| null	`team`, `company`, `default` or `offline`.
`name`zorunlu	string

BudgetDto

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

Alan	Tür	Açıklama
`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).

Alan	Tür	Açıklama
`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).

Alan	Tür	Açıklama
`decision`	string \| null
`note`	string \| null

CalendarPersonDto

A user with the current team.

Alan	Tür	Açıklama
`fullName`	string \| null
`id`zorunlu	string (uuid)
`teamId`	string (uuid) \| null
`teamName`	string \| null

CalendarUserRefDto

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

Alan	Tür	Açıklama
`fullName`	string \| null
`id`zorunlu	string (uuid)

CapabilitiesDto

Subscription capabilities.

Alan	Tür	Açıklama
`features`zorunlu	string[]
`readOnly`zorunlu	boolean

CategoryUsageDto

Alan	Tür	Açıklama
`activeMs`zorunlu	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.

Alan	Tür	Açıklama
`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.

Alan	Tür	Açıklama
`email`zorunlu	string
`fullName`zorunlu	string
`locale`	string \| null	Language of the e-mail and the acceptance page (`tr`, `en`); the organization's default otherwise.
`role`zorunlu	string	`admin`, `team_admin`, `manager` or `employee`.
`teamId`	string (uuid) \| null
`timeZone`	string \| null
`viewerTeamIds`	string (uuid)[]

CreateTeam

POST /v1/teams.

Alan	Tür	Açıklama
`description`	string \| null	At most 500 characters.
`name`zorunlu	string	1–100 characters, unique among active teams (Turkish case folding).

CreateTimeEntryRequest

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

Alan	Tür	Açıklama
`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.

Alan	Tür	Açıklama
`description`	string \| null	≤ 200 characters.
`eventTypes`zorunlu	string[]	1–50 catalog event types of the tenant's plan.
`url`zorunlu	string	`https://…` (≤ 2048; no user info, no fragment; every resolved address public).

CreatedWebhookEndpointDto

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

Alan	Tür	Açıklama
`endpoint`zorunlu	WebhookEndpointDto
`secret`zorunlu	string	`whsec_<base64>`: shown once, never again.

DailyHolidayDto

A holiday of a daily report day.

Alan	Tür	Açıklama
`half`	string \| null
`key`zorunlu	string
`name`zorunlu	string	English name; `nameTr` is the Turkish one.
`nameTr`zorunlu	string

DayAbsenceDto

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

Alan	Tür	Açıklama
`color`zorunlu	string
`fraction`zorunlu	number (double)	The day's approved absence coverage (0–1).
`half`	string \| null
`typeKey`	string \| null
`typeName`	string \| null
`unit`zorunlu	string

DayAttendanceDto

Attendance of the day on the day plan.

Alan	Tür	Açıklama
`expectedEnd`	string (date-time) \| null
`expectedStart`	string (date-time) \| null
`flexible`zorunlu	boolean
`lateByMs`zorunlu	integer (int64)
`lateToleranceMinutes`zorunlu	integer (int32)
`leftEarly`zorunlu	boolean
`leftEarlyByMs`zorunlu	integer (int64)
`status`zorunlu	string	`onTime`, `late`, `absent`, `notStarted`, `dayOff`, `onLeave`, `holiday`.
`targetMs`zorunlu	integer (int64)	The plan's target (the Effectiveness % denominator).
`workday`zorunlu	boolean

DayPlanDto

The day plan of one user's day.

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

DayProductivityDto

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

Alan	Tür	Açıklama
`effectivenessPct`	number (double) \| null	productive ÷ target × 100 (not capped); `null` without a target.
`neutralMs`zorunlu	integer (int64)
`productiveMs`zorunlu	integer (int64)
`productivityPct`	number (double) \| null	productive ÷ worked × 100, one decimal; `null` without worked time.
`targetMs`zorunlu	integer (int64)
`unproductiveMs`zorunlu	integer (int64)

DayTotalDto

One local day of a summary.

Alan	Tür	Açıklama
`activeMs`zorunlu	integer (int64)
`activeUserCount`zorunlu	integer (int32)
`atWorkMs`zorunlu	integer (int64)
`date`zorunlu	string (date)
`idleMs`zorunlu	integer (int64)
`neutralMs`zorunlu	integer (int64)
`offlineMs`zorunlu	integer (int64)
`privateMs`zorunlu	integer (int64)
`productiveMs`zorunlu	integer (int64)
`productivityPct`	number (double) \| null
`unproductiveMs`zorunlu	integer (int64)

DomainTotalDto

Alan	Tür	Açıklama
`activeMs`zorunlu	integer (int64)
`categoryKey`	string \| null
`domain`zorunlu	string
`level`	string \| null
`percentage`zorunlu	number (double)

DomainUsageDto

Alan	Tür	Açıklama
`activeMs`zorunlu	integer (int64)
`categoryKey`	string \| null
`domain`zorunlu	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).

Alan	Tür	Açıklama
`dueAt`	string (date-time) \| null	The deadline of an unverified account (`Identity__EmailVerificationGraceHours` after its creation).
`state`zorunlu	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}]).

Alan	Tür	Açıklama
`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.

Alan	Tür	Açıklama
`includeInactiveUsers`	boolean
`teamId`	string \| null
`userIds`	string \| null[] \| null

ExportJobDto

An export job as the panel lists and polls it.

Alan	Tür	Açıklama
`createdAt`zorunlu	string (date-time)
`dataset`zorunlu	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`zorunlu	string
`from`zorunlu	string (date)
`groupBy`	string \| null
`id`zorunlu	string (uuid)
`locale`zorunlu	string
`progress`zorunlu	integer (int32)	0–100.
`rowCount`	integer (int32) \| null
`startedAt`	string (date-time) \| null
`status`zorunlu	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`zorunlu	string (date)

ExportOptionsDto

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

Alan	Tür	Açıklama
`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.

Alan	Tür	Açıklama
`code`zorunlu	string	Stable snake_case code (`required`, `too_long`, `invalid`, ...).
`field`zorunlu	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).

Alan	Tür	Açıklama
`half`	string \| null
`key`zorunlu	string	Built-in key (`republic_day`, …) or `custom`.
`name`zorunlu	string
`nameEn`zorunlu	string
`nameTr`zorunlu	string
`source`	string \| null	`builtin` or `tenant`.

HostUsageDto

Alan	Tür	Açıklama
`activeMs`zorunlu	integer (int64)
`domain`	string \| null
`host`zorunlu	string
`level`zorunlu	string
`levelSource`zorunlu	string
`matchedKey`	string \| null	Key of the matching domain rule; `null` for the default.

InvitationEmail

What happened to the invitation e-mail.

Alan	Tür	Açıklama
`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`zorunlu	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.

Alan	Tür	Açıklama
`expiresAt`zorunlu	string
`id`zorunlu	string (uuid)

InvitationResult

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

Alan	Tür	Açıklama
`email`zorunlu	InvitationEmail
`invitation`zorunlu	InvitationRef
`member`zorunlu	MemberDto

LevelContextDto

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

Alan	Tür	Açıklama
`kind`zorunlu	string	`user` (a `userId` filter: that user's current team), `team` (a `teamId` filter) or `company`.
`teamId`	string (uuid) \| null

MeDto

GET /v1/me.

Alan	Tür	Açıklama
`access`zorunlu	AccessDto
`capabilities`zorunlu	CapabilitiesDto
`effectiveTimeZone`zorunlu	string
`membership`zorunlu	MeMembership
`organization`zorunlu	MeOrganization
`organizations`zorunlu	OrganizationChoice[]
`session`	MeSession \| null
`user`zorunlu	MeUser

MeMembership

The membership in the current organization.

Alan	Tür	Açıklama
`id`zorunlu	string (uuid)
`isTracked`zorunlu	boolean
`joinedAt`	string \| null
`role`zorunlu	string
`status`zorunlu	string
`teamId`	string (uuid) \| null
`teamName`	string \| null
`timeZone`	string \| null
`viewerTeamIds`zorunlu	string (uuid)[]

MeOrganization

The current organization.

Alan	Tür	Açıklama
`defaultLocale`zorunlu	string
`id`zorunlu	string (uuid)
`name`zorunlu	string
`slug`zorunlu	string
`status`zorunlu	string
`timeZone`zorunlu	string

MeSession

The current session.

Alan	Tür	Açıklama
`absoluteExpiresAt`zorunlu	string
`amr`zorunlu	string[]
`authTime`zorunlu	string
`clientId`zorunlu	string
`id`zorunlu	string (uuid)
`idleExpiresAt`zorunlu	string

MeUser

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

Alan	Tür	Açıklama
`email`zorunlu	string
`emailVerification`zorunlu	EmailVerificationDto	The e-mail verification gate (owner decision 3 Oct 2026).
`emailVerified`zorunlu	boolean
`fullName`	string \| null
`id`zorunlu	string (uuid)
`locale`zorunlu	string

MemberDto

A membership with its person (MemberDto).

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

MemberInvitationDto

The invitation of an invited member.

Alan	Tür	Açıklama
`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`zorunlu	string
`id`zorunlu	string (uuid)
`lastSentAt`zorunlu	string
`sentCount`zorunlu	integer (int32)

MemberPage

A page of members (OpenAPI).

Alan	Tür	Açıklama
`items`zorunlu	MemberDto[]
`nextCursor`	string \| null

MemberRefDto

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

Alan	Tür	Açıklama
`active`zorunlu	boolean	The membership is active and (for an endpoint or a tenant connection) still an Owner or Admin.
`name`	string \| null
`userId`zorunlu	string (uuid)

NamedRefDto

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

Alan	Tür	Açıklama
`id`zorunlu	string (uuid)
`name`zorunlu	string

OrganizationChoice

One organization of the person (sec.user_memberships).

Alan	Tür	Açıklama
`current`zorunlu	boolean
`id`zorunlu	string (uuid)
`name`zorunlu	string
`role`zorunlu	string
`selectable`zorunlu	boolean	Can this session's sign-in method open it (design §4.5.3)?

PatchMember

PATCH /v1/members/{id}.

Alan	Tür	Açıklama
`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}.

Alan	Tür	Açıklama
`description`	string \| null
`name`	string \| null

PeriodReportDto

GET /v1/reports/productivity.

Alan	Tür	Açıklama
`from`zorunlu	string (date)
`groupBy`zorunlu	string
`levelContext`zorunlu	LevelContextDto
`periods`zorunlu	ReportPeriodDto[]
`subject`zorunlu	ReportSubjectDto
`teams`zorunlu	TeamPeriodsDto[]	Only for the company subject: every visible team over its current members.
`to`zorunlu	string (date)
`totals`zorunlu	ReportFiguresDto

PlanAbsenceDto

Alan	Tür	Açıklama
`color`zorunlu	string
`countsAsWorked`zorunlu	boolean	`timeEffect == worked`.
`endTime`	string \| null
`half`	string \| null
`id`zorunlu	string (uuid)
`startTime`	string \| null	Local start and end of an `hours` absence.
`status`zorunlu	string	`approved` or `pending`.
`timeEffect`zorunlu	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`zorunlu	string	`days`, `half_day` or `hours`.

PlanShiftDto

Alan	Tür	Açıklama
`color`	string \| null
`end`zorunlu	string (date-time)
`endTime`zorunlu	string	Local end; before the start for a night shift.
`id`zorunlu	string (uuid)
`location`zorunlu	string
`minMinutes`zorunlu	integer (int32)
`start`zorunlu	string (date-time)
`startTime`zorunlu	string	Local start (`HH:mm`, the shift's zone).

Problem

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

Alan	Tür	Açıklama
`action`	string \| null	Permission key of a 403 (`teams.create`).
`code`zorunlu	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`zorunlu	integer (int32)
`title`zorunlu	string	English title of the code (clients translate `code`).
`traceId`	string \| null	W3C trace id of the request.
`type`zorunlu	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).

Alan	Tür	Açıklama
`billableMinor`zorunlu	integer (int64)	The billable hours at their rate.
`costMinor`zorunlu	integer (int64)	Every allocated hour at its rate.
`currency`zorunlu	string

ProjectBudgetUsageDto

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

Alan	Tür	Açıklama
`budgetMinor`	integer (int64) \| null	`null` unless `costsIncluded`.
`budgetMinutes`	integer (int64) \| null
`kind`zorunlu	string	`hours` or `amount`.
`projectId`zorunlu	string (uuid)
`usedMinor`	integer (int64) \| null	The cost in the project's currency; `null` unless `costsIncluded`.
`usedMs`zorunlu	integer (int64)
`usedRatio`	string \| null	Used / budget, 4 decimals (`null` for an amount budget without `costsIncluded`).

ProjectDto

A project.

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

ProjectPage

GET /v1/projects.

Alan	Tür	Açıklama
`items`zorunlu	ProjectDto[]
`nextCursor`	string \| null

ProjectPermissionsDto

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

Alan	Tür	Açıklama
`archive`zorunlu	boolean
`delete`zorunlu	boolean	Only a project without time.
`edit`zorunlu	boolean	The project's fields (Owners and Admins).
`manageMembers`zorunlu	boolean	The team (an Admin or the project's manager; only an Admin changes managers).
`manageTasks`zorunlu	boolean	Tasks (an Admin or the project's manager).
`track`zorunlu	boolean	The caller may track time on it now.

ProjectRefDto

A project reference of an allocation.

Alan	Tür	Açıklama
`color`	string \| null	`#RRGGBB`.
`id`zorunlu	string (uuid)
`name`zorunlu	string

ProjectReportDto

GET /v1/reports/projects.

Alan	Tür	Açıklama
`budgets`zorunlu	ProjectBudgetUsageDto[]
`costsIncluded`zorunlu	boolean	The caller sees rates and amounts (`projects.costs.read`).
`from`zorunlu	string (date)
`groupBy`zorunlu	string[]
`rows`zorunlu	ProjectReportRowDto[]
`to`zorunlu	string (date)
`totals`zorunlu	ProjectReportTotalsDto

ProjectReportKeysDto

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

Alan	Tür	Açıklama
`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.

Alan	Tür	Açıklama
`allocatedMs`zorunlu	integer (int64)
`amounts`	ProjectAmountDto[] \| null	`null` unless `costsIncluded`.
`billableMs`zorunlu	integer (int64)
`keys`zorunlu	ProjectReportKeysDto
`nonBillableMs`zorunlu	integer (int64)
`productiveMs`	integer (int64) \| null	With `includeProductive` only.
`unratedMs`zorunlu	integer (int64)	Time without any rate (it is left out of the amounts).

ProjectReportTotalsDto

The totals of the report.

Alan	Tür	Açıklama
`allocatedMs`zorunlu	integer (int64)
`amounts`	ProjectAmountDto[] \| null
`billableMs`zorunlu	integer (int64)
`nonBillableMs`zorunlu	integer (int64)
`productiveMs`	integer (int64) \| null
`unratedMs`zorunlu	integer (int64)

ProjectRequest

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

Alan	Tür	Açıklama
`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).

Alan	Tür	Açıklama
`absenceCreditMs`zorunlu	integer (int64)
`absentDays`zorunlu	integer (int32)
`activeMs`zorunlu	integer (int64)
`activeUserCount`zorunlu	integer (int32)
`effectivenessPct`	number (double) \| null
`idleMs`zorunlu	integer (int64)
`lateDays`zorunlu	integer (int32)
`leaveDays`zorunlu	number (double)
`leftEarlyDays`zorunlu	integer (int32)
`neutralMs`zorunlu	integer (int64)
`offlineMs`zorunlu	integer (int64)
`overtimeDays`zorunlu	integer (int32)
`overtimeMs`zorunlu	integer (int64)
`productiveMs`zorunlu	integer (int64)
`productivityPct`	number (double) \| null
`targetMs`zorunlu	integer (int64)
`unproductiveMs`zorunlu	integer (int64)
`userCount`zorunlu	integer (int32)
`workedMs`zorunlu	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).

Alan	Tür	Açıklama
`kind`zorunlu	string	`company`, `teams` or `self`.
`teamIds`zorunlu	string (uuid)[]	The visible teams of a `teams` scope, sorted; empty otherwise (company = all).
`unassignedFallback`zorunlu	boolean	A Manager without teams who sees the whole company until assigned.

ReportSubjectDto

Whom a report is about.

Alan	Tür	Açıklama
`id`	string (uuid) \| null
`kind`zorunlu	string	`company`, `team` or `user`.
`name`	string \| null

RotatedWebhookSecretDto

RotatedWebhookSecretDto: the new signing secret, shown once.

Alan	Tür	Açıklama
`previousSecretExpiresAt`zorunlu	string	Until then deliveries carry both signatures.
`secret`zorunlu	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.

Alan	Tür	Açıklama
`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.

Alan	Tür	Açıklama
`breakMinutes`zorunlu	integer (int32)
`color`	string \| null
`createdAt`zorunlu	string (date-time)
`createdBy`zorunlu	CalendarUserRefDto
`crossesMidnight`zorunlu	boolean
`date`zorunlu	string (date)
`durationMinutes`zorunlu	integer (int32)
`end`zorunlu	string (date-time)
`endTime`zorunlu	string
`id`zorunlu	string (uuid)
`location`zorunlu	string
`minMinutes`zorunlu	integer (int32)
`note`	string \| null
`open`zorunlu	boolean	No user assigned.
`permissions`zorunlu	ShiftPermissionsDto
`source`zorunlu	string	`manual`, `template`, `copy` or `request`.
`start`zorunlu	string (date-time)
`startTime`zorunlu	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`zorunlu	string
`updatedAt`zorunlu	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).

Alan	Tür	Açıklama
`items`zorunlu	ShiftDto[]

ShiftPermissionsDto

Alan	Tür	Açıklama
`canDelete`zorunlu	boolean
`canEdit`zorunlu	boolean
`canPickUp`zorunlu	boolean
`canRequestSwap`zorunlu	boolean

SummaryDto

The summary of the visible users over a range.

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

TargetItemDto

Alan	Tür	Açıklama
`activeMs`zorunlu	integer (int64)
`categoryKey`	string \| null
`categorySource`zorunlu	string	`tenant`, `builtin` or `none`.
`domain`	string \| null
`level`zorunlu	string
`levelSource`zorunlu	string	`team`, `company` or `default`.
`matchedKey`	string \| null
`name`zorunlu	string
`percentage`zorunlu	number (double)
`targetKey`zorunlu	string
`targetType`zorunlu	string	`app` for apps, `domain` for domains and hosts.
`userCount`zorunlu	integer (int32)

TargetListDto

The "Apps & URLs" list.

Alan	Tür	Açıklama
`from`zorunlu	string (date)
`items`zorunlu	TargetItemDto[]	By active time descending, then key.
`levelContext`zorunlu	LevelContextDto
`nextCursor`	string \| null
`to`zorunlu	string (date)
`total`zorunlu	integer (int32)	Targets matching the filters (before paging).
`totalActiveMs`zorunlu	integer (int64)	Active time over every target of the type before the filters (the percentage base).
`type`zorunlu	string	`app`, `domain` or `host`.

TaskDto

A task.

Alan	Tür	Açıklama
`archived`zorunlu	boolean
`assignee`	NamedRefDto \| null
`createdAt`zorunlu	string (date-time)
`description`	string \| null
`dueDate`	string (date) \| null
`effectiveBillable`zorunlu	boolean
`estimateMinutes`	integer (int64) \| null
`id`zorunlu	string (uuid)
`isBillable`	boolean \| null	`null` takes the project's value.
`name`zorunlu	string
`permissions`zorunlu	TaskPermissionsDto
`projectId`zorunlu	string (uuid)
`sortOrder`zorunlu	integer (int64)
`spentMs`zorunlu	integer (int64)
`status`zorunlu	string	`open`, `in_progress` or `done`.
`updatedAt`zorunlu	string (date-time)

TaskPage

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

Alan	Tür	Açıklama
`items`zorunlu	TaskDto[]
`nextCursor`	string \| null

TaskPermissionsDto

What the caller may do with a task.

Alan	Tür	Açıklama
`delete`zorunlu	boolean	Only a task without time.
`edit`zorunlu	boolean

TaskRequest

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

Alan	Tür	Açıklama
`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).

Alan	Tür	Açıklama
`archivedAt`	string \| null
`createdAt`zorunlu	string
`description`	string \| null
`id`zorunlu	string (uuid)
`leads`zorunlu	object[]	TeamAdmins and Managers of the team: `[{membershipId, userId, fullName, role}]`.
`memberCount`zorunlu	integer (int64)	Members whose primary team this is (left members excluded).
`name`zorunlu	string
`updatedAt`zorunlu	string

TeamPage

A page of teams (OpenAPI).

Alan	Tür	Açıklama
`items`zorunlu	TeamDto[]
`nextCursor`	string \| null

TeamPeriodsDto

Alan	Tür	Açıklama
`periods`zorunlu	ReportPeriodDto[]
`teamId`zorunlu	string (uuid)
`teamName`	string \| null
`totals`zorunlu	ReportFiguresDto

TeamTotalDto

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

Alan	Tür	Açıklama
`absenceCreditMs`zorunlu	integer (int64)
`absentDays`zorunlu	integer (int32)
`activeMs`zorunlu	integer (int64)
`activeUserCount`zorunlu	integer (int32)
`effectivenessPct`	number (double) \| null
`holidayDays`zorunlu	number (double)
`idleMs`zorunlu	integer (int64)
`lateDays`zorunlu	integer (int32)
`leaveDays`zorunlu	number (double)
`leftEarlyDays`zorunlu	integer (int32)
`memberCount`zorunlu	integer (int32)
`neutralMs`zorunlu	integer (int64)
`offlineMs`zorunlu	integer (int64)
`overtimeMs`zorunlu	integer (int64)
`productiveMs`zorunlu	integer (int64)
`productivityPct`	number (double) \| null
`shiftDays`zorunlu	integer (int32)
`teamId`	string (uuid) \| null	`null` for the users without a team.
`teamName`	string \| null
`unproductiveMs`zorunlu	integer (int64)
`workedMs`zorunlu	integer (int64)

TimeEntryDecisionRequest

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

Alan	Tür	Açıklama
`decision`	string \| null	`approve` or `reject`.
`note`	string \| null	At most 500 characters.

TimeEntryDto

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

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

TimeEntryPage

GET /v1/time-entries: by start.

Alan	Tür	Açıklama
`items`zorunlu	TimeEntryDto[]
`nextCursor`	string \| null

TimeEntryPermissionsDto

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

Alan	Tür	Açıklama
`canApprove`zorunlu	boolean
`canDelete`zorunlu	boolean
`canEdit`zorunlu	boolean

TimeEntryUserRefDto

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

Alan	Tür	Açıklama
`fullName`	string \| null
`id`zorunlu	string (uuid)

TimeIntervalDto

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

Alan	Tür	Açıklama
`end`zorunlu	string (date-time)
`start`zorunlu	string (date-time)

TimerAtRequest

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

Alan	Tür	Açıklama
`at`	string (date-time) \| null

TimerCommandResultDto

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

Alan	Tür	Açıklama
`applied`zorunlu	boolean
`closed`zorunlu	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`zorunlu	TimerDto

TimerDto

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

Alan	Tür	Açıklama
`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`zorunlu	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`zorunlu	string	`running` or `stopped`.
`task`	NamedRefDto \| null

TimerLastDto

The segment that ended last.

Alan	Tür	Açıklama
`endReason`zorunlu	string	`stop`, `switch`, `autostop` or `discard`.
`endedAt`zorunlu	string (date-time)
`segmentId`zorunlu	string (uuid)
`startedAt`zorunlu	string (date-time)

TimerProjectDto

The project of the running segment.

Alan	Tür	Açıklama
`clientName`	string \| null
`color`	string \| null
`id`zorunlu	string (uuid)
`name`zorunlu	string

TimerStartRequest

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

Alan	Tür	Açıklama
`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).

Alan	Tür	Açıklama
`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).

Alan	Tür	Açıklama
`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.

Alan	Tür	Açıklama
`days`zorunlu	UserDayDto[]
`from`zorunlu	string (date)
`teamId`	string (uuid) \| null	The user's current primary team (its rules classify every day).
`timeZone`zorunlu	string
`to`zorunlu	string (date)
`userId`zorunlu	string (uuid)

UserDayDto

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

UserTotalDto

One user of a summary.

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

WebhookDeliveryDetailDto

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

WebhookDeliveryDto

WebhookDeliveryDto.

Alan	Tür	Açıklama
`attempts`zorunlu	integer (int32)
`createdAt`zorunlu	string
`deliveredAt`	string \| null
`eventId`zorunlu	string (uuid)	The `webhook-id` header.
`eventType`zorunlu	string
`id`zorunlu	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`zorunlu	string	`pending`, `succeeded`, `failed`, `dead`.

WebhookDeliveryPage

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

Alan	Tür	Açıklama
`items`zorunlu	WebhookDeliveryDto[]
`nextCursor`	string \| null

WebhookEndpointDto

WebhookEndpointDto.

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

WebhookEndpointPage

GET /v1/webhook-endpoints.

Alan	Tür	Açıklama
`items`zorunlu	WebhookEndpointDto[]
`nextCursor`	string \| null

WebhookEndpointStatsDto

The delivery statistics of an endpoint.

Alan	Tür	Açıklama
`consecutiveFailures`zorunlu	integer (int32)
`lastFailureAt`	string \| null
`lastSuccessAt`	string \| null

WebhookEventDto

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

Alan	Tür	Açıklama
`available`zorunlu	boolean	The tenant's plan has the feature: an endpoint may subscribe.
`description`zorunlu	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`zorunlu	string	The `data.object` of the delivery body.
`type`zorunlu	string	`<object>.<verb>`, e.g. `time_entry.approved`.

WebhookEventsDto

GET /v1/webhook-events.

Alan	Tür	Açıklama
`items`zorunlu	WebhookEventDto[]

WebhookTestDto

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

Alan	Tür	Açıklama
`deliveryId`zorunlu	string	The delivery of the test event (a string: the deliveries' id is a 64-bit integer).

Genel API referansı

Kimlik doğrulama

Kapsamlar

İstek sınırları

Hatalar

Webhook'lar

İşlemler

Devamsızlıklar

GET /v1/absences Kapsam: reports:read

Parametreler

POST /v1/absences Kapsam: time:write

Parametreler

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

Parametreler

Etkinlik

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

Parametreler

Süre atamaları

GET /v1/allocations Kapsam: reports:read

Parametreler

POST /v1/allocations Kapsam: time:write

Parametreler

Dışa aktarmalar

POST /v1/exports Kapsam: reports:read

Parametreler

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

Parametreler

Ben

GET /v1/me Kapsam: me

Üyeler

POST /v1/invitations Kapsam: org:admin

Parametreler

GET /v1/members Kapsam: org:admin

Parametreler

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

Parametreler

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

Parametreler

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

Parametreler

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

Parametreler

Projeler

GET /v1/projects Kapsam: reports:read

Parametreler

POST /v1/projects Kapsam: org:admin

Parametreler

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

Parametreler

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

Parametreler

Raporlar

GET /v1/reports/productivity Kapsam: reports:read

Parametreler

GET /v1/reports/projects Kapsam: reports:read

Parametreler

GET /v1/reports/summary Kapsam: reports:read

Parametreler

GET /v1/reports/targets Kapsam: reports:read

Parametreler

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

Parametreler

Vardiyalar

GET /v1/shifts Kapsam: reports:read

Parametreler

POST /v1/shifts Kapsam: time:write

Parametreler

Görevler

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

Parametreler

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

Parametreler

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

Parametreler

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

Parametreler

Takımlar

GET /v1/teams Kapsam: reports:read

Parametreler

POST /v1/teams Kapsam: org:admin

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

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

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

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

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

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

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

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

GET `/v1/me` Kapsam: `me`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

GET `/v1/me/timer` Kapsam: `me`

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

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

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

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

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

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

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

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

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

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

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

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

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