پبلک API ریفرنس

Workify360 Focus پبلک API آپ کے اپنے اسکرپٹس اور ٹولز کو رپورٹس اور وقت کا ڈیٹا پڑھنے اور ڈیش بورڈ والے اصولوں کے مطابق تبدیلیاں کرنے دیتا ہے۔ پبلک API، API کلیدیں اور ویب ہُکس Premium پلان کا حصہ ہیں۔

اس صفحے کے آپریشنز پچھلے ورژنز کے ساتھ مطابقت برقرار رکھتے ہیں۔ انہی آپریشنز کی مشین سے پڑھی جانے والی OpenAPI دستاویز:

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

API کنٹریکٹ ورژن 0.1.0 (c95fb97bb49a) سے تیار کردہ۔

تصدیق

ہر ریکوئسٹ کے Authorization ہیڈر میں ایک ذاتی API کلید بھیجیں۔ کلید اسی فرد کی ہوتی ہے جس نے اسے بنایا، اسی فرد کی حیثیت سے کام کرتی ہے اور کبھی اس سے زیادہ کچھ نہیں کرتی جس کی اس فرد کا موجودہ رول اجازت دیتا ہے۔ غائب، غلط، میعاد ختم یا منسوخ شدہ کلید والی ریکوئسٹ کو unauthorized کوڈ کے ساتھ 401 ملتا ہے۔

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

کلیدیں بنانے، ان کا اسکوپ طے کرنے اور انہیں منسوخ کرنے کا طریقہ: API کلیدیں اور پبلک API

اسکوپس

ہر آپریشن کو ایک اسکوپ درکار ہوتا ہے، جو اس کے ساتھ دکھایا گیا ہے۔ کوئی کلید کسی آپریشن تک تب پہنچتی ہے جب اس کے پاس وہ اسکوپ ہو اور اس کے مالک کا موجودہ رول، ٹیمیں اور پلان ریکوئسٹ کی اجازت دیں، بالکل ڈیش بورڈ کی طرح۔

اسکوپ	یہ کس چیز کی اجازت دیتا ہے
`me`	آپ کی اپنی پروفائل اور آپ کا ٹائمر
`reports:read`	رپورٹس، وقت کے اندراجات، غیر حاضریاں، شفٹیں، ٹیمیں، پروجیکٹس، ٹاسکس اور ایکسپورٹس پڑھنا
`time:write`	وقت کے اندراجات، غیر حاضریاں، شفٹیں، ٹاسکس اور ٹاسکس کو تفویض کردہ وقت شامل اور تبدیل کرنا، اور درخواستوں پر فیصلہ کرنا
`org:admin`	ارکان، ٹیموں، دعوت ناموں اور پروجیکٹس کا انتظام
`webhooks:manage`	ویب ہُک اینڈ پوائنٹس کا انتظام

ریٹ لمٹس

ہر کلید فی منٹ 600 یونٹس اور ایک ادارہ اپنی تمام کلیدوں کے لیے مجموعی طور پر 1,800 یونٹس بھیج سکتا ہے۔ کچھ تبدیل کرنے والی ریکوئسٹ (GET اور HEAD کے علاوہ کوئی بھی) دو یونٹس شمار ہوتی ہے، باقی ہر ریکوئسٹ ایک۔ ایک کلید یکدم زیادہ سے زیادہ 60 یونٹس بھیج سکتی ہے، جو 10 فی سیکنڈ کی رفتار سے دوبارہ بھرتے ہیں: یکدم 60 سے زیادہ ریڈز (یا 30 تبدیلیوں) پر 429 ملتا ہے، چاہے فی منٹ 600 سے کم ہوں۔

ہیڈر	مطلب
`RateLimit: "key";r=598;t=2`	ہر شمار شدہ جواب پر: کلید کے باقی یونٹس اور ان کے دوبارہ پورا ہونے تک کے سیکنڈز
`RateLimit-Policy: "key";q=600;w=60, "tenant";q=1800;w=60`	ہر شمار شدہ جواب پر: کلید اور ادارے کی فی منٹ حدیں
`Retry-After: 12`	429 (کوڈ `rate_limited`) کے ساتھ: اگلی ریکوئسٹ سے پہلے انتظار کے سیکنڈز

ایررز

ایرر ایک RFC 9457 problem دستاویز ہوتی ہے (Content-Type: application/problem+json)۔ code ایک مستحکم snake_case کوڈ ہے جس کی بنیاد پر پروگرام لکھا جا سکتا ہے؛ title لاگز کے لیے انگریزی متن ہے۔ type کوڈ کا ہیلپ ایڈریس ہے، https://workify360.com/help/errors/<code>/ جس میں ہر _ کو - لکھا جاتا ہے، اور اگر کوڈ کا ہیلپ آرٹیکل ہو تو یہ وہ آرٹیکل کھولتا ہے جو کوڈ کی وضاحت کرتا ہے۔

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

کچھ problems میں مزید فیلڈز ہوتی ہیں: errors (422 validation_failed کی فیلڈ ایررز)، action (وہ اجازت جس کا حوالہ 403 forbidden دیتا ہے)، requiredPlan (402 feature_not_in_plan)، retryAfterSeconds (429 اور 503) اور traceId (سپورٹ سے رابطہ کرتے وقت اس کا حوالہ دیں)۔

اسٹیٹس	کوڈ	کب
400	`invalid_request`	کوئی پیرامیٹر غلط فارمیٹ میں ہے یا موجود نہیں
401	`unauthorized`	کلید موجود نہیں، غلط، میعاد ختم یا منسوخ شدہ ہے، یا اس کا مالک ادارہ چھوڑ چکا ہے
402	`feature_not_in_plan`, `subscription_read_only`	پلان میں یہ فیچر شامل نہیں، یا سبسکرپشن صرف پڑھنے کے قابل ہے
403	`forbidden`, `feature_not_enabled`	کلید کے پاس اسکوپ نہیں، یا اس کے مالک کا موجودہ رول، ٹیمیں یا سیٹنگز ریکوئسٹ کی اجازت نہیں دیتیں
412	`version_conflict`	`If-Match` ورژن اب موجودہ نہیں رہا؛ ریسورس دوبارہ پڑھیں
422	`validation_failed`	باڈی درست نہیں؛ `errors` فیلڈز کی فہرست دیتا ہے
428	`precondition_required`	آپریشن کو آپ کے پڑھے ہوئے ورژن کے ساتھ `If-Match` ہیڈر درکار ہے
429	`rate_limited`	بہت زیادہ ریکوئسٹس؛ `Retry-After` میں دیے گئے سیکنڈز انتظار کریں

جن کوڈز کا ہیلپ آرٹیکل ہے وہ آپریشنز کی فہرست میں لنک ہیں۔

ویب ہُکس

API سے بار بار پوچھنے کے بجائے، کچھ تبدیل ہونے پر آپ کا کوئی اینڈ پوائنٹ ایک دستخط شدہ HTTPS ریکوئسٹ وصول کر سکتا ہے۔ ایونٹس، ریکوئسٹ کا فارمیٹ، Node.js اور Python میں دستخط کی تصدیق کا طریقہ، دوبارہ کوششیں اور سیکرٹ کی تبدیلی ہیلپ آرٹیکل میں بیان کی گئی ہیں: ویب ہُکس

آپریشنز

شعبے کے لحاظ سے گروپ شدہ۔ خلاصے اور فیلڈز کی وضاحتیں API کنٹریکٹ سے لی گئی ہیں۔

غیر حاضریاں

GET `/v1/absences` اسکوپ: `reports:read`

List absences overlapping a range.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`from`	کوئری	string (date)
`to`	کوئری	string (date)	At most 366 days after `from`.
`userId`	کوئری	string (uuid)
`teamId`	کوئری	string (uuid)
`status`	کوئری	string
`typeId`	کوئری	string (uuid)
`cursor`	کوئری	string
`limit`	کوئری	integer (int32)

جوابات

200 AbsencePage

ایررز

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

POST `/v1/absences` اسکوپ: `time:write`

Request (or record) an absence.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`Idempotency-Key`لازمی	ہیڈر	string	Required: the same key and body return the first answer

ریکوئسٹ باڈی

AbsenceRequest

جوابات

201 AbsenceDto

ایررز

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` اسکوپ: `time:write`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Id
`If-Match`لازمی	ہیڈر	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

ریکوئسٹ باڈی

CalendarDecisionRequest

جوابات

200 AbsenceDto

ایررز

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)

سرگرمی

GET `/v1/activity/day` اسکوپ: `reports:read`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`date`	کوئری	string (date)	The user's local day (required).
`userId`	کوئری	string (uuid)	Default: the caller; another user must be visible (else 403).

جوابات

200 ActivityDayDto

ایررز

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

وقت کی تفویض

GET `/v1/allocations` اسکوپ: `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).

پیرامیٹرز

نام	مقام	قسم	وضاحت
`userId`	کوئری	string (uuid)	Default: the caller.
`from`	کوئری	string (date)	Local date, included.
`to`	کوئری	string (date)	Local date, included; at most 93 days after `from`.
`projectId`	کوئری	string (uuid)
`cursor`	کوئری	string
`limit`	کوئری	integer (int32)	1–200 (default 200).

جوابات

200 AllocationPage

ایررز

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` اسکوپ: `time:write`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`Idempotency-Key`	ہیڈر	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

ریکوئسٹ باڈی

AllocationCreateRequest

جوابات

201 AllocationCreatedDto

ایررز

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

ایکسپورٹس

POST `/v1/exports` اسکوپ: `reports:read`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`Idempotency-Key`لازمی	ہیڈر	string	Required: the same key and body return the first answer

ریکوئسٹ باڈی

CreateExportRequest

جوابات

202 ExportJobDto

ایررز

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}` اسکوپ: `reports:read`

One export job (poll every 2 s).

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Id

جوابات

200 ExportJobDto

ایررز

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

میری پروفائل

GET `/v1/me` اسکوپ: `me`

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

جوابات

200 MeDto

ایررز

401 unauthorized

ارکان

POST `/v1/invitations` اسکوپ: `org:admin`

Invite a person.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`Idempotency-Key`لازمی	ہیڈر	string	Required: 1–255 printable ASCII characters

ریکوئسٹ باڈی

CreateInvitation

جوابات

201 InvitationResult

ایررز

409 already_member
422 validation_failed, idempotency_key_reused

GET `/v1/members` اسکوپ: `org:admin`

List members.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`status`	کوئری	string	Comma-separated statuses (default active,invited,suspended)
`teamId`	کوئری	string (uuid)	Primary team
`role`	کوئری	string	owner, admin, team_admin, manager or employee
`q`	کوئری	string	Part of the name or e-mail (Turkish case folding)
`cursor`	کوئری	string	Opaque cursor of the next page
`limit`	کوئری	integer (int32)	1–200, default 50

جوابات

200 MemberPage

ایررز

403 No right

GET `/v1/members/{id}` اسکوپ: `org:admin`

One member.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Membership id

جوابات

200 MemberDto

ایررز

404 member_not_found

PATCH `/v1/members/{id}` اسکوپ: `org:admin`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Membership id
`If-Match`لازمی	ہیڈر	string	ETag of the member ("v<n>")

ریکوئسٹ باڈی

PatchMember

جوابات

200 MemberDto

ایررز

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` اسکوپ: `org:admin`

Reactivate a suspended member.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Membership id

جوابات: 200 MemberDto

POST `/v1/members/{id}/suspend` اسکوپ: `org:admin`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Membership id

جوابات

200 MemberDto

ایررز

409 conflict (an invitation is revoked instead)

پروجیکٹس

GET `/v1/projects` اسکوپ: `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).

پیرامیٹرز

نام	مقام	قسم	وضاحت
`status`	کوئری	string	`active`, `on_hold` or `completed`.
`clientId`	کوئری	string (uuid)
`q`	کوئری	string	Name or code search (case-insensitive).
`includeArchived`	کوئری	boolean
`mine`	کوئری	boolean	Only the projects the caller may track time on.
`cursor`	کوئری	string
`limit`	کوئری	integer (int32)	1–200 (default 50).

جوابات

200 ProjectPage

ایررز

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

POST `/v1/projects` اسکوپ: `org:admin`

Add a project (Owners and Admins).

پیرامیٹرز

نام	مقام	قسم	وضاحت
`Idempotency-Key`	ہیڈر	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

ریکوئسٹ باڈی

ProjectRequest

جوابات

201 ProjectDto

ایررز

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}` اسکوپ: `reports:read`

One project (invisible projects are 404).

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Project id

جوابات

200 ProjectDto

ایررز

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

PUT `/v1/projects/{id}` اسکوپ: `org:admin`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Project id
`If-Match`لازمی	ہیڈر	string	The ETag the caller read (412 version_conflict when it changed)

ریکوئسٹ باڈی

ProjectRequest

جوابات

200 ProjectDto

ایررز

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)

رپورٹس

GET `/v1/reports/productivity` اسکوپ: `reports:read`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`from`	کوئری	string (date)
`to`	کوئری	string (date)	`day` 93 days, `week`, `month` and `range` 366.
`groupBy`	کوئری	string	`day`, `week`, `month` or `range`.
`teamId`	کوئری	string (uuid)
`userId`	کوئری	string (uuid)

جوابات

200 PeriodReportDto

ایررز

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` اسکوپ: `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.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`from`	کوئری	string (date)	Local date, included.
`to`	کوئری	string (date)	Local date, included; at most 366 days after `from`.
`groupBy`	کوئری	string	One or two of `project` (default), `task`, `user`, `client`, `day`, comma separated.
`projectIds`	کوئری	string	Comma-separated project ids.
`clientId`	کوئری	string (uuid)
`userIds`	کوئری	string	Comma-separated user ids (visible people only).
`teamId`	کوئری	string (uuid)
`billable`	کوئری	string	`all` (default), `billable` or `nonBillable`.
`includeProductive`	کوئری	boolean	Also compute the productive time within the allocations (costly; default false).

جوابات

200 ProjectReportDto

ایررز

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` اسکوپ: `reports:read`

The summary of the visible users over a range.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`from`	کوئری	string (date)
`to`	کوئری	string (date)	At most 93 days after `from`.
`teamId`	کوئری	string (uuid)	Only the team's current members; the team must be visible (else 403).

جوابات

200 SummaryDto

ایررز

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` اسکوپ: `reports:read`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`from`	کوئری	string (date)
`to`	کوئری	string (date)
`type`	کوئری	string	`app`, `domain` or `host`.
`teamId`	کوئری	string (uuid)
`userId`	کوئری	string (uuid)
`q`	کوئری	string	Search in the key and the name (.NET `search`).
`level`	کوئری	string	`productive`, `unproductive` or `neutral`.
`categoryKey`	کوئری	string
`unclassified`	کوئری	boolean	Only targets without a category.
`cursor`	کوئری	string
`limit`	کوئری	integer (int32)	1–200, default 50.

جوابات

200 TargetListDto

ایررز

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` اسکوپ: `reports:read`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`userId`لازمی	پاتھ	string (uuid)	User
`from`	کوئری	string (date)
`to`	کوئری	string (date)	At most 93 days after `from`.

جوابات

200 UserDailyDto

ایررز

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

شفٹیں

GET `/v1/shifts` اسکوپ: `reports:read`

List the shifts starting in a range.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`from`	کوئری	string (date)
`to`	کوئری	string (date)
`teamId`	کوئری	string (uuid)
`userId`	کوئری	string (uuid)
`includeOpen`	کوئری	boolean	Also open shifts (default true).

جوابات

200 ShiftListDto

ایررز

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

POST `/v1/shifts` اسکوپ: `time:write`

Create a shift (assigned or open).

پیرامیٹرز

نام	مقام	قسم	وضاحت
`Idempotency-Key`لازمی	ہیڈر	string	Required: the same key and body return the first answer

ریکوئسٹ باڈی

ShiftBody

جوابات

201 ShiftDto

ایررز

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

ٹاسکس

GET `/v1/projects/{id}/tasks` اسکوپ: `reports:read`

A visible project's tasks, by sort order.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Project id
`status`	کوئری	string	`open`, `in_progress` or `done`.
`assigneeUserId`	کوئری	string (uuid)
`includeArchived`	کوئری	boolean
`cursor`	کوئری	string
`limit`	کوئری	integer (int32)	1–500 (default 200).

جوابات

200 TaskPage

ایررز

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` اسکوپ: `time:write`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Project id
`Idempotency-Key`	ہیڈر	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

ریکوئسٹ باڈی

TaskRequest

جوابات

201 TaskDto

ایررز

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}` اسکوپ: `reports:read`

One task of a visible project.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Task id

جوابات

200 TaskDto

ایررز

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

PUT `/v1/tasks/{id}` اسکوپ: `time:write`

Change a task (the whole body).

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Task id
`If-Match`لازمی	ہیڈر	string	The ETag the caller read (412 version_conflict when it changed)

ریکوئسٹ باڈی

TaskRequest

جوابات

200 TaskDto

ایررز

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)

ٹیمیں

GET `/v1/teams` اسکوپ: `reports:read`

List teams.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`includeArchived`	کوئری	boolean	Also archived teams (default false)
`cursor`	کوئری	string	Opaque cursor of the next page
`limit`	کوئری	integer (int32)	1–200, default 50

جوابات: 200 TeamPage

POST `/v1/teams` اسکوپ: `org:admin`

Create a team (the G1 endpoint).

ریکوئسٹ باڈی

CreateTeam

جوابات

201 TeamDto

ایررز

403 forbidden (action teams.create)
409 team_name_taken

PATCH `/v1/teams/{id}` اسکوپ: `org:admin`

Rename a team or change its description.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Team id
`If-Match`لازمی	ہیڈر	string	ETag of the team

ریکوئسٹ باڈی

PatchTeam

جوابات

200 TeamDto

ایررز

409 team_name_taken

وقت کے اندراجات

GET `/v1/time-entries` اسکوپ: `reports:read`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`userId`	کوئری	string (uuid)	Default: the caller.
`from`	کوئری	string (date)	The entry's local day, required.
`to`	کوئری	string (date)	At most 93 days after `from`.
`kind`	کوئری	string	`offline` or `deletion`.
`status`	کوئری	string	`pending`, `approved` or `rejected`.
`cursor`	کوئری	string
`limit`	کوئری	integer (int32)	1–500.

جوابات

200 TimeEntryPage

ایررز

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` اسکوپ: `time:write`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`Idempotency-Key`لازمی	ہیڈر	string	Required: the same key and body return the first answer

ریکوئسٹ باڈی

CreateTimeEntryRequest

جوابات

201 TimeEntryDto

ایررز

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}` اسکوپ: `reports:read`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Entry id

جوابات

200 TimeEntryDto

ایررز

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

PUT `/v1/time-entries/{id}` اسکوپ: `time:write`

Replace an entry's editable fields.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Entry id
`If-Match`لازمی	ہیڈر	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

ریکوئسٹ باڈی

UpdateTimeEntryRequest

جوابات

200 TimeEntryDto

ایررز

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}` اسکوپ: `time:write`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Entry id
`If-Match`لازمی	ہیڈر	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

جوابات

204 (کوئی باڈی نہیں)

ایررز

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` اسکوپ: `time:write`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	Entry id
`If-Match`لازمی	ہیڈر	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

ریکوئسٹ باڈی

TimeEntryDecisionRequest

جوابات

200 TimeEntryDto

ایررز

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)

ٹائمر

GET `/v1/me/timer` اسکوپ: `me`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`If-None-Match`	ہیڈر	string \| null	The ETag the caller holds (304 when unchanged)

جوابات

200 TimerDto · 304 (کوئی باڈی نہیں)

ایررز

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

POST `/v1/me/timer/start` اسکوپ: `me`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`Idempotency-Key`	ہیڈر	string \| null	The client's command id; a retry returns the first answer

ریکوئسٹ باڈی

TimerStartRequest

جوابات

200 TimerCommandResultDto

ایررز

POST `/v1/me/timer/stop` اسکوپ: `me`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`Idempotency-Key`	ہیڈر	string \| null	The client's command id; a retry returns the first answer

ریکوئسٹ باڈی

TimerAtRequest

جوابات

200 TimerCommandResultDto

ایررز

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

ویب ہُکس

GET `/v1/webhook-endpoints` اسکوپ: `webhooks:manage`

The tenant's webhook endpoints.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`cursor`	کوئری	string
`limit`	کوئری	integer (int32)	1–200, default 50.

جوابات

200 WebhookEndpointPage

ایررز

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

POST `/v1/webhook-endpoints` اسکوپ: `webhooks:manage`

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

ریکوئسٹ باڈی

CreateWebhookEndpointRequest

جوابات

201 CreatedWebhookEndpointDto

ایررز

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}` اسکوپ: `webhooks:manage`

One webhook endpoint.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	The endpoint

جوابات

200 WebhookEndpointDto

ایررز

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

PATCH `/v1/webhook-endpoints/{id}` اسکوپ: `webhooks:manage`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	The endpoint
`If-Match`لازمی	ہیڈر	string	The endpoint's ETag (`"v<n>"`)

ریکوئسٹ باڈی

UpdateWebhookEndpointRequest

جوابات

200 WebhookEndpointDto

ایررز

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}` اسکوپ: `webhooks:manage`

Delete an endpoint and its deliveries.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	The endpoint

جوابات

204 (کوئی باڈی نہیں)

ایررز

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

GET `/v1/webhook-endpoints/{id}/deliveries` اسکوپ: `webhooks:manage`

The deliveries of an endpoint, newest first.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	The endpoint
`status`	کوئری	string	`pending`, `succeeded`, `failed`, `dead`.
`eventType`	کوئری	string
`cursor`	کوئری	string	Opaque cursor of the next page.
`limit`	کوئری	integer (int32)	1–200, default 50.

جوابات

200 WebhookDeliveryPage

ایررز

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

GET `/v1/webhook-endpoints/{id}/deliveries/{deliveryId}` اسکوپ: `webhooks:manage`

One delivery with the body that was sent.

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	The endpoint
`deliveryId`لازمی	پاتھ	string	The delivery (a 64-bit integer)

جوابات

200 WebhookDeliveryDetailDto

ایررز

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` اسکوپ: `webhooks:manage`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	The endpoint
`deliveryId`لازمی	پاتھ	string	The delivery (a 64-bit integer)

جوابات

202 AcceptedDto

ایررز

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

POST `/v1/webhook-endpoints/{id}/rotate-secret` اسکوپ: `webhooks:manage`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	The endpoint

جوابات

200 RotatedWebhookSecretDto

ایررز

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

POST `/v1/webhook-endpoints/{id}/test` اسکوپ: `webhooks:manage`

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

پیرامیٹرز

نام	مقام	قسم	وضاحت
`id`لازمی	پاتھ	string (uuid)	The endpoint

جوابات

202 WebhookTestDto

ایررز

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

GET `/v1/webhook-events` اسکوپ: `webhooks:manage`

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

جوابات

200 WebhookEventsDto

ایررز

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

اسکیماز

ریکوئسٹ اور جواب کی وہ باڈیز جو آپریشنز استعمال کرتے ہیں۔ لازمی فیلڈز نشان زد ہیں۔

AbsenceDto

An absence.

فیلڈ	قسم	وضاحت
`createdAt`لازمی	string (date-time)
`createdBy`لازمی	CalendarUserRefDto
`days`لازمی	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`لازمی	object	The balance deduction per year, e.g. `{"2026": 3.5}`; empty for types that do not deduct.
`end`لازمی	string (date-time)
`endDate`لازمی	string (date)
`endTime`	string \| null
`half`	string \| null
`id`لازمی	string (uuid)
`note`	string \| null
`permissions`لازمی	AbsencePermissionsDto
`start`لازمی	string (date-time)	UTC coverage start.
`startDate`لازمی	string (date)
`startTime`	string \| null
`status`لازمی	string
`timeZone`لازمی	string
`type`لازمی	AbsenceTypeRefDto
`unit`لازمی	string
`updatedAt`لازمی	string (date-time)
`user`لازمی	CalendarPersonDto
`userId`لازمی	string (uuid)

AbsencePage

GET /v1/absences.

فیلڈ	قسم	وضاحت
`items`لازمی	AbsenceDto[]
`nextCursor`	string \| null

AbsencePermissionsDto

فیلڈ	قسم	وضاحت
`canApprove`لازمی	boolean
`canCancel`لازمی	boolean
`canEdit`لازمی	boolean

AbsenceRequest

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

فیلڈ	قسم	وضاحت
`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.

فیلڈ	قسم	وضاحت
`color`لازمی	string
`countsAsWorked`لازمی	boolean
`deductsFromBalance`لازمی	boolean
`id`لازمی	string (uuid)
`key`	string \| null
`name`لازمی	string
`paid`لازمی	boolean
`timeEffect`لازمی	string

AcceptedDto

202 Accepted of a queued job.

فیلڈ	قسم	وضاحت
`accepted`لازمی	boolean	Always `true`.

AccessDto

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

فیلڈ	قسم	وضاحت
`assignableRoles`لازمی	string[]
`canManageCompanySettings`لازمی	boolean
`canManageTeams`لازمی	boolean
`canManageUsers`لازمی	boolean
`manageTeamIds`لازمی	string[]
`scope`لازمی	string	`company`, `teams` or `self`.
`unassignedFallback`لازمی	boolean
`viewTeamIds`لازمی	string[]

ActivityDayDto

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

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

ActivitySlotDto

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

فیلڈ	قسم	وضاحت
`activeMs`لازمی	integer (int64)
`apps`لازمی	AppUsageDto[]
`neutralMs`لازمی	integer (int64)
`offlineMs`لازمی	integer (int64)
`productiveMs`لازمی	integer (int64)
`slotStart`لازمی	string (date-time)
`unproductiveMs`لازمی	integer (int64)

AffectedAllocationDto

An allocation replace changed.

فیلڈ	قسم	وضاحت
`change`لازمی	string	`trimmed`, `split` or `deleted`.
`id`لازمی	string (uuid)

AllocationCreateRequest

POST /v1/allocations (Idempotency-Key).

فیلڈ	قسم	وضاحت
`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.

فیلڈ	قسم	وضاحت
`affected`لازمی	AffectedAllocationDto[]
`allocation`لازمی	AllocationDto

AllocationDto

Time on a project.

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

AllocationPage

GET /v1/allocations.

فیلڈ	قسم	وضاحت
`items`لازمی	AllocationDto[]
`nextCursor`	string \| null

AllocationPermissionsDto

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

فیلڈ	قسم	وضاحت
`delete`لازمی	boolean
`edit`لازمی	boolean

AppTotalDto

فیلڈ	قسم	وضاحت
`activeMs`لازمی	integer (int64)
`appKey`لازمی	string
`categoryKey`	string \| null
`level`	string \| null	Level in the response's `levelContext`.
`name`لازمی	string
`percentage`لازمی	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".

فیلڈ	قسم	وضاحت
`activeMs`لازمی	integer (int64)
`appKey`لازمی	string
`categoryKey`	string \| null
`level`	string \| null	The app's own rule (`productive`, `unproductive`, `neutral`).
`levelSource`	string \| null	`team`, `company`, `default` or `offline`.
`name`لازمی	string

BudgetDto

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

فیلڈ	قسم	وضاحت
`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).

فیلڈ	قسم	وضاحت
`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).

فیلڈ	قسم	وضاحت
`decision`	string \| null
`note`	string \| null

CalendarPersonDto

A user with the current team.

فیلڈ	قسم	وضاحت
`fullName`	string \| null
`id`لازمی	string (uuid)
`teamId`	string (uuid) \| null
`teamName`	string \| null

CalendarUserRefDto

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

فیلڈ	قسم	وضاحت
`fullName`	string \| null
`id`لازمی	string (uuid)

CapabilitiesDto

Subscription capabilities.

فیلڈ	قسم	وضاحت
`features`لازمی	string[]
`readOnly`لازمی	boolean

CategoryUsageDto

فیلڈ	قسم	وضاحت
`activeMs`لازمی	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.

فیلڈ	قسم	وضاحت
`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.

فیلڈ	قسم	وضاحت
`email`لازمی	string
`fullName`لازمی	string
`locale`	string \| null	Language of the e-mail and the acceptance page (`tr`, `en`); the organization's default otherwise.
`role`لازمی	string	`admin`, `team_admin`, `manager` or `employee`.
`teamId`	string (uuid) \| null
`timeZone`	string \| null
`viewerTeamIds`	string (uuid)[]

CreateTeam

POST /v1/teams.

فیلڈ	قسم	وضاحت
`description`	string \| null	At most 500 characters.
`name`لازمی	string	1–100 characters, unique among active teams (Turkish case folding).

CreateTimeEntryRequest

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

فیلڈ	قسم	وضاحت
`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.

فیلڈ	قسم	وضاحت
`description`	string \| null	≤ 200 characters.
`eventTypes`لازمی	string[]	1–50 catalog event types of the tenant's plan.
`url`لازمی	string	`https://…` (≤ 2048; no user info, no fragment; every resolved address public).

CreatedWebhookEndpointDto

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

فیلڈ	قسم	وضاحت
`endpoint`لازمی	WebhookEndpointDto
`secret`لازمی	string	`whsec_<base64>`: shown once, never again.

DailyHolidayDto

A holiday of a daily report day.

فیلڈ	قسم	وضاحت
`half`	string \| null
`key`لازمی	string
`name`لازمی	string	English name; `nameTr` is the Turkish one.
`nameTr`لازمی	string

DayAbsenceDto

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

فیلڈ	قسم	وضاحت
`color`لازمی	string
`fraction`لازمی	number (double)	The day's approved absence coverage (0–1).
`half`	string \| null
`typeKey`	string \| null
`typeName`	string \| null
`unit`لازمی	string

DayAttendanceDto

Attendance of the day on the day plan.

فیلڈ	قسم	وضاحت
`expectedEnd`	string (date-time) \| null
`expectedStart`	string (date-time) \| null
`flexible`لازمی	boolean
`lateByMs`لازمی	integer (int64)
`lateToleranceMinutes`لازمی	integer (int32)
`leftEarly`لازمی	boolean
`leftEarlyByMs`لازمی	integer (int64)
`status`لازمی	string	`onTime`, `late`, `absent`, `notStarted`, `dayOff`, `onLeave`, `holiday`.
`targetMs`لازمی	integer (int64)	The plan's target (the Effectiveness % denominator).
`workday`لازمی	boolean

DayPlanDto

The day plan of one user's day.

فیلڈ	قسم	وضاحت
`absences`لازمی	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`لازمی	integer (int64)	Overtime target (`base × (1 − fLeave)`).
`holiday`	HolidayRefDto \| null
`kind`لازمی	string	`schedule`, `shift`, `dayOff` or `holiday`.
`leaveFraction`لازمی	number (double)	The approved absence coverage `f` (0–1).
`shifts`لازمی	PlanShiftDto[]	Shifts starting on the day, by start.
`targetMs`لازمی	integer (int64)	Effectiveness % denominator (`base × (1 − f)`).
`workday`لازمی	boolean

DayProductivityDto

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

فیلڈ	قسم	وضاحت
`effectivenessPct`	number (double) \| null	productive ÷ target × 100 (not capped); `null` without a target.
`neutralMs`لازمی	integer (int64)
`productiveMs`لازمی	integer (int64)
`productivityPct`	number (double) \| null	productive ÷ worked × 100, one decimal; `null` without worked time.
`targetMs`لازمی	integer (int64)
`unproductiveMs`لازمی	integer (int64)

DayTotalDto

One local day of a summary.

فیلڈ	قسم	وضاحت
`activeMs`لازمی	integer (int64)
`activeUserCount`لازمی	integer (int32)
`atWorkMs`لازمی	integer (int64)
`date`لازمی	string (date)
`idleMs`لازمی	integer (int64)
`neutralMs`لازمی	integer (int64)
`offlineMs`لازمی	integer (int64)
`privateMs`لازمی	integer (int64)
`productiveMs`لازمی	integer (int64)
`productivityPct`	number (double) \| null
`unproductiveMs`لازمی	integer (int64)

DomainTotalDto

فیلڈ	قسم	وضاحت
`activeMs`لازمی	integer (int64)
`categoryKey`	string \| null
`domain`لازمی	string
`level`	string \| null
`percentage`لازمی	number (double)

DomainUsageDto

فیلڈ	قسم	وضاحت
`activeMs`لازمی	integer (int64)
`categoryKey`	string \| null
`domain`لازمی	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).

فیلڈ	قسم	وضاحت
`dueAt`	string (date-time) \| null	The deadline of an unverified account (`Identity__EmailVerificationGraceHours` after its creation).
`state`لازمی	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}]).

فیلڈ	قسم	وضاحت
`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.

فیلڈ	قسم	وضاحت
`includeInactiveUsers`	boolean
`teamId`	string \| null
`userIds`	string \| null[] \| null

ExportJobDto

An export job as the panel lists and polls it.

فیلڈ	قسم	وضاحت
`createdAt`لازمی	string (date-time)
`dataset`لازمی	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`لازمی	string
`from`لازمی	string (date)
`groupBy`	string \| null
`id`لازمی	string (uuid)
`locale`لازمی	string
`progress`لازمی	integer (int32)	0–100.
`rowCount`	integer (int32) \| null
`startedAt`	string (date-time) \| null
`status`لازمی	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`لازمی	string (date)

ExportOptionsDto

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

فیلڈ	قسم	وضاحت
`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.

فیلڈ	قسم	وضاحت
`code`لازمی	string	Stable snake_case code (`required`, `too_long`, `invalid`, ...).
`field`لازمی	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).

فیلڈ	قسم	وضاحت
`half`	string \| null
`key`لازمی	string	Built-in key (`republic_day`, …) or `custom`.
`name`لازمی	string
`nameEn`لازمی	string
`nameTr`لازمی	string
`source`	string \| null	`builtin` or `tenant`.

HostUsageDto

فیلڈ	قسم	وضاحت
`activeMs`لازمی	integer (int64)
`domain`	string \| null
`host`لازمی	string
`level`لازمی	string
`levelSource`لازمی	string
`matchedKey`	string \| null	Key of the matching domain rule; `null` for the default.

InvitationEmail

What happened to the invitation e-mail.

فیلڈ	قسم	وضاحت
`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`لازمی	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.

فیلڈ	قسم	وضاحت
`expiresAt`لازمی	string
`id`لازمی	string (uuid)

InvitationResult

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

فیلڈ	قسم	وضاحت
`email`لازمی	InvitationEmail
`invitation`لازمی	InvitationRef
`member`لازمی	MemberDto

LevelContextDto

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

فیلڈ	قسم	وضاحت
`kind`لازمی	string	`user` (a `userId` filter: that user's current team), `team` (a `teamId` filter) or `company`.
`teamId`	string (uuid) \| null

MeDto

GET /v1/me.

فیلڈ	قسم	وضاحت
`access`لازمی	AccessDto
`capabilities`لازمی	CapabilitiesDto
`effectiveTimeZone`لازمی	string
`membership`لازمی	MeMembership
`organization`لازمی	MeOrganization
`organizations`لازمی	OrganizationChoice[]
`session`	MeSession \| null
`user`لازمی	MeUser

MeMembership

The membership in the current organization.

فیلڈ	قسم	وضاحت
`id`لازمی	string (uuid)
`isTracked`لازمی	boolean
`joinedAt`	string \| null
`role`لازمی	string
`status`لازمی	string
`teamId`	string (uuid) \| null
`teamName`	string \| null
`timeZone`	string \| null
`viewerTeamIds`لازمی	string (uuid)[]

MeOrganization

The current organization.

فیلڈ	قسم	وضاحت
`defaultLocale`لازمی	string
`id`لازمی	string (uuid)
`name`لازمی	string
`slug`لازمی	string
`status`لازمی	string
`timeZone`لازمی	string

MeSession

The current session.

فیلڈ	قسم	وضاحت
`absoluteExpiresAt`لازمی	string
`amr`لازمی	string[]
`authTime`لازمی	string
`clientId`لازمی	string
`id`لازمی	string (uuid)
`idleExpiresAt`لازمی	string

MeUser

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

فیلڈ	قسم	وضاحت
`email`لازمی	string
`emailVerification`لازمی	EmailVerificationDto	The e-mail verification gate (owner decision 3 Oct 2026).
`emailVerified`لازمی	boolean
`fullName`	string \| null
`id`لازمی	string (uuid)
`locale`لازمی	string

MemberDto

A membership with its person (MemberDto).

فیلڈ	قسم	وضاحت
`createdAt`لازمی	string
`email`لازمی	string
`emailVerified`لازمی	boolean
`fullName`	string \| null
`id`لازمی	string (uuid)
`invitation`	MemberInvitationDto \| null
`isTracked`لازمی	boolean
`joinedAt`	string \| null
`locale`لازمی	string
`role`لازمی	string	`owner`, `admin`, `team_admin`, `manager`, `employee`.
`status`لازمی	string	`invited`, `active`, `suspended`, `left`.
`teamId`	string (uuid) \| null
`teamName`	string \| null
`timeZone`	string \| null
`unassignedManager`لازمی	boolean	A Manager with neither a team nor viewer teams (sees the whole company until assigned).
`userId`لازمی	string (uuid)
`viewerTeamIds`لازمی	string (uuid)[]

MemberInvitationDto

The invitation of an invited member.

فیلڈ	قسم	وضاحت
`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`لازمی	string
`id`لازمی	string (uuid)
`lastSentAt`لازمی	string
`sentCount`لازمی	integer (int32)

MemberPage

A page of members (OpenAPI).

فیلڈ	قسم	وضاحت
`items`لازمی	MemberDto[]
`nextCursor`	string \| null

MemberRefDto

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

فیلڈ	قسم	وضاحت
`active`لازمی	boolean	The membership is active and (for an endpoint or a tenant connection) still an Owner or Admin.
`name`	string \| null
`userId`لازمی	string (uuid)

NamedRefDto

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

فیلڈ	قسم	وضاحت
`id`لازمی	string (uuid)
`name`لازمی	string

OrganizationChoice

One organization of the person (sec.user_memberships).

فیلڈ	قسم	وضاحت
`current`لازمی	boolean
`id`لازمی	string (uuid)
`name`لازمی	string
`role`لازمی	string
`selectable`لازمی	boolean	Can this session's sign-in method open it (design §4.5.3)?

PatchMember

PATCH /v1/members/{id}.

فیلڈ	قسم	وضاحت
`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}.

فیلڈ	قسم	وضاحت
`description`	string \| null
`name`	string \| null

PeriodReportDto

GET /v1/reports/productivity.

فیلڈ	قسم	وضاحت
`from`لازمی	string (date)
`groupBy`لازمی	string
`levelContext`لازمی	LevelContextDto
`periods`لازمی	ReportPeriodDto[]
`subject`لازمی	ReportSubjectDto
`teams`لازمی	TeamPeriodsDto[]	Only for the company subject: every visible team over its current members.
`to`لازمی	string (date)
`totals`لازمی	ReportFiguresDto

PlanAbsenceDto

فیلڈ	قسم	وضاحت
`color`لازمی	string
`countsAsWorked`لازمی	boolean	`timeEffect == worked`.
`endTime`	string \| null
`half`	string \| null
`id`لازمی	string (uuid)
`startTime`	string \| null	Local start and end of an `hours` absence.
`status`لازمی	string	`approved` or `pending`.
`timeEffect`لازمی	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`لازمی	string	`days`, `half_day` or `hours`.

PlanShiftDto

فیلڈ	قسم	وضاحت
`color`	string \| null
`end`لازمی	string (date-time)
`endTime`لازمی	string	Local end; before the start for a night shift.
`id`لازمی	string (uuid)
`location`لازمی	string
`minMinutes`لازمی	integer (int32)
`start`لازمی	string (date-time)
`startTime`لازمی	string	Local start (`HH:mm`, the shift's zone).

Problem

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

فیلڈ	قسم	وضاحت
`action`	string \| null	Permission key of a 403 (`teams.create`).
`code`لازمی	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`لازمی	integer (int32)
`title`لازمی	string	English title of the code (clients translate `code`).
`traceId`	string \| null	W3C trace id of the request.
`type`لازمی	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).

فیلڈ	قسم	وضاحت
`billableMinor`لازمی	integer (int64)	The billable hours at their rate.
`costMinor`لازمی	integer (int64)	Every allocated hour at its rate.
`currency`لازمی	string

ProjectBudgetUsageDto

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

فیلڈ	قسم	وضاحت
`budgetMinor`	integer (int64) \| null	`null` unless `costsIncluded`.
`budgetMinutes`	integer (int64) \| null
`kind`لازمی	string	`hours` or `amount`.
`projectId`لازمی	string (uuid)
`usedMinor`	integer (int64) \| null	The cost in the project's currency; `null` unless `costsIncluded`.
`usedMs`لازمی	integer (int64)
`usedRatio`	string \| null	Used / budget, 4 decimals (`null` for an amount budget without `costsIncluded`).

ProjectDto

A project.

فیلڈ	قسم	وضاحت
`access`لازمی	string	`everyone` or `members`.
`archived`لازمی	boolean
`budget`	BudgetDto \| null
`client`	NamedRefDto \| null
`code`	string \| null
`color`	string \| null
`createdAt`لازمی	string (date-time)
`currency`لازمی	string	The currency of the project's rates and amount budget.
`description`	string \| null
`endDate`	string (date) \| null
`id`لازمی	string (uuid)
`isBillable`لازمی	boolean
`memberCount`لازمی	integer (int64)
`myRole`	string \| null	The caller's role in the project team (`member`, `manager`), `null` outside it.
`name`لازمی	string
`permissions`لازمی	ProjectPermissionsDto
`spentMs`لازمی	integer (int64)	Every allocation of the project, all time.
`startDate`	string (date) \| null
`status`لازمی	string	`active`, `on_hold` or `completed`.
`taskCount`لازمی	integer (int64)
`updatedAt`لازمی	string (date-time)

ProjectPage

GET /v1/projects.

فیلڈ	قسم	وضاحت
`items`لازمی	ProjectDto[]
`nextCursor`	string \| null

ProjectPermissionsDto

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

فیلڈ	قسم	وضاحت
`archive`لازمی	boolean
`delete`لازمی	boolean	Only a project without time.
`edit`لازمی	boolean	The project's fields (Owners and Admins).
`manageMembers`لازمی	boolean	The team (an Admin or the project's manager; only an Admin changes managers).
`manageTasks`لازمی	boolean	Tasks (an Admin or the project's manager).
`track`لازمی	boolean	The caller may track time on it now.

ProjectRefDto

A project reference of an allocation.

فیلڈ	قسم	وضاحت
`color`	string \| null	`#RRGGBB`.
`id`لازمی	string (uuid)
`name`لازمی	string

ProjectReportDto

GET /v1/reports/projects.

فیلڈ	قسم	وضاحت
`budgets`لازمی	ProjectBudgetUsageDto[]
`costsIncluded`لازمی	boolean	The caller sees rates and amounts (`projects.costs.read`).
`from`لازمی	string (date)
`groupBy`لازمی	string[]
`rows`لازمی	ProjectReportRowDto[]
`to`لازمی	string (date)
`totals`لازمی	ProjectReportTotalsDto

ProjectReportKeysDto

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

فیلڈ	قسم	وضاحت
`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.

فیلڈ	قسم	وضاحت
`allocatedMs`لازمی	integer (int64)
`amounts`	ProjectAmountDto[] \| null	`null` unless `costsIncluded`.
`billableMs`لازمی	integer (int64)
`keys`لازمی	ProjectReportKeysDto
`nonBillableMs`لازمی	integer (int64)
`productiveMs`	integer (int64) \| null	With `includeProductive` only.
`unratedMs`لازمی	integer (int64)	Time without any rate (it is left out of the amounts).

ProjectReportTotalsDto

The totals of the report.

فیلڈ	قسم	وضاحت
`allocatedMs`لازمی	integer (int64)
`amounts`	ProjectAmountDto[] \| null
`billableMs`لازمی	integer (int64)
`nonBillableMs`لازمی	integer (int64)
`productiveMs`	integer (int64) \| null
`unratedMs`لازمی	integer (int64)

ProjectRequest

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

فیلڈ	قسم	وضاحت
`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).

فیلڈ	قسم	وضاحت
`absenceCreditMs`لازمی	integer (int64)
`absentDays`لازمی	integer (int32)
`activeMs`لازمی	integer (int64)
`activeUserCount`لازمی	integer (int32)
`effectivenessPct`	number (double) \| null
`idleMs`لازمی	integer (int64)
`lateDays`لازمی	integer (int32)
`leaveDays`لازمی	number (double)
`leftEarlyDays`لازمی	integer (int32)
`neutralMs`لازمی	integer (int64)
`offlineMs`لازمی	integer (int64)
`overtimeDays`لازمی	integer (int32)
`overtimeMs`لازمی	integer (int64)
`productiveMs`لازمی	integer (int64)
`productivityPct`	number (double) \| null
`targetMs`لازمی	integer (int64)
`unproductiveMs`لازمی	integer (int64)
`userCount`لازمی	integer (int32)
`workedMs`لازمی	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).

فیلڈ	قسم	وضاحت
`kind`لازمی	string	`company`, `teams` or `self`.
`teamIds`لازمی	string (uuid)[]	The visible teams of a `teams` scope, sorted; empty otherwise (company = all).
`unassignedFallback`لازمی	boolean	A Manager without teams who sees the whole company until assigned.

ReportSubjectDto

Whom a report is about.

فیلڈ	قسم	وضاحت
`id`	string (uuid) \| null
`kind`لازمی	string	`company`, `team` or `user`.
`name`	string \| null

RotatedWebhookSecretDto

RotatedWebhookSecretDto: the new signing secret, shown once.

فیلڈ	قسم	وضاحت
`previousSecretExpiresAt`لازمی	string	Until then deliveries carry both signatures.
`secret`لازمی	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.

فیلڈ	قسم	وضاحت
`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.

فیلڈ	قسم	وضاحت
`breakMinutes`لازمی	integer (int32)
`color`	string \| null
`createdAt`لازمی	string (date-time)
`createdBy`لازمی	CalendarUserRefDto
`crossesMidnight`لازمی	boolean
`date`لازمی	string (date)
`durationMinutes`لازمی	integer (int32)
`end`لازمی	string (date-time)
`endTime`لازمی	string
`id`لازمی	string (uuid)
`location`لازمی	string
`minMinutes`لازمی	integer (int32)
`note`	string \| null
`open`لازمی	boolean	No user assigned.
`permissions`لازمی	ShiftPermissionsDto
`source`لازمی	string	`manual`, `template`, `copy` or `request`.
`start`لازمی	string (date-time)
`startTime`لازمی	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`لازمی	string
`updatedAt`لازمی	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).

فیلڈ	قسم	وضاحت
`items`لازمی	ShiftDto[]

ShiftPermissionsDto

فیلڈ	قسم	وضاحت
`canDelete`لازمی	boolean
`canEdit`لازمی	boolean
`canPickUp`لازمی	boolean
`canRequestSwap`لازمی	boolean

SummaryDto

The summary of the visible users over a range.

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

TargetItemDto

فیلڈ	قسم	وضاحت
`activeMs`لازمی	integer (int64)
`categoryKey`	string \| null
`categorySource`لازمی	string	`tenant`, `builtin` or `none`.
`domain`	string \| null
`level`لازمی	string
`levelSource`لازمی	string	`team`, `company` or `default`.
`matchedKey`	string \| null
`name`لازمی	string
`percentage`لازمی	number (double)
`targetKey`لازمی	string
`targetType`لازمی	string	`app` for apps, `domain` for domains and hosts.
`userCount`لازمی	integer (int32)

TargetListDto

The "Apps & URLs" list.

فیلڈ	قسم	وضاحت
`from`لازمی	string (date)
`items`لازمی	TargetItemDto[]	By active time descending, then key.
`levelContext`لازمی	LevelContextDto
`nextCursor`	string \| null
`to`لازمی	string (date)
`total`لازمی	integer (int32)	Targets matching the filters (before paging).
`totalActiveMs`لازمی	integer (int64)	Active time over every target of the type before the filters (the percentage base).
`type`لازمی	string	`app`, `domain` or `host`.

TaskDto

A task.

فیلڈ	قسم	وضاحت
`archived`لازمی	boolean
`assignee`	NamedRefDto \| null
`createdAt`لازمی	string (date-time)
`description`	string \| null
`dueDate`	string (date) \| null
`effectiveBillable`لازمی	boolean
`estimateMinutes`	integer (int64) \| null
`id`لازمی	string (uuid)
`isBillable`	boolean \| null	`null` takes the project's value.
`name`لازمی	string
`permissions`لازمی	TaskPermissionsDto
`projectId`لازمی	string (uuid)
`sortOrder`لازمی	integer (int64)
`spentMs`لازمی	integer (int64)
`status`لازمی	string	`open`, `in_progress` or `done`.
`updatedAt`لازمی	string (date-time)

TaskPage

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

فیلڈ	قسم	وضاحت
`items`لازمی	TaskDto[]
`nextCursor`	string \| null

TaskPermissionsDto

What the caller may do with a task.

فیلڈ	قسم	وضاحت
`delete`لازمی	boolean	Only a task without time.
`edit`لازمی	boolean

TaskRequest

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

فیلڈ	قسم	وضاحت
`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).

فیلڈ	قسم	وضاحت
`archivedAt`	string \| null
`createdAt`لازمی	string
`description`	string \| null
`id`لازمی	string (uuid)
`leads`لازمی	object[]	TeamAdmins and Managers of the team: `[{membershipId, userId, fullName, role}]`.
`memberCount`لازمی	integer (int64)	Members whose primary team this is (left members excluded).
`name`لازمی	string
`updatedAt`لازمی	string

TeamPage

A page of teams (OpenAPI).

فیلڈ	قسم	وضاحت
`items`لازمی	TeamDto[]
`nextCursor`	string \| null

TeamPeriodsDto

فیلڈ	قسم	وضاحت
`periods`لازمی	ReportPeriodDto[]
`teamId`لازمی	string (uuid)
`teamName`	string \| null
`totals`لازمی	ReportFiguresDto

TeamTotalDto

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

فیلڈ	قسم	وضاحت
`absenceCreditMs`لازمی	integer (int64)
`absentDays`لازمی	integer (int32)
`activeMs`لازمی	integer (int64)
`activeUserCount`لازمی	integer (int32)
`effectivenessPct`	number (double) \| null
`holidayDays`لازمی	number (double)
`idleMs`لازمی	integer (int64)
`lateDays`لازمی	integer (int32)
`leaveDays`لازمی	number (double)
`leftEarlyDays`لازمی	integer (int32)
`memberCount`لازمی	integer (int32)
`neutralMs`لازمی	integer (int64)
`offlineMs`لازمی	integer (int64)
`overtimeMs`لازمی	integer (int64)
`productiveMs`لازمی	integer (int64)
`productivityPct`	number (double) \| null
`shiftDays`لازمی	integer (int32)
`teamId`	string (uuid) \| null	`null` for the users without a team.
`teamName`	string \| null
`unproductiveMs`لازمی	integer (int64)
`workedMs`لازمی	integer (int64)

TimeEntryDecisionRequest

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

فیلڈ	قسم	وضاحت
`decision`	string \| null	`approve` or `reject`.
`note`	string \| null	At most 500 characters.

TimeEntryDto

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

فیلڈ	قسم	وضاحت
`createdAt`لازمی	string (date-time)
`createdBy`لازمی	TimeEntryUserRefDto
`date`لازمی	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`لازمی	integer (int64)
`end`لازمی	string (date-time)
`id`لازمی	string (uuid)
`kind`لازمی	string	`offline` or `deletion`.
`level`	string \| null	Offline: `productive`, `neutral` or `unproductive`; deletion: `null`.
`permissions`لازمی	TimeEntryPermissionsDto
`projectId`	string (uuid) \| null	Always `null` until projects (Phase 6).
`source`لازمی	string	`manual` (Phase 8 adds `calendar`).
`start`لازمی	string (date-time)
`status`لازمی	string	`pending`, `approved` or `rejected`.
`timeZone`لازمی	string
`updatedAt`لازمی	string (date-time)
`userId`لازمی	string (uuid)

TimeEntryPage

GET /v1/time-entries: by start.

فیلڈ	قسم	وضاحت
`items`لازمی	TimeEntryDto[]
`nextCursor`	string \| null

TimeEntryPermissionsDto

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

فیلڈ	قسم	وضاحت
`canApprove`لازمی	boolean
`canDelete`لازمی	boolean
`canEdit`لازمی	boolean

TimeEntryUserRefDto

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

فیلڈ	قسم	وضاحت
`fullName`	string \| null
`id`لازمی	string (uuid)

TimeIntervalDto

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

فیلڈ	قسم	وضاحت
`end`لازمی	string (date-time)
`start`لازمی	string (date-time)

TimerAtRequest

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

فیلڈ	قسم	وضاحت
`at`	string (date-time) \| null

TimerCommandResultDto

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

فیلڈ	قسم	وضاحت
`applied`لازمی	boolean
`closed`لازمی	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`لازمی	TimerDto

TimerDto

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

فیلڈ	قسم	وضاحت
`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`لازمی	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`لازمی	string	`running` or `stopped`.
`task`	NamedRefDto \| null

TimerLastDto

The segment that ended last.

فیلڈ	قسم	وضاحت
`endReason`لازمی	string	`stop`, `switch`, `autostop` or `discard`.
`endedAt`لازمی	string (date-time)
`segmentId`لازمی	string (uuid)
`startedAt`لازمی	string (date-time)

TimerProjectDto

The project of the running segment.

فیلڈ	قسم	وضاحت
`clientName`	string \| null
`color`	string \| null
`id`لازمی	string (uuid)
`name`لازمی	string

TimerStartRequest

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

فیلڈ	قسم	وضاحت
`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).

فیلڈ	قسم	وضاحت
`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).

فیلڈ	قسم	وضاحت
`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.

فیلڈ	قسم	وضاحت
`days`لازمی	UserDayDto[]
`from`لازمی	string (date)
`teamId`	string (uuid) \| null	The user's current primary team (its rules classify every day).
`timeZone`لازمی	string
`to`لازمی	string (date)
`userId`لازمی	string (uuid)

UserDayDto

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

UserTotalDto

One user of a summary.

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

WebhookDeliveryDetailDto

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

WebhookDeliveryDto

WebhookDeliveryDto.

فیلڈ	قسم	وضاحت
`attempts`لازمی	integer (int32)
`createdAt`لازمی	string
`deliveredAt`	string \| null
`eventId`لازمی	string (uuid)	The `webhook-id` header.
`eventType`لازمی	string
`id`لازمی	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`لازمی	string	`pending`, `succeeded`, `failed`, `dead`.

WebhookDeliveryPage

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

فیلڈ	قسم	وضاحت
`items`لازمی	WebhookDeliveryDto[]
`nextCursor`	string \| null

WebhookEndpointDto

WebhookEndpointDto.

فیلڈ	قسم	وضاحت
`createdAt`لازمی	string
`description`	string \| null
`eventTypes`لازمی	string[]
`id`لازمی	string (uuid)
`owner`لازمی	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`لازمی	string	The first 8 characters of the signing secret (`whsec_Kx`); never the secret.
`stats`لازمی	WebhookEndpointStatsDto
`status`لازمی	string	`active`, `paused`, `disabled`.
`statusReason`	string \| null	`manual`, `owner_inactive`, `failing`, `gone`; `null` while active.
`updatedAt`لازمی	string
`url`لازمی	string
`version`لازمی	integer (int64)	`row_version` (`ETag: "v<n>"`, `If-Match` of `PATCH`).

WebhookEndpointPage

GET /v1/webhook-endpoints.

فیلڈ	قسم	وضاحت
`items`لازمی	WebhookEndpointDto[]
`nextCursor`	string \| null

WebhookEndpointStatsDto

The delivery statistics of an endpoint.

فیلڈ	قسم	وضاحت
`consecutiveFailures`لازمی	integer (int32)
`lastFailureAt`	string \| null
`lastSuccessAt`	string \| null

WebhookEventDto

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

فیلڈ	قسم	وضاحت
`available`لازمی	boolean	The tenant's plan has the feature: an endpoint may subscribe.
`description`لازمی	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`لازمی	string	The `data.object` of the delivery body.
`type`لازمی	string	`<object>.<verb>`, e.g. `time_entry.approved`.

WebhookEventsDto

GET /v1/webhook-events.

فیلڈ	قسم	وضاحت
`items`لازمی	WebhookEventDto[]

WebhookTestDto

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

فیلڈ	قسم	وضاحت
`deliveryId`لازمی	string	The delivery of the test event (a string: the deliveries' id is a 64-bit integer).

پبلک API ریفرنس

تصدیق

اسکوپس

ریٹ لمٹس

ایررز

ویب ہُکس

آپریشنز

غیر حاضریاں

GET /v1/absences اسکوپ: reports:read

پیرامیٹرز

POST /v1/absences اسکوپ: time:write

پیرامیٹرز

POST /v1/absences/{id}/decision اسکوپ: time:write

پیرامیٹرز

سرگرمی

GET /v1/activity/day اسکوپ: reports:read

پیرامیٹرز

وقت کی تفویض

GET /v1/allocations اسکوپ: reports:read

پیرامیٹرز

POST /v1/allocations اسکوپ: time:write

پیرامیٹرز

ایکسپورٹس

POST /v1/exports اسکوپ: reports:read

پیرامیٹرز

GET /v1/exports/{id} اسکوپ: reports:read

پیرامیٹرز

میری پروفائل

GET /v1/me اسکوپ: me

ارکان

POST /v1/invitations اسکوپ: org:admin

پیرامیٹرز

GET /v1/members اسکوپ: org:admin

پیرامیٹرز

GET /v1/members/{id} اسکوپ: org:admin

پیرامیٹرز

PATCH /v1/members/{id} اسکوپ: org:admin

پیرامیٹرز

POST /v1/members/{id}/reactivate اسکوپ: org:admin

پیرامیٹرز

POST /v1/members/{id}/suspend اسکوپ: org:admin

پیرامیٹرز

پروجیکٹس

GET /v1/projects اسکوپ: reports:read

پیرامیٹرز

POST /v1/projects اسکوپ: org:admin

پیرامیٹرز

GET /v1/projects/{id} اسکوپ: reports:read

پیرامیٹرز

PUT /v1/projects/{id} اسکوپ: org:admin

پیرامیٹرز

رپورٹس

GET /v1/reports/productivity اسکوپ: reports:read

پیرامیٹرز

GET /v1/reports/projects اسکوپ: reports:read

پیرامیٹرز

GET /v1/reports/summary اسکوپ: reports:read

پیرامیٹرز

GET /v1/reports/targets اسکوپ: reports:read

پیرامیٹرز

GET /v1/reports/users/{userId}/daily اسکوپ: reports:read

پیرامیٹرز

شفٹیں

GET /v1/shifts اسکوپ: reports:read

پیرامیٹرز

POST /v1/shifts اسکوپ: time:write

پیرامیٹرز

ٹاسکس

GET /v1/projects/{id}/tasks اسکوپ: reports:read

پیرامیٹرز

POST /v1/projects/{id}/tasks اسکوپ: time:write

پیرامیٹرز

GET /v1/tasks/{id} اسکوپ: reports:read

پیرامیٹرز

PUT /v1/tasks/{id} اسکوپ: time:write

پیرامیٹرز

ٹیمیں

GET /v1/teams اسکوپ: reports:read

پیرامیٹرز

POST /v1/teams اسکوپ: org:admin

GET `/v1/absences` اسکوپ: `reports:read`

POST `/v1/absences` اسکوپ: `time:write`

POST `/v1/absences/{id}/decision` اسکوپ: `time:write`

GET `/v1/activity/day` اسکوپ: `reports:read`

GET `/v1/allocations` اسکوپ: `reports:read`

POST `/v1/allocations` اسکوپ: `time:write`

POST `/v1/exports` اسکوپ: `reports:read`

GET `/v1/exports/{id}` اسکوپ: `reports:read`

GET `/v1/me` اسکوپ: `me`

POST `/v1/invitations` اسکوپ: `org:admin`

GET `/v1/members` اسکوپ: `org:admin`

GET `/v1/members/{id}` اسکوپ: `org:admin`

PATCH `/v1/members/{id}` اسکوپ: `org:admin`

POST `/v1/members/{id}/reactivate` اسکوپ: `org:admin`

POST `/v1/members/{id}/suspend` اسکوپ: `org:admin`

GET `/v1/projects` اسکوپ: `reports:read`

POST `/v1/projects` اسکوپ: `org:admin`

GET `/v1/projects/{id}` اسکوپ: `reports:read`

PUT `/v1/projects/{id}` اسکوپ: `org:admin`

GET `/v1/reports/productivity` اسکوپ: `reports:read`

GET `/v1/reports/projects` اسکوپ: `reports:read`

GET `/v1/reports/summary` اسکوپ: `reports:read`

GET `/v1/reports/targets` اسکوپ: `reports:read`

GET `/v1/reports/users/{userId}/daily` اسکوپ: `reports:read`

GET `/v1/shifts` اسکوپ: `reports:read`

POST `/v1/shifts` اسکوپ: `time:write`

GET `/v1/projects/{id}/tasks` اسکوپ: `reports:read`

POST `/v1/projects/{id}/tasks` اسکوپ: `time:write`

GET `/v1/tasks/{id}` اسکوپ: `reports:read`

PUT `/v1/tasks/{id}` اسکوپ: `time:write`

GET `/v1/teams` اسکوپ: `reports:read`

POST `/v1/teams` اسکوپ: `org:admin`

PATCH `/v1/teams/{id}` اسکوپ: `org:admin`

GET `/v1/time-entries` اسکوپ: `reports:read`

POST `/v1/time-entries` اسکوپ: `time:write`

GET `/v1/time-entries/{id}` اسکوپ: `reports:read`

PUT `/v1/time-entries/{id}` اسکوپ: `time:write`

DELETE `/v1/time-entries/{id}` اسکوپ: `time:write`

POST `/v1/time-entries/{id}/decision` اسکوپ: `time:write`

GET `/v1/me/timer` اسکوپ: `me`

POST `/v1/me/timer/start` اسکوپ: `me`

POST `/v1/me/timer/stop` اسکوپ: `me`

GET `/v1/webhook-endpoints` اسکوپ: `webhooks:manage`

POST `/v1/webhook-endpoints` اسکوپ: `webhooks:manage`

GET `/v1/webhook-endpoints/{id}` اسکوپ: `webhooks:manage`

PATCH `/v1/webhook-endpoints/{id}` اسکوپ: `webhooks:manage`

DELETE `/v1/webhook-endpoints/{id}` اسکوپ: `webhooks:manage`

GET `/v1/webhook-endpoints/{id}/deliveries` اسکوپ: `webhooks:manage`

GET `/v1/webhook-endpoints/{id}/deliveries/{deliveryId}` اسکوپ: `webhooks:manage`

POST `/v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retry` اسکوپ: `webhooks:manage`

POST `/v1/webhook-endpoints/{id}/rotate-secret` اسکوپ: `webhooks:manage`

POST `/v1/webhook-endpoints/{id}/test` اسکوپ: `webhooks:manage`

GET `/v1/webhook-events` اسکوپ: `webhooks:manage`