Openbare API-referentie

Met de openbare API van Workify360 Focus kunnen je eigen scripts en tools rapporten en tijdgegevens lezen en wijzigingen aanbrengen, met dezelfde regels als het dashboard. De openbare API, API-sleutels en webhooks maken deel uit van het Premium-abonnement.

De bewerkingen op deze pagina blijven achterwaarts compatibel. Het machineleesbare OpenAPI-document van dezelfde bewerkingen:

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

Gegenereerd uit het API-contract versie 0.1.0 (c95fb97bb49a).

Authenticatie

Stuur bij elk verzoek een persoonlijke API-sleutel mee in de header Authorization. Een sleutel hoort bij de persoon die hem heeft aangemaakt, handelt als die persoon en doet nooit meer dan diens huidige rol toestaat. Een verzoek met een ontbrekende, onjuiste, verlopen of ingetrokken sleutel krijgt 401 met de code unauthorized.

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

Zo maak je sleutels aan, geef je ze scopes en trek je ze in: API-sleutels en de openbare API

Scopes

Elke bewerking vereist één scope, die ernaast staat. Een sleutel heeft toegang tot een bewerking als hij die scope heeft en de huidige rol, teams en het abonnement van de eigenaar het verzoek toestaan, precies zoals in het dashboard.

Scope	Wat het toestaat
`me`	Je eigen profiel en je timer
`reports:read`	Rapporten, tijdregistraties, afwezigheid, diensten, teams, projecten, taken en exports lezen
`time:write`	Tijdregistraties, afwezigheid, diensten, taken en aan taken toegewezen tijd toevoegen en wijzigen, en over aanvragen beslissen
`org:admin`	Leden, teams, uitnodigingen en projecten beheren
`webhooks:manage`	Webhook-endpoints beheren

Rate limits

Elke sleutel mag 600 eenheden per minuut versturen en een organisatie 1.800 voor al haar sleutels samen. Een verzoek dat iets wijzigt (alles behalve GET en HEAD) telt als twee eenheden, elk ander verzoek als één. Een sleutel kan bovendien hoogstens 60 eenheden tegelijk versturen, aangevuld met 10 per seconde: meer dan 60 leesverzoeken (of 30 wijzigingen) in een piek krijgen 429, ook als het onder de 600 per minuut blijft.

Header	Betekenis
`RateLimit: "key";r=598;t=2`	Bij elk geteld antwoord: de eenheden die de sleutel nog over heeft en het aantal seconden totdat ze weer vol zijn
`RateLimit-Policy: "key";q=600;w=60, "tenant";q=1800;w=60`	Bij elk geteld antwoord: de limieten per minuut van de sleutel en van de organisatie
`Retry-After: 12`	Bij 429 (code `rate_limited`): het aantal seconden dat je moet wachten voor het volgende verzoek

Foutmeldingen

Een fout is een problem document volgens RFC 9457 (Content-Type: application/problem+json). code is een stabiele snake_case-code om tegen te programmeren; title is een Engelse tekst voor logs. type is het helpadres van de code, https://workify360.com/help/errors/<code>/ met elke _ geschreven als -, dat het helpartikel opent dat de code uitlegt als de code er een heeft.

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

Sommige problemen bevatten extra velden: errors (de veldfouten van 422 validation_failed), action (de toestemming waarnaar een 403 forbidden verwijst), requiredPlan (402 feature_not_in_plan), retryAfterSeconds (429 en 503) en traceId (vermeld die als je contact opneemt met support).

Status	Code	Wanneer
400	`invalid_request`	Een parameter is ongeldig of ontbreekt
401	`unauthorized`	De sleutel ontbreekt, is onjuist, verlopen of ingetrokken, of de eigenaar heeft de organisatie verlaten
402	`feature_not_in_plan`, `subscription_read_only`	Het abonnement bevat de functie niet, of het abonnement is alleen-lezen
403	`forbidden`, `feature_not_enabled`	De sleutel mist de scope, of de huidige rol, teams of instellingen van de eigenaar staan het verzoek niet toe
412	`version_conflict`	De versie in `If-Match` is niet meer actueel; lees de resource opnieuw
422	`validation_failed`	De body is ongeldig; `errors` somt de velden op
428	`precondition_required`	De bewerking vereist een header `If-Match` met de versie die je hebt gelezen
429	`rate_limited`	Te veel verzoeken; wacht het aantal seconden uit `Retry-After`

Codes met een helpartikel zijn links in de lijst met bewerkingen.

Webhooks

In plaats van de API steeds opnieuw te bevragen, kan een endpoint van jou een ondertekend HTTPS-verzoek ontvangen als er iets verandert. De events, het formaat van het verzoek, hoe je de handtekening controleert in Node.js en Python, nieuwe pogingen en het roteren van het secret worden uitgelegd in het helpartikel: Webhooks

Bewerkingen

Gegroepeerd per onderwerp. De samenvattingen en veldbeschrijvingen komen uit het API-contract.

Afwezigheid

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

List absences overlapping a range.

Parameters

Naam	In	Type	Beschrijving
`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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`Idempotency-Key`verplicht	header	string	Required: the same key and body return the first answer

Request body

AbsenceRequest

Responses

201 AbsenceDto

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	Id
`If-Match`verplicht	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Request body

CalendarDecisionRequest

Responses

200 AbsenceDto

Foutmeldingen

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)

Activiteit

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

Naam	In	Type	Beschrijving
`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

Foutmeldingen

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

Tijdtoewijzingen

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

Naam	In	Type	Beschrijving
`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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`Idempotency-Key`verplicht	header	string	Required: the same key and body return the first answer

Request body

CreateExportRequest

Responses

202 ExportJobDto

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	Id

Responses

200 ExportJobDto

Foutmeldingen

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

Eigen profiel

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

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

Responses

200 MeDto

Foutmeldingen

401 unauthorized

Leden

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

Invite a person.

Parameters

Naam	In	Type	Beschrijving
`Idempotency-Key`verplicht	header	string	Required: 1–255 printable ASCII characters

Request body

CreateInvitation

Responses

201 InvitationResult

Foutmeldingen

409 already_member
422 validation_failed, idempotency_key_reused

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

List members.

Parameters

Naam	In	Type	Beschrijving
`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

Foutmeldingen

403 No right

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

One member.

Parameters

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	Membership id

Responses

200 MemberDto

Foutmeldingen

404 member_not_found

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

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

Parameters

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	Membership id
`If-Match`verplicht	header	string	ETag of the member ("v<n>")

Request body

PatchMember

Responses

200 MemberDto

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	Membership id

Responses

200 MemberDto

Foutmeldingen

409 conflict (an invitation is revoked instead)

Projecten

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

Naam	In	Type	Beschrijving
`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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	Project id

Responses

200 ProjectDto

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	Project id
`If-Match`verplicht	header	string	The ETag the caller read (412 version_conflict when it changed)

Request body

ProjectRequest

Responses

200 ProjectDto

Foutmeldingen

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)

Rapporten

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

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

Parameters

Naam	In	Type	Beschrijving
`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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`userId`verplicht	pad	string (uuid)	User
`from`	query	string (date)
`to`	query	string (date)	At most 93 days after `from`.

Responses

200 UserDailyDto

Foutmeldingen

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

Diensten

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

List the shifts starting in a range.

Parameters

Naam	In	Type	Beschrijving
`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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`Idempotency-Key`verplicht	header	string	Required: the same key and body return the first answer

Request body

ShiftBody

Responses

201 ShiftDto

Foutmeldingen

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

Taken

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

A visible project's tasks, by sort order.

Parameters

Naam	In	Type	Beschrijving
`id`verplicht	pad	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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	Task id

Responses

200 TaskDto

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	Task id
`If-Match`verplicht	header	string	The ETag the caller read (412 version_conflict when it changed)

Request body

TaskRequest

Responses

200 TaskDto

Foutmeldingen

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

Naam	In	Type	Beschrijving
`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

Foutmeldingen

403 forbidden (action teams.create)
409 team_name_taken

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

Rename a team or change its description.

Parameters

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	Team id
`If-Match`verplicht	header	string	ETag of the team

Request body

PatchTeam

Responses

200 TeamDto

Foutmeldingen

409 team_name_taken

Tijdregistraties

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

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

Parameters

Naam	In	Type	Beschrijving
`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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`Idempotency-Key`verplicht	header	string	Required: the same key and body return the first answer

Request body

CreateTimeEntryRequest

Responses

201 TimeEntryDto

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	Entry id

Responses

200 TimeEntryDto

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	Entry id
`If-Match`verplicht	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Request body

UpdateTimeEntryRequest

Responses

200 TimeEntryDto

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	Entry id
`If-Match`verplicht	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Responses

204 (geen body)

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	Entry id
`If-Match`verplicht	header	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Request body

TimeEntryDecisionRequest

Responses

200 TimeEntryDto

Foutmeldingen

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

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

Responses

200 TimerDto · 304 (geen body)

Foutmeldingen

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

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

Request body

TimerStartRequest

Responses

200 TimerCommandResultDto

Foutmeldingen

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

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

Parameters

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

Request body

TimerAtRequest

Responses

200 TimerCommandResultDto

Foutmeldingen

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

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

Responses

200 WebhookEndpointPage

Foutmeldingen

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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	The endpoint

Responses

200 WebhookEndpointDto

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	The endpoint
`If-Match`verplicht	header	string	The endpoint's ETag (`"v<n>"`)

Request body

UpdateWebhookEndpointRequest

Responses

200 WebhookEndpointDto

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	The endpoint

Responses

204 (geen body)

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	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

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	The endpoint
`deliveryId`verplicht	pad	string	The delivery (a 64-bit integer)

Responses

200 WebhookDeliveryDetailDto

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	The endpoint
`deliveryId`verplicht	pad	string	The delivery (a 64-bit integer)

Responses

202 AcceptedDto

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	The endpoint

Responses

200 RotatedWebhookSecretDto

Foutmeldingen

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

Naam	In	Type	Beschrijving
`id`verplicht	pad	string (uuid)	The endpoint

Responses

202 WebhookTestDto

Foutmeldingen

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

Foutmeldingen

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

Schema's

De request- en response-bodies die de bewerkingen gebruiken. Verplichte velden zijn gemarkeerd.

AbsenceDto

An absence.

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

AbsencePage

GET /v1/absences.

Veld	Type	Beschrijving
`items`verplicht	AbsenceDto[]
`nextCursor`	string \| null

AbsencePermissionsDto

Veld	Type	Beschrijving
`canApprove`verplicht	boolean
`canCancel`verplicht	boolean
`canEdit`verplicht	boolean

AbsenceRequest

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

Veld	Type	Beschrijving
`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.

Veld	Type	Beschrijving
`color`verplicht	string
`countsAsWorked`verplicht	boolean
`deductsFromBalance`verplicht	boolean
`id`verplicht	string (uuid)
`key`	string \| null
`name`verplicht	string
`paid`verplicht	boolean
`timeEffect`verplicht	string

AcceptedDto

202 Accepted of a queued job.

Veld	Type	Beschrijving
`accepted`verplicht	boolean	Always `true`.

AccessDto

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

Veld	Type	Beschrijving
`assignableRoles`verplicht	string[]
`canManageCompanySettings`verplicht	boolean
`canManageTeams`verplicht	boolean
`canManageUsers`verplicht	boolean
`manageTeamIds`verplicht	string[]
`scope`verplicht	string	`company`, `teams` or `self`.
`unassignedFallback`verplicht	boolean
`viewTeamIds`verplicht	string[]

ActivityDayDto

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

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

ActivitySlotDto

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

Veld	Type	Beschrijving
`activeMs`verplicht	integer (int64)
`apps`verplicht	AppUsageDto[]
`neutralMs`verplicht	integer (int64)
`offlineMs`verplicht	integer (int64)
`productiveMs`verplicht	integer (int64)
`slotStart`verplicht	string (date-time)
`unproductiveMs`verplicht	integer (int64)

AffectedAllocationDto

An allocation replace changed.

Veld	Type	Beschrijving
`change`verplicht	string	`trimmed`, `split` or `deleted`.
`id`verplicht	string (uuid)

AllocationCreateRequest

POST /v1/allocations (Idempotency-Key).

Veld	Type	Beschrijving
`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.

Veld	Type	Beschrijving
`affected`verplicht	AffectedAllocationDto[]
`allocation`verplicht	AllocationDto

AllocationDto

Time on a project.

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

AllocationPage

GET /v1/allocations.

Veld	Type	Beschrijving
`items`verplicht	AllocationDto[]
`nextCursor`	string \| null

AllocationPermissionsDto

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

Veld	Type	Beschrijving
`delete`verplicht	boolean
`edit`verplicht	boolean

AppTotalDto

Veld	Type	Beschrijving
`activeMs`verplicht	integer (int64)
`appKey`verplicht	string
`categoryKey`	string \| null
`level`	string \| null	Level in the response's `levelContext`.
`name`verplicht	string
`percentage`verplicht	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".

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

BudgetDto

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

Veld	Type	Beschrijving
`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).

Veld	Type	Beschrijving
`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).

Veld	Type	Beschrijving
`decision`	string \| null
`note`	string \| null

CalendarPersonDto

A user with the current team.

Veld	Type	Beschrijving
`fullName`	string \| null
`id`verplicht	string (uuid)
`teamId`	string (uuid) \| null
`teamName`	string \| null

CalendarUserRefDto

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

Veld	Type	Beschrijving
`fullName`	string \| null
`id`verplicht	string (uuid)

CapabilitiesDto

Subscription capabilities.

Veld	Type	Beschrijving
`features`verplicht	string[]
`readOnly`verplicht	boolean

CategoryUsageDto

Veld	Type	Beschrijving
`activeMs`verplicht	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.

Veld	Type	Beschrijving
`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.

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

CreateTeam

POST /v1/teams.

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

CreateTimeEntryRequest

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

Veld	Type	Beschrijving
`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.

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

CreatedWebhookEndpointDto

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

Veld	Type	Beschrijving
`endpoint`verplicht	WebhookEndpointDto
`secret`verplicht	string	`whsec_<base64>`: shown once, never again.

DailyHolidayDto

A holiday of a daily report day.

Veld	Type	Beschrijving
`half`	string \| null
`key`verplicht	string
`name`verplicht	string	English name; `nameTr` is the Turkish one.
`nameTr`verplicht	string

DayAbsenceDto

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

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

DayAttendanceDto

Attendance of the day on the day plan.

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

DayPlanDto

The day plan of one user's day.

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

DayProductivityDto

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

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

DayTotalDto

One local day of a summary.

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

DomainTotalDto

Veld	Type	Beschrijving
`activeMs`verplicht	integer (int64)
`categoryKey`	string \| null
`domain`verplicht	string
`level`	string \| null
`percentage`verplicht	number (double)

DomainUsageDto

Veld	Type	Beschrijving
`activeMs`verplicht	integer (int64)
`categoryKey`	string \| null
`domain`verplicht	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).

Veld	Type	Beschrijving
`dueAt`	string (date-time) \| null	The deadline of an unverified account (`Identity__EmailVerificationGraceHours` after its creation).
`state`verplicht	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}]).

Veld	Type	Beschrijving
`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.

Veld	Type	Beschrijving
`includeInactiveUsers`	boolean
`teamId`	string \| null
`userIds`	string \| null[] \| null

ExportJobDto

An export job as the panel lists and polls it.

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

ExportOptionsDto

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

Veld	Type	Beschrijving
`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.

Veld	Type	Beschrijving
`code`verplicht	string	Stable snake_case code (`required`, `too_long`, `invalid`, ...).
`field`verplicht	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).

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

HostUsageDto

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

InvitationEmail

What happened to the invitation e-mail.

Veld	Type	Beschrijving
`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`verplicht	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.

Veld	Type	Beschrijving
`expiresAt`verplicht	string
`id`verplicht	string (uuid)

InvitationResult

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

Veld	Type	Beschrijving
`email`verplicht	InvitationEmail
`invitation`verplicht	InvitationRef
`member`verplicht	MemberDto

LevelContextDto

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

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

MeDto

GET /v1/me.

Veld	Type	Beschrijving
`access`verplicht	AccessDto
`capabilities`verplicht	CapabilitiesDto
`effectiveTimeZone`verplicht	string
`membership`verplicht	MeMembership
`organization`verplicht	MeOrganization
`organizations`verplicht	OrganizationChoice[]
`session`	MeSession \| null
`user`verplicht	MeUser

MeMembership

The membership in the current organization.

Veld	Type	Beschrijving
`id`verplicht	string (uuid)
`isTracked`verplicht	boolean
`joinedAt`	string \| null
`role`verplicht	string
`status`verplicht	string
`teamId`	string (uuid) \| null
`teamName`	string \| null
`timeZone`	string \| null
`viewerTeamIds`verplicht	string (uuid)[]

MeOrganization

The current organization.

Veld	Type	Beschrijving
`defaultLocale`verplicht	string
`id`verplicht	string (uuid)
`name`verplicht	string
`slug`verplicht	string
`status`verplicht	string
`timeZone`verplicht	string

MeSession

The current session.

Veld	Type	Beschrijving
`absoluteExpiresAt`verplicht	string
`amr`verplicht	string[]
`authTime`verplicht	string
`clientId`verplicht	string
`id`verplicht	string (uuid)
`idleExpiresAt`verplicht	string

MeUser

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

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

MemberDto

A membership with its person (MemberDto).

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

MemberInvitationDto

The invitation of an invited member.

Veld	Type	Beschrijving
`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`verplicht	string
`id`verplicht	string (uuid)
`lastSentAt`verplicht	string
`sentCount`verplicht	integer (int32)

MemberPage

A page of members (OpenAPI).

Veld	Type	Beschrijving
`items`verplicht	MemberDto[]
`nextCursor`	string \| null

MemberRefDto

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

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

NamedRefDto

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

Veld	Type	Beschrijving
`id`verplicht	string (uuid)
`name`verplicht	string

OrganizationChoice

One organization of the person (sec.user_memberships).

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

PatchMember

PATCH /v1/members/{id}.

Veld	Type	Beschrijving
`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}.

Veld	Type	Beschrijving
`description`	string \| null
`name`	string \| null

PeriodReportDto

GET /v1/reports/productivity.

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

PlanAbsenceDto

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

PlanShiftDto

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

Problem

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

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

Veld	Type	Beschrijving
`billableMinor`verplicht	integer (int64)	The billable hours at their rate.
`costMinor`verplicht	integer (int64)	Every allocated hour at its rate.
`currency`verplicht	string

ProjectBudgetUsageDto

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

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

ProjectDto

A project.

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

ProjectPage

GET /v1/projects.

Veld	Type	Beschrijving
`items`verplicht	ProjectDto[]
`nextCursor`	string \| null

ProjectPermissionsDto

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

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

ProjectRefDto

A project reference of an allocation.

Veld	Type	Beschrijving
`color`	string \| null	`#RRGGBB`.
`id`verplicht	string (uuid)
`name`verplicht	string

ProjectReportDto

GET /v1/reports/projects.

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

ProjectReportKeysDto

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

Veld	Type	Beschrijving
`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.

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

ProjectReportTotalsDto

The totals of the report.

Veld	Type	Beschrijving
`allocatedMs`verplicht	integer (int64)
`amounts`	ProjectAmountDto[] \| null
`billableMs`verplicht	integer (int64)
`nonBillableMs`verplicht	integer (int64)
`productiveMs`	integer (int64) \| null
`unratedMs`verplicht	integer (int64)

ProjectRequest

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

Veld	Type	Beschrijving
`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).

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

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

ReportSubjectDto

Whom a report is about.

Veld	Type	Beschrijving
`id`	string (uuid) \| null
`kind`verplicht	string	`company`, `team` or `user`.
`name`	string \| null

RotatedWebhookSecretDto

RotatedWebhookSecretDto: the new signing secret, shown once.

Veld	Type	Beschrijving
`previousSecretExpiresAt`verplicht	string	Until then deliveries carry both signatures.
`secret`verplicht	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.

Veld	Type	Beschrijving
`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.

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

Veld	Type	Beschrijving
`items`verplicht	ShiftDto[]

ShiftPermissionsDto

Veld	Type	Beschrijving
`canDelete`verplicht	boolean
`canEdit`verplicht	boolean
`canPickUp`verplicht	boolean
`canRequestSwap`verplicht	boolean

SummaryDto

The summary of the visible users over a range.

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

TargetItemDto

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

TargetListDto

The "Apps & URLs" list.

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

TaskDto

A task.

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

TaskPage

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

Veld	Type	Beschrijving
`items`verplicht	TaskDto[]
`nextCursor`	string \| null

TaskPermissionsDto

What the caller may do with a task.

Veld	Type	Beschrijving
`delete`verplicht	boolean	Only a task without time.
`edit`verplicht	boolean

TaskRequest

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

Veld	Type	Beschrijving
`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).

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

TeamPage

A page of teams (OpenAPI).

Veld	Type	Beschrijving
`items`verplicht	TeamDto[]
`nextCursor`	string \| null

TeamPeriodsDto

Veld	Type	Beschrijving
`periods`verplicht	ReportPeriodDto[]
`teamId`verplicht	string (uuid)
`teamName`	string \| null
`totals`verplicht	ReportFiguresDto

TeamTotalDto

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

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

TimeEntryDecisionRequest

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

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

TimeEntryDto

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

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

TimeEntryPage

GET /v1/time-entries: by start.

Veld	Type	Beschrijving
`items`verplicht	TimeEntryDto[]
`nextCursor`	string \| null

TimeEntryPermissionsDto

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

Veld	Type	Beschrijving
`canApprove`verplicht	boolean
`canDelete`verplicht	boolean
`canEdit`verplicht	boolean

TimeEntryUserRefDto

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

Veld	Type	Beschrijving
`fullName`	string \| null
`id`verplicht	string (uuid)

TimeIntervalDto

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

Veld	Type	Beschrijving
`end`verplicht	string (date-time)
`start`verplicht	string (date-time)

TimerAtRequest

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

Veld	Type	Beschrijving
`at`	string (date-time) \| null

TimerCommandResultDto

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

Veld	Type	Beschrijving
`applied`verplicht	boolean
`closed`verplicht	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`verplicht	TimerDto

TimerDto

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

Veld	Type	Beschrijving
`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`verplicht	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`verplicht	string	`running` or `stopped`.
`task`	NamedRefDto \| null

TimerLastDto

The segment that ended last.

Veld	Type	Beschrijving
`endReason`verplicht	string	`stop`, `switch`, `autostop` or `discard`.
`endedAt`verplicht	string (date-time)
`segmentId`verplicht	string (uuid)
`startedAt`verplicht	string (date-time)

TimerProjectDto

The project of the running segment.

Veld	Type	Beschrijving
`clientName`	string \| null
`color`	string \| null
`id`verplicht	string (uuid)
`name`verplicht	string

TimerStartRequest

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

Veld	Type	Beschrijving
`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).

Veld	Type	Beschrijving
`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).

Veld	Type	Beschrijving
`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.

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

UserDayDto

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

UserTotalDto

One user of a summary.

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

WebhookDeliveryDetailDto

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

WebhookDeliveryDto

WebhookDeliveryDto.

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

WebhookDeliveryPage

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

Veld	Type	Beschrijving
`items`verplicht	WebhookDeliveryDto[]
`nextCursor`	string \| null

WebhookEndpointDto

WebhookEndpointDto.

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

WebhookEndpointPage

GET /v1/webhook-endpoints.

Veld	Type	Beschrijving
`items`verplicht	WebhookEndpointDto[]
`nextCursor`	string \| null

WebhookEndpointStatsDto

The delivery statistics of an endpoint.

Veld	Type	Beschrijving
`consecutiveFailures`verplicht	integer (int32)
`lastFailureAt`	string \| null
`lastSuccessAt`	string \| null

WebhookEventDto

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

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

WebhookEventsDto

GET /v1/webhook-events.

Veld	Type	Beschrijving
`items`verplicht	WebhookEventDto[]

WebhookTestDto

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

Veld	Type	Beschrijving
`deliveryId`verplicht	string	The delivery of the test event (a string: the deliveries' id is a 64-bit integer).

Openbare API-referentie

Authenticatie

Scopes

Rate limits

Foutmeldingen

Webhooks

Bewerkingen

Afwezigheid

GET /v1/absences Scope: reports:read

Parameters

POST /v1/absences Scope: time:write

Parameters

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

Parameters

Activiteit

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

Parameters

Tijdtoewijzingen

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

Eigen profiel

GET /v1/me Scope: me

Leden

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

Projecten

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

Rapporten

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

Diensten

GET /v1/shifts Scope: reports:read

Parameters

POST /v1/shifts Scope: time:write

Parameters

Taken

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`