Public API reference

The Workify360 Focus public API lets your own scripts and tools read reports and time data and make changes with the same rules as the dashboard. The public API, API keys and webhooks are part of the Premium plan.

The operations on this page are kept backward compatible. The machine-readable OpenAPI document of the same operations:

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

Generated from the API contract version 0.1.0 (c95fb97bb49a).

Authentication

Send a personal API key in the Authorization header of every request. A key belongs to the person who created it, acts as that person and never does more than their current role allows. A request with a missing, wrong, expired or revoked key gets 401 with the code unauthorized.

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

How to create, scope and revoke keys: API keys and the public API

Scopes

Each operation needs one scope, shown next to it. A key reaches an operation when it holds that scope and its owner's current role, teams and plan allow the request, exactly as in the dashboard.

Scope	What it allows
`me`	Your own profile and your timer
`reports:read`	Reading reports, time entries, absences, shifts, teams, projects, tasks and exports
`time:write`	Adding and changing time entries, absences, shifts, tasks and time assigned to tasks, and deciding requests
`org:admin`	Managing members, teams, invitations and projects
`webhooks:manage`	Managing webhook endpoints

Rate limits

Each key may send 600 units per minute and an organization 1,800 for all its keys together. A request that changes something (anything other than GET and HEAD) counts as two units, any other request as one. A key can also send at most 60 units at once, refilled at 10 per second: more than 60 reads (or 30 changes) in a burst get 429 even under 600 a minute.

Header	Meaning
`RateLimit: "key";r=598;t=2`	On every counted answer: the units the key has left and the seconds until they are full again
`RateLimit-Policy: "key";q=600;w=60, "tenant";q=1800;w=60`	On every counted answer: the per-minute limits of the key and of the organization
`Retry-After: 12`	With 429 (code `rate_limited`): the seconds to wait before the next request

Errors

An error is an RFC 9457 problem document (Content-Type: application/problem+json). code is a stable snake_case code to program against; title is an English text for logs. type is the help address of the code, https://workify360.com/help/errors/<code>/ with each _ written as -, which opens the help article that explains the code when the code has one.

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

Some problems carry more fields: errors (the field errors of 422 validation_failed), action (the permission a 403 forbidden refers to), requiredPlan (402 feature_not_in_plan), retryAfterSeconds (429 and 503) and traceId (quote it when you contact support).

Status	Code	When
400	`invalid_request`	A parameter is malformed or missing
401	`unauthorized`	The key is missing, wrong, expired or revoked, or its owner left the organization
402	`feature_not_in_plan`, `subscription_read_only`	The plan does not include the feature, or the subscription is read-only
403	`forbidden`, `feature_not_enabled`	The key lacks the scope, or its owner's current role, teams or settings do not allow the request
412	`version_conflict`	The `If-Match` version is no longer current; read the resource again
422	`validation_failed`	The body is invalid; `errors` lists the fields
428	`precondition_required`	The operation needs an `If-Match` header with the version you read
429	`rate_limited`	Too many requests; wait the seconds in `Retry-After`

Codes with a help article are links in the operation list.

Webhooks

Instead of asking the API again and again, an endpoint of yours can receive a signed HTTPS request when something changes. The events, the request format, how to verify the signature in Node.js and Python, retries and secret rotation are explained in the help article: Webhooks

Operations

Grouped by area. The summaries and field descriptions come from the API contract.

Absences

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

List absences overlapping a range.

Parameters

Name	In	Type	Description
`from`	query	string (date)
`to`	query	string (date)	At most 366 days after `from`.
`userId`	query	string (uuid)
`teamId`	query	string (uuid)
`status`	query	string
`typeId`	query	string (uuid)
`cursor`	query	string
`limit`	query	integer (int32)

Responses

200 AbsencePage

Errors

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

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

Request (or record) an absence.

Parameters

Name	In	Type	Description
`Idempotency-Key`required	header	string	Required: the same key and body return the first answer

Request body

AbsenceRequest

Responses

201 AbsenceDto

Errors

400 invalid_absence_unit, invalid_absence_range, invalid_half, unit_not_allowed, range_too_far
402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)
404 absence_type_not_found
409 overlaps_absence, insufficient_balance, absence_type_inactive

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

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

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Id
`If-Match`required	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Request body

CalendarDecisionRequest

Responses

200 AbsenceDto

Errors

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)

Activity

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

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

Parameters

Name	In	Type	Description
`date`	query	string (date)	The user's local day (required).
`userId`	query	string (uuid)	Default: the caller; another user must be visible (else 403).

Responses

200 ActivityDayDto

Errors

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

Time allocations

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

A person's allocations of a range of local days (the caller's, the people they manage, and the time on the projects they manage).

Parameters

Name	In	Type	Description
`userId`	query	string (uuid)	Default: the caller.
`from`	query	string (date)	Local date, included.
`to`	query	string (date)	Local date, included; at most 93 days after `from`.
`projectId`	query	string (uuid)
`cursor`	query	string
`limit`	query	integer (int32)	1–200 (default 200).

Responses

200 AllocationPage

Errors

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

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

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

Parameters

Name	In	Type	Description
`Idempotency-Key`	header	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Request body

AllocationCreateRequest

Responses

201 AllocationCreatedDto

Errors

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

Exports

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

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

Parameters

Name	In	Type	Description
`Idempotency-Key`required	header	string	Required: the same key and body return the first answer

Request body

CreateExportRequest

Responses

202 ExportJobDto

Errors

400 invalid_dataset, range_too_long, too_many_columns_for_pdf
402 feature_not_in_plan
403 forbidden (action = the permission; a user or team outside the scope; includeCosts without the right to see amounts)
404 template_not_found
409 export_not_available
422 validation_failed
429 too_many_exports
503 export_storage_unavailable

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

One export job (poll every 2 s).

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Id

Responses

200 ExportJobDto

Errors

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

Me

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

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

Responses

200 MeDto

Errors

401 unauthorized

Members

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

Invite a person.

Parameters

Name	In	Type	Description
`Idempotency-Key`required	header	string	Required: 1–255 printable ASCII characters

Request body

CreateInvitation

Responses

201 InvitationResult

Errors

409 already_member
422 validation_failed, idempotency_key_reused

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

List members.

Parameters

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

Responses

200 MemberPage

Errors

403 No right

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

One member.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Membership id

Responses

200 MemberDto

Errors

404 member_not_found

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

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

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Membership id
`If-Match`required	header	string	ETag of the member ("v<n>")

Request body

PatchMember

Responses

200 MemberDto

Errors

400 self_change_forbidden, owner_immutable, role_not_assignable, team_required, viewer_teams_not_allowed
412 version_conflict
428 precondition_required

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

Reactivate a suspended member.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Membership id

Responses: 200 MemberDto

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

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

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Membership id

Responses

200 MemberDto

Errors

409 conflict (an invitation is revoked instead)

Projects

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

The projects the caller sees (Owners and Admins: all; others: open ones, their teams and, read only, the projects of the people they manage).

Parameters

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

Responses

200 ProjectPage

Errors

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

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

Add a project (Owners and Admins).

Parameters

Name	In	Type	Description
`Idempotency-Key`	header	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Request body

ProjectRequest

Responses

201 ProjectDto

Errors

402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)
404 client_not_found
409 project_name_taken, project_code_taken
422 validation_failed (errors[] = field codes)

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

One project (invisible projects are 404).

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Project id

Responses

200 ProjectDto

Errors

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

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

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

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Project id
`If-Match`required	header	string	The ETag the caller read (412 version_conflict when it changed)

Request body

ProjectRequest

Responses

200 ProjectDto

Errors

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)

Reports

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

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

Parameters

Name	In	Type	Description
`from`	query	string (date)
`to`	query	string (date)	`day` 93 days, `week`, `month` and `range` 366.
`groupBy`	query	string	`day`, `week`, `month` or `range`.
`teamId`	query	string (uuid)
`userId`	query	string (uuid)

Responses

200 PeriodReportDto

Errors

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

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

Allocated time, billable time and the rate-layered amounts (Owners and Admins) of projects in a range, grouped by one or two of project, task, user, client and day, with the projects' budget use.

Parameters

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

Responses

200 ProjectReportDto

Errors

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

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

The summary of the visible users over a range.

Parameters

Name	In	Type	Description
`from`	query	string (date)
`to`	query	string (date)	At most 93 days after `from`.
`teamId`	query	string (uuid)	Only the team's current members; the team must be visible (else 403).

Responses

200 SummaryDto

Errors

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

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

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

Parameters

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

Responses

200 TargetListDto

Errors

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

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

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

Parameters

Name	In	Type	Description
`userId`required	path	string (uuid)	User
`from`	query	string (date)
`to`	query	string (date)	At most 93 days after `from`.

Responses

200 UserDailyDto

Errors

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

Shifts

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

List the shifts starting in a range.

Parameters

Name	In	Type	Description
`from`	query	string (date)
`to`	query	string (date)
`teamId`	query	string (uuid)
`userId`	query	string (uuid)
`includeOpen`	query	boolean	Also open shifts (default true).

Responses

200 ShiftListDto

Errors

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

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

Create a shift (assigned or open).

Parameters

Name	In	Type	Description
`Idempotency-Key`required	header	string	Required: the same key and body return the first answer

Request body

ShiftBody

Responses

201 ShiftDto

Errors

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

Tasks

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

A visible project's tasks, by sort order.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Project id
`status`	query	string	`open`, `in_progress` or `done`.
`assigneeUserId`	query	string (uuid)
`includeArchived`	query	boolean
`cursor`	query	string
`limit`	query	integer (int32)	1–500 (default 200).

Responses

200 TaskPage

Errors

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

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

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

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Project id
`Idempotency-Key`	header	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Request body

TaskRequest

Responses

201 TaskDto

Errors

402 feature_not_in_plan, subscription_read_only
403 forbidden, project_not_trackable (the assignee)
404 project_not_found
409 task_name_taken
422 validation_failed (errors[] = field codes)

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

One task of a visible project.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Task id

Responses

200 TaskDto

Errors

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

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

Change a task (the whole body).

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Task id
`If-Match`required	header	string	The ETag the caller read (412 version_conflict when it changed)

Request body

TaskRequest

Responses

200 TaskDto

Errors

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)

Teams

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

List teams.

Parameters

Name	In	Type	Description
`includeArchived`	query	boolean	Also archived teams (default false)
`cursor`	query	string	Opaque cursor of the next page
`limit`	query	integer (int32)	1–200, default 50

Responses: 200 TeamPage

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

Create a team (the G1 endpoint).

Request body

CreateTeam

Responses

201 TeamDto

Errors

403 forbidden (action teams.create)
409 team_name_taken

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

Rename a team or change its description.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Team id
`If-Match`required	header	string	ETag of the team

Request body

PatchTeam

Responses

200 TeamDto

Errors

409 team_name_taken

Time entries

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

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

Parameters

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

Responses

200 TimeEntryPage

Errors

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

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

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

Parameters

Name	In	Type	Description
`Idempotency-Key`required	header	string	Required: the same key and body return the first answer

Request body

CreateTimeEntryRequest

Responses

201 TimeEntryDto

Errors

400 invalid_time_range, range_not_in_one_day, range_in_future, range_too_old, invalid_description, invalid_level, invalid_kind, project_not_supported
402 feature_not_in_plan, subscription_read_only
403 forbidden, offline_time_disabled, time_editing_disabled
404 user_not_found
409 overlaps_entry

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

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

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Entry id

Responses

200 TimeEntryDto

Errors

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

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

Replace an entry's editable fields.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Entry id
`If-Match`required	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Request body

UpdateTimeEntryRequest

Responses

200 TimeEntryDto

Errors

400 invalid_time_range, range_not_in_one_day, range_in_future, range_too_old, invalid_description, invalid_level, invalid_kind, project_not_supported
402 feature_not_in_plan, subscription_read_only
403 forbidden, offline_time_disabled, time_editing_disabled
404 entry_not_found
409 overlaps_entry
412 version_conflict
428 precondition_required (no If-Match)

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

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

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Entry id
`If-Match`required	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Responses

204 (no body)

Errors

402 feature_not_in_plan, subscription_read_only
403 forbidden, offline_time_disabled, time_editing_disabled
404 entry_not_found
412 version_conflict
428 precondition_required (no If-Match)

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

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

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	Entry id
`If-Match`required	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Request body

TimeEntryDecisionRequest

Responses

200 TimeEntryDto

Errors

400 invalid_request
402 feature_not_in_plan, subscription_read_only
403 forbidden (action = the permission)
404 entry_not_found
409 entry_not_pending
412 version_conflict
428 precondition_required (no If-Match)

Timer

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

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

Parameters

Name	In	Type	Description
`If-None-Match`	header	string \| null	The ETag the caller holds (304 when unchanged)

Responses

200 TimerDto · 304 (no body)

Errors

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

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

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

Parameters

Name	In	Type	Description
`Idempotency-Key`	header	string \| null	The client's command id; a retry returns the first answer

Request body

TimerStartRequest

Responses

200 TimerCommandResultDto

Errors

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

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

Parameters

Name	In	Type	Description
`Idempotency-Key`	header	string \| null	The client's command id; a retry returns the first answer

Request body

TimerAtRequest

Responses

200 TimerCommandResultDto

Errors

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

Webhooks

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

The tenant's webhook endpoints.

Parameters

Name	In	Type	Description
`cursor`	query	string
`limit`	query	integer (int32)	1–200, default 50.

Responses

200 WebhookEndpointPage

Errors

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

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

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

Request body

CreateWebhookEndpointRequest

Responses

201 CreatedWebhookEndpointDto

Errors

402 feature_not_in_plan, subscription_read_only
403 forbidden (action = webhooks.manage), feature_not_enabled
409 webhook_limit_reached
422 validation_failed, webhook_url_invalid, webhook_url_not_allowed, webhook_event_unknown

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

One webhook endpoint.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	The endpoint

Responses

200 WebhookEndpointDto

Errors

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

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

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

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	The endpoint
`If-Match`required	header	string	The endpoint's ETag (`"v<n>"`)

Request body

UpdateWebhookEndpointRequest

Responses

200 WebhookEndpointDto

Errors

403 forbidden (action = webhooks.manage), feature_not_enabled
404 webhook_endpoint_not_found
412 version_conflict
422 validation_failed, webhook_url_invalid, webhook_url_not_allowed, webhook_event_unknown
428 precondition_required

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

Delete an endpoint and its deliveries.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	The endpoint

Responses

204 (no body)

Errors

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

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

The deliveries of an endpoint, newest first.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	The endpoint
`status`	query	string	`pending`, `succeeded`, `failed`, `dead`.
`eventType`	query	string
`cursor`	query	string	Opaque cursor of the next page.
`limit`	query	integer (int32)	1–200, default 50.

Responses

200 WebhookDeliveryPage

Errors

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

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

One delivery with the body that was sent.

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	The endpoint
`deliveryId`required	path	string	The delivery (a 64-bit integer)

Responses

200 WebhookDeliveryDetailDto

Errors

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

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

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

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	The endpoint
`deliveryId`required	path	string	The delivery (a 64-bit integer)

Responses

202 AcceptedDto

Errors

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

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

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

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	The endpoint

Responses

200 RotatedWebhookSecretDto

Errors

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

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

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

Parameters

Name	In	Type	Description
`id`required	path	string (uuid)	The endpoint

Responses

202 WebhookTestDto

Errors

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

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

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

Responses

200 WebhookEventsDto

Errors

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

Schemas

The request and response bodies the operations use. Required fields are marked.

AbsenceDto

An absence.

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

AbsencePage

GET /v1/absences.

Field	Type	Description
`items`required	AbsenceDto[]
`nextCursor`	string \| null

AbsencePermissionsDto

Field	Type	Description
`canApprove`required	boolean
`canCancel`required	boolean
`canEdit`required	boolean

AbsenceRequest

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

Field	Type	Description
`endDate`	string (date) \| null
`endTime`	string \| null
`half`	string \| null	`am` or `pm` for a half day.
`note`	string \| null
`startDate`	string (date) \| null
`startTime`	string \| null	Local `HH:mm` for `hours`.
`typeId`	string (uuid) \| null
`unit`	string \| null	`days`, `half_day` or `hours`.
`userId`	string (uuid) \| null	`null` = the caller.

AbsenceTypeRefDto

The absence's type as the absence shows it; name translated for a built-in type that was not renamed.

Field	Type	Description
`color`required	string
`countsAsWorked`required	boolean
`deductsFromBalance`required	boolean
`id`required	string (uuid)
`key`	string \| null
`name`required	string
`paid`required	boolean
`timeEffect`required	string

AcceptedDto

202 Accepted of a queued job.

Field	Type	Description
`accepted`required	boolean	Always `true`.

AccessDto

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

Field	Type	Description
`assignableRoles`required	string[]
`canManageCompanySettings`required	boolean
`canManageTeams`required	boolean
`canManageUsers`required	boolean
`manageTeamIds`required	string[]
`scope`required	string	`company`, `teams` or `self`.
`unassignedFallback`required	boolean
`viewTeamIds`required	string[]

ActivityDayDto

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

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

ActivitySlotDto

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

Field	Type	Description
`activeMs`required	integer (int64)
`apps`required	AppUsageDto[]
`neutralMs`required	integer (int64)
`offlineMs`required	integer (int64)
`productiveMs`required	integer (int64)
`slotStart`required	string (date-time)
`unproductiveMs`required	integer (int64)

AffectedAllocationDto

An allocation replace changed.

Field	Type	Description
`change`required	string	`trimmed`, `split` or `deleted`.
`id`required	string (uuid)

AllocationCreateRequest

POST /v1/allocations (Idempotency-Key).

Field	Type	Description
`endedAt`	string (date-time) \| null	At most 24 hours after `startedAt`, at most 5 minutes in the future.
`isBillable`	boolean \| null
`note`	string \| null
`projectId`	string (uuid) \| null
`replace`	boolean \| null	Trim, split or delete the person's (unbilled) allocations it overlaps; otherwise an overlap is 409 `allocation_overlaps`.
`source`	string \| null	`manual` or `assignment` (`timer` only through the timer).
`startedAt`	string (date-time) \| null
`taskId`	string (uuid) \| null
`userId`	string (uuid) \| null	`null` = the caller; another person needs `allocations.write` and to be managed by the caller.

AllocationCreatedDto

POST /v1/allocations → 201.

Field	Type	Description
`affected`required	AffectedAllocationDto[]
`allocation`required	AllocationDto

AllocationDto

Time on a project.

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

AllocationPage

GET /v1/allocations.

Field	Type	Description
`items`required	AllocationDto[]
`nextCursor`	string \| null

AllocationPermissionsDto

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

Field	Type	Description
`delete`required	boolean
`edit`required	boolean

AppTotalDto

Field	Type	Description
`activeMs`required	integer (int64)
`appKey`required	string
`categoryKey`	string \| null
`level`	string \| null	Level in the response's `levelContext`.
`name`required	string
`percentage`required	number (double)	Share of the range's worked time (0–100, one decimal).

AppUsageDto

An app's time; offline rows use the reserved keys _offline_<level> with name: "Offline time" and levelSource: "offline".

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

BudgetDto

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

Field	Type	Description
`amountMinor`	integer (int64) \| null
`kind`	string \| null	`hours` or `amount`.
`minutes`	integer (int64) \| null

BudgetRequest

The budget of a project request (kind hours with minutes, or amount with amountMinor).

Field	Type	Description
`amountMinor`	integer (int64) \| null
`kind`	string \| null
`minutes`	integer (int64) \| null

CalendarDecisionRequest

{decision, note?} of the decision endpoints (approve or reject; the note at most 500 characters).

Field	Type	Description
`decision`	string \| null
`note`	string \| null

CalendarPersonDto

A user with the current team.

Field	Type	Description
`fullName`	string \| null
`id`required	string (uuid)
`teamId`	string (uuid) \| null
`teamName`	string \| null

CalendarUserRefDto

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

Field	Type	Description
`fullName`	string \| null
`id`required	string (uuid)

CapabilitiesDto

Subscription capabilities.

Field	Type	Description
`features`required	string[]
`readOnly`required	boolean

CategoryUsageDto

Field	Type	Description
`activeMs`required	integer (int64)
`categoryKey`	string \| null	`null` = uncategorized.

CreateExportRequest

POST /v1/exports: definition is the full definition the dialog shows; without it the saved template (templateId) or the built-in one (templateKey) gives it.

Field	Type	Description
`definition`	ExportDefinitionDto \| null
`from`	string (date) \| null
`locale`	string \| null	`tr` or `en`.
`templateId`	string (uuid) \| null
`templateKey`	string \| null
`to`	string (date) \| null

CreateInvitation

POST /v1/invitations.

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

CreateTeam

POST /v1/teams.

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

CreateTimeEntryRequest

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

Field	Type	Description
`description`	string \| null	Offline: 1–500 characters; deletion: optional reason (at most 500).
`end`	string (date-time) \| null
`kind`	string \| null	`offline` or `deletion`.
`level`	string \| null	Offline only (default `productive`).
`projectId`	string (uuid) \| null	Must be `null` (400 `project_not_supported`).
`start`	string (date-time) \| null
`userId`	string (uuid) \| null	`null` = the caller; a manager may add time for a user it manages.

CreateWebhookEndpointRequest

POST /v1/webhook-endpoints.

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

CreatedWebhookEndpointDto

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

Field	Type	Description
`endpoint`required	WebhookEndpointDto
`secret`required	string	`whsec_<base64>`: shown once, never again.

DailyHolidayDto

A holiday of a daily report day.

Field	Type	Description
`half`	string \| null
`key`required	string
`name`required	string	English name; `nameTr` is the Turkish one.
`nameTr`required	string

DayAbsenceDto

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

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

DayAttendanceDto

Attendance of the day on the day plan.

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

DayPlanDto

The day plan of one user's day.

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

DayProductivityDto

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

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

DayTotalDto

One local day of a summary.

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

DomainTotalDto

Field	Type	Description
`activeMs`required	integer (int64)
`categoryKey`	string \| null
`domain`required	string
`level`	string \| null
`percentage`required	number (double)

DomainUsageDto

Field	Type	Description
`activeMs`required	integer (int64)
`categoryKey`	string \| null
`domain`required	string
`level`	string \| null
`levelSource`	string \| null

EmailVerificationDto

Where the person stands with the e-mail verification (owner decision 3 Oct 2026, focus_auth::email_gate).

Field	Type	Description
`dueAt`	string (date-time) \| null	The deadline of an unverified account (`Identity__EmailVerificationGraceHours` after its creation).
`state`required	string	`verified`, `not_required` (an account that never has to verify: invited, imported, SCIM, IdP-verified), `pending` (unverified, before `dueAt`) or `overdue` (after `dueAt`: every request but a few answers 403 `email_verification_required`).

ExportDefinitionDto

What an export contains (FAZ4 §6.1; focus_contracts::reports::export::ExportDefinition on the wire); a saved template stores it without the date range. Every field is optional so that the validator reports what is wrong (422 validation_failed with errors[{field, code}]).

Field	Type	Description
`columns`	string[] \| null	Column keys of the dataset in file order (1–40; a PDF at most 12).
`csvDialect`	string \| null	`standard` (default) or `excel-tr` (csv only).
`dataset`	string \| null
`durationFormat`	string \| null	`hms` (default), `hours` or `minutes`.
`filters`	ExportFiltersDto \| null
`format`	string \| null	`xlsx`, `csv` or `pdf`.
`groupBy`	string \| null	`day`, `week`, `month`, `range` or `none` (the dataset decides).
`options`	ExportOptionsDto \| null

ExportFiltersDto

Who is exported: a team, some users, or (neither) everyone the requester can see.

Field	Type	Description
`includeInactiveUsers`	boolean
`teamId`	string \| null
`userIds`	string \| null[] \| null

ExportJobDto

An export job as the panel lists and polls it.

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

ExportOptionsDto

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

Field	Type	Description
`include`	string \| null	`titles`: `titles`, `urls` or `both` (default).
`includeCosts`	boolean \| null	`projects` (Faz 6): fill the rate, amount and currency columns (needs `projects.costs.read`, else 403).
`includeOpen`	boolean \| null	`shifts`: also open shifts.
`splitByUser`	boolean \| null	`applications`: one row per user and target.
`statuses`	string \| null[] \| null	`offline_time` / `absence`: status filter (default `approved`).
`targetType`	string \| null	`applications`: `app` (default), `domain` or `host`.

FieldError

One field error of a 400/422 body.

Field	Type	Description
`code`required	string	Stable snake_case code (`required`, `too_long`, `invalid`, ...).
`field`required	string	JSON path of the field in camelCase (`name`, `items[2].start`), or the parameter/header name.
`message`	string \| null

HolidayRefDto

A holiday of a day (both names; name is the English one).

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

HostUsageDto

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

InvitationEmail

What happened to the invitation e-mail.

Field	Type	Description
`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`required	string	`queued`; `not_configured` when no e-mail provider is set up; `suppressed_reserved` when the address is an RFC 2606 / RFC 6761 reserved name (`example.com`, `*.test`, …) that is never e-mailed. Clients treat `suppressed_reserved` like `not_configured`: nothing arrives, share `acceptUrl` by hand.

InvitationRef

{"id","expiresAt"} of a created or re-sent invitation.

Field	Type	Description
`expiresAt`required	string
`id`required	string (uuid)

InvitationResult

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

Field	Type	Description
`email`required	InvitationEmail
`invitation`required	InvitationRef
`member`required	MemberDto

LevelContextDto

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

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

MeDto

GET /v1/me.

Field	Type	Description
`access`required	AccessDto
`capabilities`required	CapabilitiesDto
`effectiveTimeZone`required	string
`membership`required	MeMembership
`organization`required	MeOrganization
`organizations`required	OrganizationChoice[]
`session`	MeSession \| null
`user`required	MeUser

MeMembership

The membership in the current organization.

Field	Type	Description
`id`required	string (uuid)
`isTracked`required	boolean
`joinedAt`	string \| null
`role`required	string
`status`required	string
`teamId`	string (uuid) \| null
`teamName`	string \| null
`timeZone`	string \| null
`viewerTeamIds`required	string (uuid)[]

MeOrganization

The current organization.

Field	Type	Description
`defaultLocale`required	string
`id`required	string (uuid)
`name`required	string
`slug`required	string
`status`required	string
`timeZone`required	string

MeSession

The current session.

Field	Type	Description
`absoluteExpiresAt`required	string
`amr`required	string[]
`authTime`required	string
`clientId`required	string
`id`required	string (uuid)
`idleExpiresAt`required	string

MeUser

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

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

MemberDto

A membership with its person (MemberDto).

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

MemberInvitationDto

The invitation of an invited member.

Field	Type	Description
`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`required	string
`id`required	string (uuid)
`lastSentAt`required	string
`sentCount`required	integer (int32)

MemberPage

A page of members (OpenAPI).

Field	Type	Description
`items`required	MemberDto[]
`nextCursor`	string \| null

MemberRefDto

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

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

NamedRefDto

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

Field	Type	Description
`id`required	string (uuid)
`name`required	string

OrganizationChoice

One organization of the person (sec.user_memberships).

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

PatchMember

PATCH /v1/members/{id}.

Field	Type	Description
`isTracked`	boolean \| null
`role`	string \| null	`admin`, `team_admin`, `manager` or `employee` (the Owner is only transferred).
`teamId`	string (uuid) \| null	Primary team; `null` removes it.
`timeZone`	string \| null	IANA zone of the membership; `null` follows the organization.
`viewerTeamIds`	string (uuid)[] \| null	Extra read-only teams (Manager and TeamAdmin only).

PatchTeam

PATCH /v1/teams/{id}.

Field	Type	Description
`description`	string \| null
`name`	string \| null

PeriodReportDto

GET /v1/reports/productivity.

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

PlanAbsenceDto

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

PlanShiftDto

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

Problem

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

Field	Type	Description
`action`	string \| null	Permission key of a 403 (`teams.create`).
`code`required	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`required	integer (int32)
`title`required	string	English title of the code (clients translate `code`).
`traceId`	string \| null	W3C trace id of the request.
`type`required	string	Help page of the error code: `https://workify360.com/help/errors/<code>/`.

ProjectAmountDto

The amounts of one currency (rates are applied per allocation day and layer).

Field	Type	Description
`billableMinor`required	integer (int64)	The billable hours at their rate.
`costMinor`required	integer (int64)	Every allocated hour at its rate.
`currency`required	string

ProjectBudgetUsageDto

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

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

ProjectDto

A project.

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

ProjectPage

GET /v1/projects.

Field	Type	Description
`items`required	ProjectDto[]
`nextCursor`	string \| null

ProjectPermissionsDto

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

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

ProjectRefDto

A project reference of an allocation.

Field	Type	Description
`color`	string \| null	`#RRGGBB`.
`id`required	string (uuid)
`name`required	string

ProjectReportDto

GET /v1/reports/projects.

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

ProjectReportKeysDto

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

Field	Type	Description
`clientId`	string (uuid) \| null
`clientName`	string \| null
`date`	string (date) \| null	The allocation's local day (`groupBy` `day`).
`projectId`	string (uuid) \| null
`projectName`	string \| null
`taskId`	string (uuid) \| null
`taskName`	string \| null
`userId`	string (uuid) \| null
`userName`	string \| null

ProjectReportRowDto

One row of the project report.

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

ProjectReportTotalsDto

The totals of the report.

Field	Type	Description
`allocatedMs`required	integer (int64)
`amounts`	ProjectAmountDto[] \| null
`billableMs`required	integer (int64)
`nonBillableMs`required	integer (int64)
`productiveMs`	integer (int64) \| null
`unratedMs`required	integer (int64)

ProjectRequest

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

Field	Type	Description
`access`	string \| null	`everyone` (default) or `members`.
`budget`	BudgetRequest \| null
`clientId`	string (uuid) \| null
`code`	string \| null	`[A-Za-z0-9._-]{1,32}`, unique among active projects.
`color`	string \| null	`#RRGGBB`.
`currency`	string \| null	`TRY`, `USD` or `EUR`; locked once the project has rates or invoice lines (409 `project_currency_locked`).
`description`	string \| null
`endDate`	string (date) \| null
`isBillable`	boolean \| null	Default true.
`name`	string \| null
`startDate`	string (date) \| null
`status`	string \| null	`active` (default), `on_hold` or `completed`.

ReportFiguresDto

Figures of a group of users over a period (sums raw, percentages the users' average, counters user-days).

Field	Type	Description
`absenceCreditMs`required	integer (int64)
`absentDays`required	integer (int32)
`activeMs`required	integer (int64)
`activeUserCount`required	integer (int32)
`effectivenessPct`	number (double) \| null
`idleMs`required	integer (int64)
`lateDays`required	integer (int32)
`leaveDays`required	number (double)
`leftEarlyDays`required	integer (int32)
`neutralMs`required	integer (int64)
`offlineMs`required	integer (int64)
`overtimeDays`required	integer (int32)
`overtimeMs`required	integer (int64)
`productiveMs`required	integer (int64)
`productivityPct`	number (double) \| null
`targetMs`required	integer (int64)
`unproductiveMs`required	integer (int64)
`userCount`required	integer (int32)
`workedMs`required	integer (int64)

ReportPeriodDto

One period of a grouped report: its key and bounds, then the figures.

ReportScopeDto

What the caller can see (FAZ1 AccessPolicy.ScopeOf).

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

ReportSubjectDto

Whom a report is about.

Field	Type	Description
`id`	string (uuid) \| null
`kind`required	string	`company`, `team` or `user`.
`name`	string \| null

RotatedWebhookSecretDto

RotatedWebhookSecretDto: the new signing secret, shown once.

Field	Type	Description
`previousSecretExpiresAt`required	string	Until then deliveries carry both signatures.
`secret`required	string	`whsec_<base64>`: shown once, never again.

ShiftBody

ShiftBody of POST /v1/shifts, the bulk items and PUT /v1/shifts/{id} (the whole body). Fields left null are filled from templateId.

Field	Type	Description
`breakMinutes`	integer (int32) \| null
`color`	string \| null
`date`	string (date) \| null
`endTime`	string \| null
`location`	string \| null
`minMinutes`	integer (int32) \| null	`null` = the template's, else duration − break.
`note`	string \| null
`startTime`	string \| null
`teamId`	string (uuid) \| null	Required for an open shift; ignored for an assigned one (the user's current team is written).
`templateId`	string (uuid) \| null
`userId`	string (uuid) \| null	`null` = an open shift.

ShiftDto

A shift: local fields, UTC instants, the caller's permissions.

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

ShiftListDto

GET /v1/shifts (the shifts **starting** in the range).

Field	Type	Description
`items`required	ShiftDto[]

ShiftPermissionsDto

Field	Type	Description
`canDelete`required	boolean
`canEdit`required	boolean
`canPickUp`required	boolean
`canRequestSwap`required	boolean

SummaryDto

The summary of the visible users over a range.

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

TargetItemDto

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

TargetListDto

The "Apps & URLs" list.

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

TaskDto

A task.

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

TaskPage

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

Field	Type	Description
`items`required	TaskDto[]
`nextCursor`	string \| null

TaskPermissionsDto

What the caller may do with a task.

Field	Type	Description
`delete`required	boolean	Only a task without time.
`edit`required	boolean

TaskRequest

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

Field	Type	Description
`assigneeUserId`	string (uuid) \| null	Must be able to track time on the project (422 `project_not_trackable`).
`description`	string \| null
`dueDate`	string (date) \| null
`estimateMinutes`	integer (int64) \| null	1–1 000 000.
`isBillable`	boolean \| null	`null` takes the project's value.
`name`	string \| null
`sortOrder`	integer (int64) \| null
`status`	string \| null	`open` (default), `in_progress` or `done`.

TeamDto

A team with its size and leads (TeamDto).

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

TeamPage

A page of teams (OpenAPI).

Field	Type	Description
`items`required	TeamDto[]
`nextCursor`	string \| null

TeamPeriodsDto

Field	Type	Description
`periods`required	ReportPeriodDto[]
`teamId`required	string (uuid)
`teamName`	string \| null
`totals`required	ReportFiguresDto

TeamTotalDto

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

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

TimeEntryDecisionRequest

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

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

TimeEntryDto

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

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

TimeEntryPage

GET /v1/time-entries: by start.

Field	Type	Description
`items`required	TimeEntryDto[]
`nextCursor`	string \| null

TimeEntryPermissionsDto

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

Field	Type	Description
`canApprove`required	boolean
`canDelete`required	boolean
`canEdit`required	boolean

TimeEntryUserRefDto

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

Field	Type	Description
`fullName`	string \| null
`id`required	string (uuid)

TimeIntervalDto

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

Field	Type	Description
`end`required	string (date-time)
`start`required	string (date-time)

TimerAtRequest

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

Field	Type	Description
`at`	string (date-time) \| null

TimerCommandResultDto

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

Field	Type	Description
`applied`required	boolean
`closed`required	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`required	TimerDto

TimerDto

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

Field	Type	Description
`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`required	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`required	string	`running` or `stopped`.
`task`	NamedRefDto \| null

TimerLastDto

The segment that ended last.

Field	Type	Description
`endReason`required	string	`stop`, `switch`, `autostop` or `discard`.
`endedAt`required	string (date-time)
`segmentId`required	string (uuid)
`startedAt`required	string (date-time)

TimerProjectDto

The project of the running segment.

Field	Type	Description
`clientName`	string \| null
`color`	string \| null
`id`required	string (uuid)
`name`required	string

TimerStartRequest

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

Field	Type	Description
`at`	string (date-time) \| null	The client's clock when the command was given (default: the server's now; at most 5 minutes ahead, at most 7 days back).
`isBillable`	boolean \| null
`note`	string \| null
`projectId`	string (uuid) \| null
`source`	string \| null	`web` (default), `desktop` or `api`.
`taskId`	string (uuid) \| null

UpdateTimeEntryRequest

PUT /v1/time-entries/{id}: the whole editable body (kind and user never change; If-Match instead of version).

Field	Type	Description
`description`	string \| null
`end`	string (date-time) \| null
`level`	string \| null
`projectId`	string (uuid) \| null
`start`	string (date-time) \| null

UpdateWebhookEndpointRequest

PATCH /v1/webhook-endpoints/{id} (If-Match).

Field	Type	Description
`description`	string \| null	`null` clears it.
`eventTypes`	string[] \| null
`status`	string \| null	`active` (also opens a `disabled` endpoint and resets its failure counters) or `paused`.
`takeOver`	boolean \| null	`true`: the caller becomes the endpoint's owner (lifts an `owner_inactive` pause).
`url`	string \| null

UserDailyDto

A user's days: computed days plus the workdays without activity up to the user's today.

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

UserDayDto

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

UserTotalDto

One user of a summary.

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

WebhookDeliveryDetailDto

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

WebhookDeliveryDto

WebhookDeliveryDto.

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

WebhookDeliveryPage

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

Field	Type	Description
`items`required	WebhookDeliveryDto[]
`nextCursor`	string \| null

WebhookEndpointDto

WebhookEndpointDto.

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

WebhookEndpointPage

GET /v1/webhook-endpoints.

Field	Type	Description
`items`required	WebhookEndpointDto[]
`nextCursor`	string \| null

WebhookEndpointStatsDto

The delivery statistics of an endpoint.

Field	Type	Description
`consecutiveFailures`required	integer (int32)
`lastFailureAt`	string \| null
`lastSuccessAt`	string \| null

WebhookEventDto

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

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

WebhookEventsDto

GET /v1/webhook-events.

Field	Type	Description
`items`required	WebhookEventDto[]

WebhookTestDto

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

Field	Type	Description
`deliveryId`required	string	The delivery of the test event (a string: the deliveries' id is a 64-bit integer).

Public API reference

Authentication

Scopes

Rate limits

Errors

Webhooks

Operations

Absences

GET /v1/absences Scope: reports:read

Parameters

POST /v1/absences Scope: time:write

Parameters

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

Parameters

Activity

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

Parameters

Time allocations

GET /v1/allocations Scope: reports:read

Parameters

POST /v1/allocations Scope: time:write

Parameters

Exports

POST /v1/exports Scope: reports:read

Parameters

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

Parameters

Me

GET /v1/me Scope: me

Members

POST /v1/invitations Scope: org:admin

Parameters

GET /v1/members Scope: org:admin

Parameters

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

Parameters

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

Parameters

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

Parameters

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

Parameters

Projects

GET /v1/projects Scope: reports:read

Parameters

POST /v1/projects Scope: org:admin

Parameters

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

Parameters

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

Parameters

Reports

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

Parameters

GET /v1/reports/projects Scope: reports:read

Parameters

GET /v1/reports/summary Scope: reports:read

Parameters

GET /v1/reports/targets Scope: reports:read

Parameters

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

Parameters

Shifts

GET /v1/shifts Scope: reports:read

Parameters

POST /v1/shifts Scope: time:write

Parameters

Tasks

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

Parameters

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

Parameters

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

Parameters

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

Parameters

Teams

GET /v1/teams Scope: reports:read

Parameters

POST /v1/teams Scope: org:admin

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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