Référence de l'API publique

L'API publique Workify360 Focus permet à vos propres scripts et outils de lire les rapports et les données de temps, et d'effectuer des modifications selon les mêmes règles que le tableau de bord. L'API publique, les clés d'API et les webhooks font partie de la formule Premium.

Les opérations de cette page restent rétrocompatibles. Le document OpenAPI lisible par machine des mêmes opérations :

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

Généré à partir de la version 0.1.0 du contrat d'API (c95fb97bb49a).

Authentification

Envoyez une clé d'API personnelle dans l'en-tête Authorization de chaque requête. Une clé appartient à la personne qui l'a créée, agit en son nom et ne fait jamais plus que ce que son rôle actuel autorise. Une requête dont la clé est absente, erronée, expirée ou révoquée reçoit 401 avec le code unauthorized.

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

Pour créer des clés, définir leur portée et les révoquer : Clés d'API et API publique

Portées

Chaque opération exige une portée, indiquée à côté d'elle. Une clé accède à une opération lorsqu'elle détient cette portée et que le rôle actuel, les équipes et la formule de son propriétaire autorisent la requête, exactement comme dans le tableau de bord.

Portée	Ce qu'elle autorise
`me`	Votre propre profil et votre minuteur
`reports:read`	Lire les rapports, les saisies de temps, les absences, les postes, les équipes, les projets, les tâches et les exports
`time:write`	Ajouter et modifier les saisies de temps, les absences, les postes, les tâches et le temps affecté aux tâches, et statuer sur les demandes
`org:admin`	Gérer les membres, les équipes, les invitations et les projets
`webhooks:manage`	Gérer les points de terminaison de webhooks

Limites de débit

Chaque clé peut envoyer 600 unités par minute, et une organisation 1 800 pour l'ensemble de ses clés. Une requête qui modifie quelque chose (tout sauf GET et HEAD) compte pour deux unités, toute autre requête pour une. Une clé peut aussi envoyer au plus 60 unités d'un coup, rechargées à raison de 10 par seconde : au-delà de 60 lectures (ou 30 modifications) en rafale, la réponse est 429, même sous les 600 par minute.

En-tête	Signification
`RateLimit: "key";r=598;t=2`	Sur chaque réponse décomptée : les unités restantes de la clé et le nombre de secondes avant leur rechargement complet
`RateLimit-Policy: "key";q=600;w=60, "tenant";q=1800;w=60`	Sur chaque réponse décomptée : les limites par minute de la clé et de l'organisation
`Retry-After: 12`	Avec 429 (code `rate_limited`) : le nombre de secondes à attendre avant la requête suivante

Erreurs

Une erreur est un document de problème RFC 9457 (Content-Type: application/problem+json). code est un code snake_case stable sur lequel baser votre programme ; title est un texte en anglais destiné aux journaux. type est l'adresse d'aide du code, https://workify360.com/help/errors/<code>/ où chaque _ est remplacé par -, qui ouvre l'article d'aide expliquant le code lorsqu'il en existe un.

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

Certains problèmes comportent des champs supplémentaires : errors (les erreurs de champ d'un 422 validation_failed), action (l'autorisation à laquelle se rapporte un 403 forbidden), requiredPlan (402 feature_not_in_plan), retryAfterSeconds (429 et 503) et traceId (à indiquer lorsque vous contactez le support).

Statut	Code	Quand
400	`invalid_request`	Un paramètre est mal formé ou manquant
401	`unauthorized`	La clé est absente, erronée, expirée ou révoquée, ou son propriétaire a quitté l'organisation
402	`feature_not_in_plan`, `subscription_read_only`	La formule n'inclut pas la fonctionnalité, ou l'abonnement est en lecture seule
403	`forbidden`, `feature_not_enabled`	La clé n'a pas la portée requise, ou le rôle actuel, les équipes ou les paramètres de son propriétaire n'autorisent pas la requête
412	`version_conflict`	La version `If-Match` n'est plus la version actuelle ; relisez la ressource
422	`validation_failed`	Le corps de la requête est invalide ; `errors` liste les champs
428	`precondition_required`	L'opération exige un en-tête `If-Match` avec la version que vous avez lue
429	`rate_limited`	Trop de requêtes ; attendez le nombre de secondes indiqué dans `Retry-After`

Les codes associés à un article d'aide sont des liens dans la liste des opérations.

Webhooks

Au lieu d'interroger l'API encore et encore, l'un de vos points de terminaison peut recevoir une requête HTTPS signée lorsqu'un élément change. Les événements, le format de la requête, la vérification de la signature en Node.js et en Python, les nouvelles tentatives et la rotation du secret sont expliqués dans l'article d'aide : Webhooks

Opérations

Regroupées par domaine. Les résumés et les descriptions de champs proviennent du contrat d'API.

Absences

GET `/v1/absences` Portée: `reports:read`

List absences overlapping a range.

Paramètres

Nom	Emplacement	Type	Description
`from`	chaîne de requête	string (date)
`to`	chaîne de requête	string (date)	At most 366 days after `from`.
`userId`	chaîne de requête	string (uuid)
`teamId`	chaîne de requête	string (uuid)
`status`	chaîne de requête	string
`typeId`	chaîne de requête	string (uuid)
`cursor`	chaîne de requête	string
`limit`	chaîne de requête	integer (int32)

Réponses

200 AbsencePage

Erreurs

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

POST `/v1/absences` Portée: `time:write`

Request (or record) an absence.

Paramètres

Nom	Emplacement	Type	Description
`Idempotency-Key`obligatoire	en-tête	string	Required: the same key and body return the first answer

Corps de la requête

AbsenceRequest

Réponses

201 AbsenceDto

Erreurs

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` Portée: `time:write`

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

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Id
`If-Match`obligatoire	en-tête	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Corps de la requête

CalendarDecisionRequest

Réponses

200 AbsenceDto

Erreurs

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)

Activité

GET `/v1/activity/day` Portée: `reports:read`

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

Paramètres

Nom	Emplacement	Type	Description
`date`	chaîne de requête	string (date)	The user's local day (required).
`userId`	chaîne de requête	string (uuid)	Default: the caller; another user must be visible (else 403).

Réponses

200 ActivityDayDto

Erreurs

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

Affectations de temps

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

Paramètres

Nom	Emplacement	Type	Description
`userId`	chaîne de requête	string (uuid)	Default: the caller.
`from`	chaîne de requête	string (date)	Local date, included.
`to`	chaîne de requête	string (date)	Local date, included; at most 93 days after `from`.
`projectId`	chaîne de requête	string (uuid)
`cursor`	chaîne de requête	string
`limit`	chaîne de requête	integer (int32)	1–200 (default 200).

Réponses

200 AllocationPage

Erreurs

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` Portée: `time:write`

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

Paramètres

Nom	Emplacement	Type	Description
`Idempotency-Key`	en-tête	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Corps de la requête

AllocationCreateRequest

Réponses

201 AllocationCreatedDto

Erreurs

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` Portée: `reports:read`

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

Paramètres

Nom	Emplacement	Type	Description
`Idempotency-Key`obligatoire	en-tête	string	Required: the same key and body return the first answer

Corps de la requête

CreateExportRequest

Réponses

202 ExportJobDto

Erreurs

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}` Portée: `reports:read`

One export job (poll every 2 s).

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Id

Réponses

200 ExportJobDto

Erreurs

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

Mon profil

GET `/v1/me` Portée: `me`

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

Réponses

200 MeDto

Erreurs

401 unauthorized

Membres

POST `/v1/invitations` Portée: `org:admin`

Invite a person.

Paramètres

Nom	Emplacement	Type	Description
`Idempotency-Key`obligatoire	en-tête	string	Required: 1–255 printable ASCII characters

Corps de la requête

CreateInvitation

Réponses

201 InvitationResult

Erreurs

409 already_member
422 validation_failed, idempotency_key_reused

GET `/v1/members` Portée: `org:admin`

List members.

Paramètres

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

Réponses

200 MemberPage

Erreurs

403 No right

GET `/v1/members/{id}` Portée: `org:admin`

One member.

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Membership id

Réponses

200 MemberDto

Erreurs

404 member_not_found

PATCH `/v1/members/{id}` Portée: `org:admin`

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

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Membership id
`If-Match`obligatoire	en-tête	string	ETag of the member ("v<n>")

Corps de la requête

PatchMember

Réponses

200 MemberDto

Erreurs

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` Portée: `org:admin`

Reactivate a suspended member.

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Membership id

Réponses: 200 MemberDto

POST `/v1/members/{id}/suspend` Portée: `org:admin`

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

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Membership id

Réponses

200 MemberDto

Erreurs

409 conflict (an invitation is revoked instead)

Projets

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

Paramètres

Nom	Emplacement	Type	Description
`status`	chaîne de requête	string	`active`, `on_hold` or `completed`.
`clientId`	chaîne de requête	string (uuid)
`q`	chaîne de requête	string	Name or code search (case-insensitive).
`includeArchived`	chaîne de requête	boolean
`mine`	chaîne de requête	boolean	Only the projects the caller may track time on.
`cursor`	chaîne de requête	string
`limit`	chaîne de requête	integer (int32)	1–200 (default 50).

Réponses

200 ProjectPage

Erreurs

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

POST `/v1/projects` Portée: `org:admin`

Add a project (Owners and Admins).

Paramètres

Nom	Emplacement	Type	Description
`Idempotency-Key`	en-tête	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Corps de la requête

ProjectRequest

Réponses

201 ProjectDto

Erreurs

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}` Portée: `reports:read`

One project (invisible projects are 404).

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Project id

Réponses

200 ProjectDto

Erreurs

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

PUT `/v1/projects/{id}` Portée: `org:admin`

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

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Project id
`If-Match`obligatoire	en-tête	string	The ETag the caller read (412 version_conflict when it changed)

Corps de la requête

ProjectRequest

Réponses

200 ProjectDto

Erreurs

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)

Rapports

GET `/v1/reports/productivity` Portée: `reports:read`

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

Paramètres

Nom	Emplacement	Type	Description
`from`	chaîne de requête	string (date)
`to`	chaîne de requête	string (date)	`day` 93 days, `week`, `month` and `range` 366.
`groupBy`	chaîne de requête	string	`day`, `week`, `month` or `range`.
`teamId`	chaîne de requête	string (uuid)
`userId`	chaîne de requête	string (uuid)

Réponses

200 PeriodReportDto

Erreurs

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` Portée: `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.

Paramètres

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

Réponses

200 ProjectReportDto

Erreurs

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` Portée: `reports:read`

The summary of the visible users over a range.

Paramètres

Nom	Emplacement	Type	Description
`from`	chaîne de requête	string (date)
`to`	chaîne de requête	string (date)	At most 93 days after `from`.
`teamId`	chaîne de requête	string (uuid)	Only the team's current members; the team must be visible (else 403).

Réponses

200 SummaryDto

Erreurs

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` Portée: `reports:read`

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

Paramètres

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

Réponses

200 TargetListDto

Erreurs

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` Portée: `reports:read`

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

Paramètres

Nom	Emplacement	Type	Description
`userId`obligatoire	chemin	string (uuid)	User
`from`	chaîne de requête	string (date)
`to`	chaîne de requête	string (date)	At most 93 days after `from`.

Réponses

200 UserDailyDto

Erreurs

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

Postes

GET `/v1/shifts` Portée: `reports:read`

List the shifts starting in a range.

Paramètres

Nom	Emplacement	Type	Description
`from`	chaîne de requête	string (date)
`to`	chaîne de requête	string (date)
`teamId`	chaîne de requête	string (uuid)
`userId`	chaîne de requête	string (uuid)
`includeOpen`	chaîne de requête	boolean	Also open shifts (default true).

Réponses

200 ShiftListDto

Erreurs

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

POST `/v1/shifts` Portée: `time:write`

Create a shift (assigned or open).

Paramètres

Nom	Emplacement	Type	Description
`Idempotency-Key`obligatoire	en-tête	string	Required: the same key and body return the first answer

Corps de la requête

ShiftBody

Réponses

201 ShiftDto

Erreurs

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

Tâches

GET `/v1/projects/{id}/tasks` Portée: `reports:read`

A visible project's tasks, by sort order.

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Project id
`status`	chaîne de requête	string	`open`, `in_progress` or `done`.
`assigneeUserId`	chaîne de requête	string (uuid)
`includeArchived`	chaîne de requête	boolean
`cursor`	chaîne de requête	string
`limit`	chaîne de requête	integer (int32)	1–500 (default 200).

Réponses

200 TaskPage

Erreurs

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` Portée: `time:write`

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

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Project id
`Idempotency-Key`	en-tête	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Corps de la requête

TaskRequest

Réponses

201 TaskDto

Erreurs

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}` Portée: `reports:read`

One task of a visible project.

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Task id

Réponses

200 TaskDto

Erreurs

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

PUT `/v1/tasks/{id}` Portée: `time:write`

Change a task (the whole body).

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Task id
`If-Match`obligatoire	en-tête	string	The ETag the caller read (412 version_conflict when it changed)

Corps de la requête

TaskRequest

Réponses

200 TaskDto

Erreurs

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)

Équipes

GET `/v1/teams` Portée: `reports:read`

List teams.

Paramètres

Nom	Emplacement	Type	Description
`includeArchived`	chaîne de requête	boolean	Also archived teams (default false)
`cursor`	chaîne de requête	string	Opaque cursor of the next page
`limit`	chaîne de requête	integer (int32)	1–200, default 50

Réponses: 200 TeamPage

POST `/v1/teams` Portée: `org:admin`

Create a team (the G1 endpoint).

Corps de la requête

CreateTeam

Réponses

201 TeamDto

Erreurs

403 forbidden (action teams.create)
409 team_name_taken

PATCH `/v1/teams/{id}` Portée: `org:admin`

Rename a team or change its description.

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Team id
`If-Match`obligatoire	en-tête	string	ETag of the team

Corps de la requête

PatchTeam

Réponses

200 TeamDto

Erreurs

409 team_name_taken

Saisies de temps

GET `/v1/time-entries` Portée: `reports:read`

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

Paramètres

Nom	Emplacement	Type	Description
`userId`	chaîne de requête	string (uuid)	Default: the caller.
`from`	chaîne de requête	string (date)	The entry's local day, required.
`to`	chaîne de requête	string (date)	At most 93 days after `from`.
`kind`	chaîne de requête	string	`offline` or `deletion`.
`status`	chaîne de requête	string	`pending`, `approved` or `rejected`.
`cursor`	chaîne de requête	string
`limit`	chaîne de requête	integer (int32)	1–500.

Réponses

200 TimeEntryPage

Erreurs

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` Portée: `time:write`

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

Paramètres

Nom	Emplacement	Type	Description
`Idempotency-Key`obligatoire	en-tête	string	Required: the same key and body return the first answer

Corps de la requête

CreateTimeEntryRequest

Réponses

201 TimeEntryDto

Erreurs

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}` Portée: `reports:read`

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

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Entry id

Réponses

200 TimeEntryDto

Erreurs

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

PUT `/v1/time-entries/{id}` Portée: `time:write`

Replace an entry's editable fields.

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Entry id
`If-Match`obligatoire	en-tête	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Corps de la requête

UpdateTimeEntryRequest

Réponses

200 TimeEntryDto

Erreurs

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}` Portée: `time:write`

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

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Entry id
`If-Match`obligatoire	en-tête	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Réponses

204 (sans corps)

Erreurs

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` Portée: `time:write`

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

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	Entry id
`If-Match`obligatoire	en-tête	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Corps de la requête

TimeEntryDecisionRequest

Réponses

200 TimeEntryDto

Erreurs

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)

Minuteur

GET `/v1/me/timer` Portée: `me`

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

Paramètres

Nom	Emplacement	Type	Description
`If-None-Match`	en-tête	string \| null	The ETag the caller holds (304 when unchanged)

Réponses

200 TimerDto · 304 (sans corps)

Erreurs

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

POST `/v1/me/timer/start` Portée: `me`

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

Paramètres

Nom	Emplacement	Type	Description
`Idempotency-Key`	en-tête	string \| null	The client's command id; a retry returns the first answer

Corps de la requête

TimerStartRequest

Réponses

200 TimerCommandResultDto

Erreurs

POST `/v1/me/timer/stop` Portée: `me`

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

Paramètres

Nom	Emplacement	Type	Description
`Idempotency-Key`	en-tête	string \| null	The client's command id; a retry returns the first answer

Corps de la requête

TimerAtRequest

Réponses

200 TimerCommandResultDto

Erreurs

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` Portée: `webhooks:manage`

The tenant's webhook endpoints.

Paramètres

Nom	Emplacement	Type	Description
`cursor`	chaîne de requête	string
`limit`	chaîne de requête	integer (int32)	1–200, default 50.

Réponses

200 WebhookEndpointPage

Erreurs

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

POST `/v1/webhook-endpoints` Portée: `webhooks:manage`

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

Corps de la requête

CreateWebhookEndpointRequest

Réponses

201 CreatedWebhookEndpointDto

Erreurs

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}` Portée: `webhooks:manage`

One webhook endpoint.

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	The endpoint

Réponses

200 WebhookEndpointDto

Erreurs

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

PATCH `/v1/webhook-endpoints/{id}` Portée: `webhooks:manage`

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

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	The endpoint
`If-Match`obligatoire	en-tête	string	The endpoint's ETag (`"v<n>"`)

Corps de la requête

UpdateWebhookEndpointRequest

Réponses

200 WebhookEndpointDto

Erreurs

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}` Portée: `webhooks:manage`

Delete an endpoint and its deliveries.

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	The endpoint

Réponses

204 (sans corps)

Erreurs

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

GET `/v1/webhook-endpoints/{id}/deliveries` Portée: `webhooks:manage`

The deliveries of an endpoint, newest first.

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	The endpoint
`status`	chaîne de requête	string	`pending`, `succeeded`, `failed`, `dead`.
`eventType`	chaîne de requête	string
`cursor`	chaîne de requête	string	Opaque cursor of the next page.
`limit`	chaîne de requête	integer (int32)	1–200, default 50.

Réponses

200 WebhookDeliveryPage

Erreurs

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

GET `/v1/webhook-endpoints/{id}/deliveries/{deliveryId}` Portée: `webhooks:manage`

One delivery with the body that was sent.

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	The endpoint
`deliveryId`obligatoire	chemin	string	The delivery (a 64-bit integer)

Réponses

200 WebhookDeliveryDetailDto

Erreurs

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` Portée: `webhooks:manage`

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

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	The endpoint
`deliveryId`obligatoire	chemin	string	The delivery (a 64-bit integer)

Réponses

202 AcceptedDto

Erreurs

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

POST `/v1/webhook-endpoints/{id}/rotate-secret` Portée: `webhooks:manage`

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

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	The endpoint

Réponses

200 RotatedWebhookSecretDto

Erreurs

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

POST `/v1/webhook-endpoints/{id}/test` Portée: `webhooks:manage`

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

Paramètres

Nom	Emplacement	Type	Description
`id`obligatoire	chemin	string (uuid)	The endpoint

Réponses

202 WebhookTestDto

Erreurs

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

GET `/v1/webhook-events` Portée: `webhooks:manage`

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

Réponses

200 WebhookEventsDto

Erreurs

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

Schémas

Les corps de requête et de réponse utilisés par les opérations. Les champs obligatoires sont signalés.

AbsenceDto

An absence.

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

AbsencePage

GET /v1/absences.

Champ	Type	Description
`items`obligatoire	AbsenceDto[]
`nextCursor`	string \| null

AbsencePermissionsDto

Champ	Type	Description
`canApprove`obligatoire	boolean
`canCancel`obligatoire	boolean
`canEdit`obligatoire	boolean

AbsenceRequest

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

Champ	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.

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

AcceptedDto

202 Accepted of a queued job.

Champ	Type	Description
`accepted`obligatoire	boolean	Always `true`.

AccessDto

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

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

ActivityDayDto

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

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

ActivitySlotDto

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

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

AffectedAllocationDto

An allocation replace changed.

Champ	Type	Description
`change`obligatoire	string	`trimmed`, `split` or `deleted`.
`id`obligatoire	string (uuid)

AllocationCreateRequest

POST /v1/allocations (Idempotency-Key).

Champ	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.

Champ	Type	Description
`affected`obligatoire	AffectedAllocationDto[]
`allocation`obligatoire	AllocationDto

AllocationDto

Time on a project.

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

AllocationPage

GET /v1/allocations.

Champ	Type	Description
`items`obligatoire	AllocationDto[]
`nextCursor`	string \| null

AllocationPermissionsDto

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

Champ	Type	Description
`delete`obligatoire	boolean
`edit`obligatoire	boolean

AppTotalDto

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

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

BudgetDto

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

Champ	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).

Champ	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).

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

CalendarPersonDto

A user with the current team.

Champ	Type	Description
`fullName`	string \| null
`id`obligatoire	string (uuid)
`teamId`	string (uuid) \| null
`teamName`	string \| null

CalendarUserRefDto

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

Champ	Type	Description
`fullName`	string \| null
`id`obligatoire	string (uuid)

CapabilitiesDto

Subscription capabilities.

Champ	Type	Description
`features`obligatoire	string[]
`readOnly`obligatoire	boolean

CategoryUsageDto

Champ	Type	Description
`activeMs`obligatoire	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.

Champ	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.

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

CreateTeam

POST /v1/teams.

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

CreateTimeEntryRequest

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

Champ	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.

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

CreatedWebhookEndpointDto

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

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

DailyHolidayDto

A holiday of a daily report day.

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

DayAbsenceDto

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

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

DayAttendanceDto

Attendance of the day on the day plan.

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

DayPlanDto

The day plan of one user's day.

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

DayProductivityDto

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

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

DayTotalDto

One local day of a summary.

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

DomainTotalDto

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

DomainUsageDto

Champ	Type	Description
`activeMs`obligatoire	integer (int64)
`categoryKey`	string \| null
`domain`obligatoire	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).

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

Champ	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.

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

ExportJobDto

An export job as the panel lists and polls it.

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

ExportOptionsDto

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

Champ	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.

Champ	Type	Description
`code`obligatoire	string	Stable snake_case code (`required`, `too_long`, `invalid`, ...).
`field`obligatoire	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).

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

HostUsageDto

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

InvitationEmail

What happened to the invitation e-mail.

Champ	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`obligatoire	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.

Champ	Type	Description
`expiresAt`obligatoire	string
`id`obligatoire	string (uuid)

InvitationResult

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

Champ	Type	Description
`email`obligatoire	InvitationEmail
`invitation`obligatoire	InvitationRef
`member`obligatoire	MemberDto

LevelContextDto

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

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

MeDto

GET /v1/me.

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

MeMembership

The membership in the current organization.

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

MeOrganization

The current organization.

Champ	Type	Description
`defaultLocale`obligatoire	string
`id`obligatoire	string (uuid)
`name`obligatoire	string
`slug`obligatoire	string
`status`obligatoire	string
`timeZone`obligatoire	string

MeSession

The current session.

Champ	Type	Description
`absoluteExpiresAt`obligatoire	string
`amr`obligatoire	string[]
`authTime`obligatoire	string
`clientId`obligatoire	string
`id`obligatoire	string (uuid)
`idleExpiresAt`obligatoire	string

MeUser

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

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

MemberDto

A membership with its person (MemberDto).

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

MemberInvitationDto

The invitation of an invited member.

Champ	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`obligatoire	string
`id`obligatoire	string (uuid)
`lastSentAt`obligatoire	string
`sentCount`obligatoire	integer (int32)

MemberPage

A page of members (OpenAPI).

Champ	Type	Description
`items`obligatoire	MemberDto[]
`nextCursor`	string \| null

MemberRefDto

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

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

NamedRefDto

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

Champ	Type	Description
`id`obligatoire	string (uuid)
`name`obligatoire	string

OrganizationChoice

One organization of the person (sec.user_memberships).

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

PatchMember

PATCH /v1/members/{id}.

Champ	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}.

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

PeriodReportDto

GET /v1/reports/productivity.

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

PlanAbsenceDto

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

PlanShiftDto

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

Problem

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

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

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

ProjectBudgetUsageDto

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

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

ProjectDto

A project.

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

ProjectPage

GET /v1/projects.

Champ	Type	Description
`items`obligatoire	ProjectDto[]
`nextCursor`	string \| null

ProjectPermissionsDto

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

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

ProjectRefDto

A project reference of an allocation.

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

ProjectReportDto

GET /v1/reports/projects.

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

ProjectReportKeysDto

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

Champ	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.

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

ProjectReportTotalsDto

The totals of the report.

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

ProjectRequest

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

Champ	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).

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

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

ReportSubjectDto

Whom a report is about.

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

RotatedWebhookSecretDto

RotatedWebhookSecretDto: the new signing secret, shown once.

Champ	Type	Description
`previousSecretExpiresAt`obligatoire	string	Until then deliveries carry both signatures.
`secret`obligatoire	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.

Champ	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.

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

Champ	Type	Description
`items`obligatoire	ShiftDto[]

ShiftPermissionsDto

Champ	Type	Description
`canDelete`obligatoire	boolean
`canEdit`obligatoire	boolean
`canPickUp`obligatoire	boolean
`canRequestSwap`obligatoire	boolean

SummaryDto

The summary of the visible users over a range.

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

TargetItemDto

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

TargetListDto

The "Apps & URLs" list.

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

TaskDto

A task.

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

TaskPage

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

Champ	Type	Description
`items`obligatoire	TaskDto[]
`nextCursor`	string \| null

TaskPermissionsDto

What the caller may do with a task.

Champ	Type	Description
`delete`obligatoire	boolean	Only a task without time.
`edit`obligatoire	boolean

TaskRequest

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

Champ	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).

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

TeamPage

A page of teams (OpenAPI).

Champ	Type	Description
`items`obligatoire	TeamDto[]
`nextCursor`	string \| null

TeamPeriodsDto

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

TeamTotalDto

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

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

TimeEntryDecisionRequest

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

Champ	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).

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

TimeEntryPage

GET /v1/time-entries: by start.

Champ	Type	Description
`items`obligatoire	TimeEntryDto[]
`nextCursor`	string \| null

TimeEntryPermissionsDto

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

Champ	Type	Description
`canApprove`obligatoire	boolean
`canDelete`obligatoire	boolean
`canEdit`obligatoire	boolean

TimeEntryUserRefDto

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

Champ	Type	Description
`fullName`	string \| null
`id`obligatoire	string (uuid)

TimeIntervalDto

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

Champ	Type	Description
`end`obligatoire	string (date-time)
`start`obligatoire	string (date-time)

TimerAtRequest

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

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

TimerCommandResultDto

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

Champ	Type	Description
`applied`obligatoire	boolean
`closed`obligatoire	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`obligatoire	TimerDto

TimerDto

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

Champ	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`obligatoire	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`obligatoire	string	`running` or `stopped`.
`task`	NamedRefDto \| null

TimerLastDto

The segment that ended last.

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

TimerProjectDto

The project of the running segment.

Champ	Type	Description
`clientName`	string \| null
`color`	string \| null
`id`obligatoire	string (uuid)
`name`obligatoire	string

TimerStartRequest

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

Champ	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).

Champ	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).

Champ	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.

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

UserDayDto

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

UserTotalDto

One user of a summary.

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

WebhookDeliveryDetailDto

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

WebhookDeliveryDto

WebhookDeliveryDto.

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

WebhookDeliveryPage

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

Champ	Type	Description
`items`obligatoire	WebhookDeliveryDto[]
`nextCursor`	string \| null

WebhookEndpointDto

WebhookEndpointDto.

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

WebhookEndpointPage

GET /v1/webhook-endpoints.

Champ	Type	Description
`items`obligatoire	WebhookEndpointDto[]
`nextCursor`	string \| null

WebhookEndpointStatsDto

The delivery statistics of an endpoint.

Champ	Type	Description
`consecutiveFailures`obligatoire	integer (int32)
`lastFailureAt`	string \| null
`lastSuccessAt`	string \| null

WebhookEventDto

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

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

WebhookEventsDto

GET /v1/webhook-events.

Champ	Type	Description
`items`obligatoire	WebhookEventDto[]

WebhookTestDto

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

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

Référence de l'API publique

Authentification

Portées

Limites de débit

Erreurs

Webhooks

Opérations

Absences

GET /v1/absences Portée: reports:read

Paramètres

POST /v1/absences Portée: time:write

Paramètres

POST /v1/absences/{id}/decision Portée: time:write

Paramètres

Activité

GET /v1/activity/day Portée: reports:read

Paramètres

Affectations de temps

GET /v1/allocations Portée: reports:read

Paramètres

POST /v1/allocations Portée: time:write

Paramètres

Exports

POST /v1/exports Portée: reports:read

Paramètres

GET /v1/exports/{id} Portée: reports:read

Paramètres

Mon profil

GET /v1/me Portée: me

Membres

POST /v1/invitations Portée: org:admin

Paramètres

GET /v1/members Portée: org:admin

Paramètres

GET /v1/members/{id} Portée: org:admin

Paramètres

PATCH /v1/members/{id} Portée: org:admin

Paramètres

POST /v1/members/{id}/reactivate Portée: org:admin

Paramètres

POST /v1/members/{id}/suspend Portée: org:admin

Paramètres

Projets

GET /v1/projects Portée: reports:read

Paramètres

POST /v1/projects Portée: org:admin

Paramètres

GET /v1/projects/{id} Portée: reports:read

Paramètres

PUT /v1/projects/{id} Portée: org:admin

Paramètres

Rapports

GET /v1/reports/productivity Portée: reports:read

Paramètres

GET /v1/reports/projects Portée: reports:read

Paramètres

GET /v1/reports/summary Portée: reports:read

Paramètres

GET /v1/reports/targets Portée: reports:read

Paramètres

GET /v1/reports/users/{userId}/daily Portée: reports:read

Paramètres

Postes

GET /v1/shifts Portée: reports:read

Paramètres

POST /v1/shifts Portée: time:write

Paramètres

Tâches

GET /v1/projects/{id}/tasks Portée: reports:read

Paramètres

POST /v1/projects/{id}/tasks Portée: time:write

Paramètres

GET /v1/tasks/{id} Portée: reports:read

Paramètres

PUT /v1/tasks/{id} Portée: time:write

Paramètres

Équipes

GET /v1/teams Portée: reports:read

Paramètres

POST /v1/teams Portée: org:admin

GET `/v1/absences` Portée: `reports:read`

POST `/v1/absences` Portée: `time:write`

POST `/v1/absences/{id}/decision` Portée: `time:write`

GET `/v1/activity/day` Portée: `reports:read`

GET `/v1/allocations` Portée: `reports:read`

POST `/v1/allocations` Portée: `time:write`

POST `/v1/exports` Portée: `reports:read`

GET `/v1/exports/{id}` Portée: `reports:read`

GET `/v1/me` Portée: `me`

POST `/v1/invitations` Portée: `org:admin`

GET `/v1/members` Portée: `org:admin`

GET `/v1/members/{id}` Portée: `org:admin`

PATCH `/v1/members/{id}` Portée: `org:admin`

POST `/v1/members/{id}/reactivate` Portée: `org:admin`

POST `/v1/members/{id}/suspend` Portée: `org:admin`

GET `/v1/projects` Portée: `reports:read`

POST `/v1/projects` Portée: `org:admin`

GET `/v1/projects/{id}` Portée: `reports:read`

PUT `/v1/projects/{id}` Portée: `org:admin`

GET `/v1/reports/productivity` Portée: `reports:read`

GET `/v1/reports/projects` Portée: `reports:read`

GET `/v1/reports/summary` Portée: `reports:read`

GET `/v1/reports/targets` Portée: `reports:read`

GET `/v1/reports/users/{userId}/daily` Portée: `reports:read`

GET `/v1/shifts` Portée: `reports:read`

POST `/v1/shifts` Portée: `time:write`

GET `/v1/projects/{id}/tasks` Portée: `reports:read`

POST `/v1/projects/{id}/tasks` Portée: `time:write`

GET `/v1/tasks/{id}` Portée: `reports:read`

PUT `/v1/tasks/{id}` Portée: `time:write`

GET `/v1/teams` Portée: `reports:read`

POST `/v1/teams` Portée: `org:admin`

PATCH `/v1/teams/{id}` Portée: `org:admin`

GET `/v1/time-entries` Portée: `reports:read`

POST `/v1/time-entries` Portée: `time:write`

GET `/v1/time-entries/{id}` Portée: `reports:read`

PUT `/v1/time-entries/{id}` Portée: `time:write`

DELETE `/v1/time-entries/{id}` Portée: `time:write`

POST `/v1/time-entries/{id}/decision` Portée: `time:write`

GET `/v1/me/timer` Portée: `me`

POST `/v1/me/timer/start` Portée: `me`

POST `/v1/me/timer/stop` Portée: `me`

GET `/v1/webhook-endpoints` Portée: `webhooks:manage`

POST `/v1/webhook-endpoints` Portée: `webhooks:manage`

GET `/v1/webhook-endpoints/{id}` Portée: `webhooks:manage`

PATCH `/v1/webhook-endpoints/{id}` Portée: `webhooks:manage`

DELETE `/v1/webhook-endpoints/{id}` Portée: `webhooks:manage`

GET `/v1/webhook-endpoints/{id}/deliveries` Portée: `webhooks:manage`

GET `/v1/webhook-endpoints/{id}/deliveries/{deliveryId}` Portée: `webhooks:manage`

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

POST `/v1/webhook-endpoints/{id}/rotate-secret` Portée: `webhooks:manage`

POST `/v1/webhook-endpoints/{id}/test` Portée: `webhooks:manage`

GET `/v1/webhook-events` Portée: `webhooks:manage`