Referência da API pública

A API pública do Workify360 Focus permite que seus próprios scripts e ferramentas leiam relatórios e dados de tempo e façam alterações com as mesmas regras do painel. A API pública, as chaves de API e os webhooks fazem parte do plano Premium.

As operações desta página mantêm compatibilidade com versões anteriores. O documento OpenAPI legível por máquina com as mesmas operações:

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

Gerado a partir do contrato da API, versão 0.1.0 (c95fb97bb49a).

Autenticação

Envie uma chave de API pessoal no cabeçalho Authorization de cada requisição. Uma chave pertence à pessoa que a criou, age como essa pessoa e nunca faz mais do que a função atual dela permite. Uma requisição com chave ausente, incorreta, expirada ou revogada recebe 401 com o código unauthorized.

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

Como criar chaves, definir o escopo delas e revogá-las: Chaves de API e a API pública

Escopos

Cada operação exige um escopo, indicado ao lado dela. Uma chave tem acesso a uma operação quando tem esse escopo e quando a função, as equipes e o plano atuais do proprietário dela permitem a requisição, exatamente como no painel.

Escopo	O que permite
`me`	Seu próprio perfil e seu cronômetro
`reports:read`	Ler relatórios, lançamentos de tempo, ausências, turnos, equipes, projetos, tarefas e exportações
`time:write`	Adicionar e alterar lançamentos de tempo, ausências, turnos, tarefas e tempo atribuído a tarefas, e aprovar ou recusar solicitações
`org:admin`	Gerenciar membros, equipes, convites e projetos
`webhooks:manage`	Gerenciar endpoints de webhook

Limites de requisições

Cada chave pode enviar 600 unidades por minuto, e uma organização 1.800 para todas as suas chaves juntas. Uma requisição que altera algo (qualquer uma que não seja GET ou HEAD) conta como duas unidades; as demais, como uma. Uma chave também pode enviar no máximo 60 unidades de uma vez, recarregadas a 10 por segundo: mais de 60 leituras (ou 30 alterações) em sequência recebem 429 mesmo abaixo de 600 por minuto.

Cabeçalho	Significado
`RateLimit: "key";r=598;t=2`	Em toda resposta contabilizada: as unidades que restam à chave e os segundos até que sejam totalmente recarregadas
`RateLimit-Policy: "key";q=600;w=60, "tenant";q=1800;w=60`	Em toda resposta contabilizada: os limites por minuto da chave e da organização
`Retry-After: 12`	Com 429 (código `rate_limited`): os segundos de espera antes da próxima requisição

Erros

Um erro é um documento de problema RFC 9457 (Content-Type: application/problem+json). code é um código estável em snake_case no qual seu código pode se basear; title é um texto em inglês para logs. type é o endereço de ajuda do código, https://workify360.com/help/errors/<code>/ com cada _ escrito como -, que abre o artigo de ajuda que explica o código, quando o código tem um.

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

Alguns problemas trazem mais campos: errors (os erros de campo de um 422 validation_failed), action (a permissão a que um 403 forbidden se refere), requiredPlan (402 feature_not_in_plan), retryAfterSeconds (429 e 503) e traceId (informe-o ao entrar em contato com o suporte).

Status	Código	Quando
400	`invalid_request`	Um parâmetro está mal formatado ou ausente
401	`unauthorized`	A chave está ausente, incorreta, expirada ou revogada, ou o proprietário dela saiu da organização
402	`feature_not_in_plan`, `subscription_read_only`	O plano não inclui o recurso, ou a assinatura está em modo somente leitura
403	`forbidden`, `feature_not_enabled`	A chave não tem o escopo, ou a função, as equipes ou as configurações atuais do proprietário não permitem a requisição
412	`version_conflict`	A versão em `If-Match` não é mais a atual; leia o recurso novamente
422	`validation_failed`	O corpo é inválido; `errors` lista os campos
428	`precondition_required`	A operação exige um cabeçalho `If-Match` com a versão que você leu
429	`rate_limited`	Requisições demais; aguarde os segundos indicados em `Retry-After`

Os códigos que têm artigo de ajuda aparecem como links na lista de operações.

Webhooks

Em vez de consultar a API repetidamente, um endpoint seu pode receber uma requisição HTTPS assinada quando algo muda. Os eventos, o formato da requisição, como verificar a assinatura em Node.js e Python, as novas tentativas e a rotação do segredo estão explicados no artigo de ajuda: Webhooks

Operações

Agrupadas por área. Os resumos e as descrições dos campos vêm do contrato da API.

Ausências

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

List absences overlapping a range.

Parâmetros

Nome	Em	Tipo	Descrição
`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)

Respostas

200 AbsencePage

Erros

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

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

Request (or record) an absence.

Parâmetros

Nome	Em	Tipo	Descrição
`Idempotency-Key`obrigatório	cabeçalho	string	Required: the same key and body return the first answer

Corpo da requisição

AbsenceRequest

Respostas

201 AbsenceDto

Erros

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Id
`If-Match`obrigatório	cabeçalho	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Corpo da requisição

CalendarDecisionRequest

Respostas

200 AbsenceDto

Erros

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)

Atividade

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`date`	query	string (date)	The user's local day (required).
`userId`	query	string (uuid)	Default: the caller; another user must be visible (else 403).

Respostas

200 ActivityDayDto

Erros

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

Alocações de tempo

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

Parâmetros

Nome	Em	Tipo	Descrição
`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).

Respostas

200 AllocationPage

Erros

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`Idempotency-Key`	cabeçalho	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Corpo da requisição

AllocationCreateRequest

Respostas

201 AllocationCreatedDto

Erros

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

Exportações

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`Idempotency-Key`obrigatório	cabeçalho	string	Required: the same key and body return the first answer

Corpo da requisição

CreateExportRequest

Respostas

202 ExportJobDto

Erros

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

One export job (poll every 2 s).

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Id

Respostas

200 ExportJobDto

Erros

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

Eu

GET `/v1/me` Escopo: `me`

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

Respostas

200 MeDto

Erros

401 unauthorized

Membros

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

Invite a person.

Parâmetros

Nome	Em	Tipo	Descrição
`Idempotency-Key`obrigatório	cabeçalho	string	Required: 1–255 printable ASCII characters

Corpo da requisição

CreateInvitation

Respostas

201 InvitationResult

Erros

409 already_member
422 validation_failed, idempotency_key_reused

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

List members.

Parâmetros

Nome	Em	Tipo	Descrição
`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

Respostas

200 MemberPage

Erros

403 No right

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

One member.

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Membership id

Respostas

200 MemberDto

Erros

404 member_not_found

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Membership id
`If-Match`obrigatório	cabeçalho	string	ETag of the member ("v<n>")

Corpo da requisição

PatchMember

Respostas

200 MemberDto

Erros

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

Reactivate a suspended member.

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Membership id

Respostas: 200 MemberDto

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Membership id

Respostas

200 MemberDto

Erros

409 conflict (an invitation is revoked instead)

Projetos

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

Parâmetros

Nome	Em	Tipo	Descrição
`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).

Respostas

200 ProjectPage

Erros

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

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

Add a project (Owners and Admins).

Parâmetros

Nome	Em	Tipo	Descrição
`Idempotency-Key`	cabeçalho	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Corpo da requisição

ProjectRequest

Respostas

201 ProjectDto

Erros

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

One project (invisible projects are 404).

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Project id

Respostas

200 ProjectDto

Erros

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

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Project id
`If-Match`obrigatório	cabeçalho	string	The ETag the caller read (412 version_conflict when it changed)

Corpo da requisição

ProjectRequest

Respostas

200 ProjectDto

Erros

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)

Relatórios

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`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)

Respostas

200 PeriodReportDto

Erros

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

Parâmetros

Nome	Em	Tipo	Descrição
`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).

Respostas

200 ProjectReportDto

Erros

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

The summary of the visible users over a range.

Parâmetros

Nome	Em	Tipo	Descrição
`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).

Respostas

200 SummaryDto

Erros

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`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.

Respostas

200 TargetListDto

Erros

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`userId`obrigatório	caminho	string (uuid)	User
`from`	query	string (date)
`to`	query	string (date)	At most 93 days after `from`.

Respostas

200 UserDailyDto

Erros

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

Turnos

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

List the shifts starting in a range.

Parâmetros

Nome	Em	Tipo	Descrição
`from`	query	string (date)
`to`	query	string (date)
`teamId`	query	string (uuid)
`userId`	query	string (uuid)
`includeOpen`	query	boolean	Also open shifts (default true).

Respostas

200 ShiftListDto

Erros

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

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

Create a shift (assigned or open).

Parâmetros

Nome	Em	Tipo	Descrição
`Idempotency-Key`obrigatório	cabeçalho	string	Required: the same key and body return the first answer

Corpo da requisição

ShiftBody

Respostas

201 ShiftDto

Erros

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

Tarefas

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

A visible project's tasks, by sort order.

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	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).

Respostas

200 TaskPage

Erros

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Project id
`Idempotency-Key`	cabeçalho	string \| null	The same key and body return the first answer (a different body: 422 idempotency_key_reused)

Corpo da requisição

TaskRequest

Respostas

201 TaskDto

Erros

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

One task of a visible project.

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Task id

Respostas

200 TaskDto

Erros

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

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

Change a task (the whole body).

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Task id
`If-Match`obrigatório	cabeçalho	string	The ETag the caller read (412 version_conflict when it changed)

Corpo da requisição

TaskRequest

Respostas

200 TaskDto

Erros

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)

Equipes

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

List teams.

Parâmetros

Nome	Em	Tipo	Descrição
`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

Respostas: 200 TeamPage

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

Create a team (the G1 endpoint).

Corpo da requisição

CreateTeam

Respostas

201 TeamDto

Erros

403 forbidden (action teams.create)
409 team_name_taken

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

Rename a team or change its description.

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Team id
`If-Match`obrigatório	cabeçalho	string	ETag of the team

Corpo da requisição

PatchTeam

Respostas

200 TeamDto

Erros

409 team_name_taken

Lançamentos de tempo

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`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.

Respostas

200 TimeEntryPage

Erros

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`Idempotency-Key`obrigatório	cabeçalho	string	Required: the same key and body return the first answer

Corpo da requisição

CreateTimeEntryRequest

Respostas

201 TimeEntryDto

Erros

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Entry id

Respostas

200 TimeEntryDto

Erros

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

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

Replace an entry's editable fields.

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Entry id
`If-Match`obrigatório	cabeçalho	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Corpo da requisição

UpdateTimeEntryRequest

Respostas

200 TimeEntryDto

Erros

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Entry id
`If-Match`obrigatório	cabeçalho	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Respostas

204 (sem corpo)

Erros

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	Entry id
`If-Match`obrigatório	cabeçalho	string	ETag of the resource (`"v<n>"`); missing: 428, stale: 412

Corpo da requisição

TimeEntryDecisionRequest

Respostas

200 TimeEntryDto

Erros

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)

Cronômetro

GET `/v1/me/timer` Escopo: `me`

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

Parâmetros

Nome	Em	Tipo	Descrição
`If-None-Match`	cabeçalho	string \| null	The ETag the caller holds (304 when unchanged)

Respostas

200 TimerDto · 304 (sem corpo)

Erros

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

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`Idempotency-Key`	cabeçalho	string \| null	The client's command id; a retry returns the first answer

Corpo da requisição

TimerStartRequest

Respostas

200 TimerCommandResultDto

Erros

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`Idempotency-Key`	cabeçalho	string \| null	The client's command id; a retry returns the first answer

Corpo da requisição

TimerAtRequest

Respostas

200 TimerCommandResultDto

Erros

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

The tenant's webhook endpoints.

Parâmetros

Nome	Em	Tipo	Descrição
`cursor`	query	string
`limit`	query	integer (int32)	1–200, default 50.

Respostas

200 WebhookEndpointPage

Erros

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

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

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

Corpo da requisição

CreateWebhookEndpointRequest

Respostas

201 CreatedWebhookEndpointDto

Erros

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

One webhook endpoint.

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	The endpoint

Respostas

200 WebhookEndpointDto

Erros

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

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	The endpoint
`If-Match`obrigatório	cabeçalho	string	The endpoint's ETag (`"v<n>"`)

Corpo da requisição

UpdateWebhookEndpointRequest

Respostas

200 WebhookEndpointDto

Erros

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

Delete an endpoint and its deliveries.

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	The endpoint

Respostas

204 (sem corpo)

Erros

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

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

The deliveries of an endpoint, newest first.

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	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.

Respostas

200 WebhookDeliveryPage

Erros

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

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

One delivery with the body that was sent.

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	The endpoint
`deliveryId`obrigatório	caminho	string	The delivery (a 64-bit integer)

Respostas

200 WebhookDeliveryDetailDto

Erros

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	The endpoint
`deliveryId`obrigatório	caminho	string	The delivery (a 64-bit integer)

Respostas

202 AcceptedDto

Erros

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

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	The endpoint

Respostas

200 RotatedWebhookSecretDto

Erros

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

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

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

Parâmetros

Nome	Em	Tipo	Descrição
`id`obrigatório	caminho	string (uuid)	The endpoint

Respostas

202 WebhookTestDto

Erros

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

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

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

Respostas

200 WebhookEventsDto

Erros

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

Esquemas

Os corpos de requisição e de resposta que as operações usam. Os campos obrigatórios estão marcados.

AbsenceDto

An absence.

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

AbsencePage

GET /v1/absences.

Campo	Tipo	Descrição
`items`obrigatório	AbsenceDto[]
`nextCursor`	string \| null

AbsencePermissionsDto

Campo	Tipo	Descrição
`canApprove`obrigatório	boolean
`canCancel`obrigatório	boolean
`canEdit`obrigatório	boolean

AbsenceRequest

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

Campo	Tipo	Descrição
`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.

Campo	Tipo	Descrição
`color`obrigatório	string
`countsAsWorked`obrigatório	boolean
`deductsFromBalance`obrigatório	boolean
`id`obrigatório	string (uuid)
`key`	string \| null
`name`obrigatório	string
`paid`obrigatório	boolean
`timeEffect`obrigatório	string

AcceptedDto

202 Accepted of a queued job.

Campo	Tipo	Descrição
`accepted`obrigatório	boolean	Always `true`.

AccessDto

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

Campo	Tipo	Descrição
`assignableRoles`obrigatório	string[]
`canManageCompanySettings`obrigatório	boolean
`canManageTeams`obrigatório	boolean
`canManageUsers`obrigatório	boolean
`manageTeamIds`obrigatório	string[]
`scope`obrigatório	string	`company`, `teams` or `self`.
`unassignedFallback`obrigatório	boolean
`viewTeamIds`obrigatório	string[]

ActivityDayDto

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

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

ActivitySlotDto

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

Campo	Tipo	Descrição
`activeMs`obrigatório	integer (int64)
`apps`obrigatório	AppUsageDto[]
`neutralMs`obrigatório	integer (int64)
`offlineMs`obrigatório	integer (int64)
`productiveMs`obrigatório	integer (int64)
`slotStart`obrigatório	string (date-time)
`unproductiveMs`obrigatório	integer (int64)

AffectedAllocationDto

An allocation replace changed.

Campo	Tipo	Descrição
`change`obrigatório	string	`trimmed`, `split` or `deleted`.
`id`obrigatório	string (uuid)

AllocationCreateRequest

POST /v1/allocations (Idempotency-Key).

Campo	Tipo	Descrição
`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.

Campo	Tipo	Descrição
`affected`obrigatório	AffectedAllocationDto[]
`allocation`obrigatório	AllocationDto

AllocationDto

Time on a project.

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

AllocationPage

GET /v1/allocations.

Campo	Tipo	Descrição
`items`obrigatório	AllocationDto[]
`nextCursor`	string \| null

AllocationPermissionsDto

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

Campo	Tipo	Descrição
`delete`obrigatório	boolean
`edit`obrigatório	boolean

AppTotalDto

Campo	Tipo	Descrição
`activeMs`obrigatório	integer (int64)
`appKey`obrigatório	string
`categoryKey`	string \| null
`level`	string \| null	Level in the response's `levelContext`.
`name`obrigatório	string
`percentage`obrigatório	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".

Campo	Tipo	Descrição
`activeMs`obrigatório	integer (int64)
`appKey`obrigatório	string
`categoryKey`	string \| null
`level`	string \| null	The app's own rule (`productive`, `unproductive`, `neutral`).
`levelSource`	string \| null	`team`, `company`, `default` or `offline`.
`name`obrigatório	string

BudgetDto

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

Campo	Tipo	Descrição
`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).

Campo	Tipo	Descrição
`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).

Campo	Tipo	Descrição
`decision`	string \| null
`note`	string \| null

CalendarPersonDto

A user with the current team.

Campo	Tipo	Descrição
`fullName`	string \| null
`id`obrigatório	string (uuid)
`teamId`	string (uuid) \| null
`teamName`	string \| null

CalendarUserRefDto

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

Campo	Tipo	Descrição
`fullName`	string \| null
`id`obrigatório	string (uuid)

CapabilitiesDto

Subscription capabilities.

Campo	Tipo	Descrição
`features`obrigatório	string[]
`readOnly`obrigatório	boolean

CategoryUsageDto

Campo	Tipo	Descrição
`activeMs`obrigatório	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.

Campo	Tipo	Descrição
`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.

Campo	Tipo	Descrição
`email`obrigatório	string
`fullName`obrigatório	string
`locale`	string \| null	Language of the e-mail and the acceptance page (`tr`, `en`); the organization's default otherwise.
`role`obrigatório	string	`admin`, `team_admin`, `manager` or `employee`.
`teamId`	string (uuid) \| null
`timeZone`	string \| null
`viewerTeamIds`	string (uuid)[]

CreateTeam

POST /v1/teams.

Campo	Tipo	Descrição
`description`	string \| null	At most 500 characters.
`name`obrigatório	string	1–100 characters, unique among active teams (Turkish case folding).

CreateTimeEntryRequest

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

Campo	Tipo	Descrição
`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.

Campo	Tipo	Descrição
`description`	string \| null	≤ 200 characters.
`eventTypes`obrigatório	string[]	1–50 catalog event types of the tenant's plan.
`url`obrigatório	string	`https://…` (≤ 2048; no user info, no fragment; every resolved address public).

CreatedWebhookEndpointDto

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

Campo	Tipo	Descrição
`endpoint`obrigatório	WebhookEndpointDto
`secret`obrigatório	string	`whsec_<base64>`: shown once, never again.

DailyHolidayDto

A holiday of a daily report day.

Campo	Tipo	Descrição
`half`	string \| null
`key`obrigatório	string
`name`obrigatório	string	English name; `nameTr` is the Turkish one.
`nameTr`obrigatório	string

DayAbsenceDto

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

Campo	Tipo	Descrição
`color`obrigatório	string
`fraction`obrigatório	number (double)	The day's approved absence coverage (0–1).
`half`	string \| null
`typeKey`	string \| null
`typeName`	string \| null
`unit`obrigatório	string

DayAttendanceDto

Attendance of the day on the day plan.

Campo	Tipo	Descrição
`expectedEnd`	string (date-time) \| null
`expectedStart`	string (date-time) \| null
`flexible`obrigatório	boolean
`lateByMs`obrigatório	integer (int64)
`lateToleranceMinutes`obrigatório	integer (int32)
`leftEarly`obrigatório	boolean
`leftEarlyByMs`obrigatório	integer (int64)
`status`obrigatório	string	`onTime`, `late`, `absent`, `notStarted`, `dayOff`, `onLeave`, `holiday`.
`targetMs`obrigatório	integer (int64)	The plan's target (the Effectiveness % denominator).
`workday`obrigatório	boolean

DayPlanDto

The day plan of one user's day.

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

DayProductivityDto

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

Campo	Tipo	Descrição
`effectivenessPct`	number (double) \| null	productive ÷ target × 100 (not capped); `null` without a target.
`neutralMs`obrigatório	integer (int64)
`productiveMs`obrigatório	integer (int64)
`productivityPct`	number (double) \| null	productive ÷ worked × 100, one decimal; `null` without worked time.
`targetMs`obrigatório	integer (int64)
`unproductiveMs`obrigatório	integer (int64)

DayTotalDto

One local day of a summary.

Campo	Tipo	Descrição
`activeMs`obrigatório	integer (int64)
`activeUserCount`obrigatório	integer (int32)
`atWorkMs`obrigatório	integer (int64)
`date`obrigatório	string (date)
`idleMs`obrigatório	integer (int64)
`neutralMs`obrigatório	integer (int64)
`offlineMs`obrigatório	integer (int64)
`privateMs`obrigatório	integer (int64)
`productiveMs`obrigatório	integer (int64)
`productivityPct`	number (double) \| null
`unproductiveMs`obrigatório	integer (int64)

DomainTotalDto

Campo	Tipo	Descrição
`activeMs`obrigatório	integer (int64)
`categoryKey`	string \| null
`domain`obrigatório	string
`level`	string \| null
`percentage`obrigatório	number (double)

DomainUsageDto

Campo	Tipo	Descrição
`activeMs`obrigatório	integer (int64)
`categoryKey`	string \| null
`domain`obrigatório	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).

Campo	Tipo	Descrição
`dueAt`	string (date-time) \| null	The deadline of an unverified account (`Identity__EmailVerificationGraceHours` after its creation).
`state`obrigatório	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}]).

Campo	Tipo	Descrição
`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.

Campo	Tipo	Descrição
`includeInactiveUsers`	boolean
`teamId`	string \| null
`userIds`	string \| null[] \| null

ExportJobDto

An export job as the panel lists and polls it.

Campo	Tipo	Descrição
`createdAt`obrigatório	string (date-time)
`dataset`obrigatório	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`obrigatório	string
`from`obrigatório	string (date)
`groupBy`	string \| null
`id`obrigatório	string (uuid)
`locale`obrigatório	string
`progress`obrigatório	integer (int32)	0–100.
`rowCount`	integer (int32) \| null
`startedAt`	string (date-time) \| null
`status`obrigatório	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`obrigatório	string (date)

ExportOptionsDto

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

Campo	Tipo	Descrição
`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.

Campo	Tipo	Descrição
`code`obrigatório	string	Stable snake_case code (`required`, `too_long`, `invalid`, ...).
`field`obrigatório	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).

Campo	Tipo	Descrição
`half`	string \| null
`key`obrigatório	string	Built-in key (`republic_day`, …) or `custom`.
`name`obrigatório	string
`nameEn`obrigatório	string
`nameTr`obrigatório	string
`source`	string \| null	`builtin` or `tenant`.

HostUsageDto

Campo	Tipo	Descrição
`activeMs`obrigatório	integer (int64)
`domain`	string \| null
`host`obrigatório	string
`level`obrigatório	string
`levelSource`obrigatório	string
`matchedKey`	string \| null	Key of the matching domain rule; `null` for the default.

InvitationEmail

What happened to the invitation e-mail.

Campo	Tipo	Descrição
`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`obrigatório	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.

Campo	Tipo	Descrição
`expiresAt`obrigatório	string
`id`obrigatório	string (uuid)

InvitationResult

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

Campo	Tipo	Descrição
`email`obrigatório	InvitationEmail
`invitation`obrigatório	InvitationRef
`member`obrigatório	MemberDto

LevelContextDto

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

Campo	Tipo	Descrição
`kind`obrigatório	string	`user` (a `userId` filter: that user's current team), `team` (a `teamId` filter) or `company`.
`teamId`	string (uuid) \| null

MeDto

GET /v1/me.

Campo	Tipo	Descrição
`access`obrigatório	AccessDto
`capabilities`obrigatório	CapabilitiesDto
`effectiveTimeZone`obrigatório	string
`membership`obrigatório	MeMembership
`organization`obrigatório	MeOrganization
`organizations`obrigatório	OrganizationChoice[]
`session`	MeSession \| null
`user`obrigatório	MeUser

MeMembership

The membership in the current organization.

Campo	Tipo	Descrição
`id`obrigatório	string (uuid)
`isTracked`obrigatório	boolean
`joinedAt`	string \| null
`role`obrigatório	string
`status`obrigatório	string
`teamId`	string (uuid) \| null
`teamName`	string \| null
`timeZone`	string \| null
`viewerTeamIds`obrigatório	string (uuid)[]

MeOrganization

The current organization.

Campo	Tipo	Descrição
`defaultLocale`obrigatório	string
`id`obrigatório	string (uuid)
`name`obrigatório	string
`slug`obrigatório	string
`status`obrigatório	string
`timeZone`obrigatório	string

MeSession

The current session.

Campo	Tipo	Descrição
`absoluteExpiresAt`obrigatório	string
`amr`obrigatório	string[]
`authTime`obrigatório	string
`clientId`obrigatório	string
`id`obrigatório	string (uuid)
`idleExpiresAt`obrigatório	string

MeUser

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

Campo	Tipo	Descrição
`email`obrigatório	string
`emailVerification`obrigatório	EmailVerificationDto	The e-mail verification gate (owner decision 3 Oct 2026).
`emailVerified`obrigatório	boolean
`fullName`	string \| null
`id`obrigatório	string (uuid)
`locale`obrigatório	string

MemberDto

A membership with its person (MemberDto).

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

MemberInvitationDto

The invitation of an invited member.

Campo	Tipo	Descrição
`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`obrigatório	string
`id`obrigatório	string (uuid)
`lastSentAt`obrigatório	string
`sentCount`obrigatório	integer (int32)

MemberPage

A page of members (OpenAPI).

Campo	Tipo	Descrição
`items`obrigatório	MemberDto[]
`nextCursor`	string \| null

MemberRefDto

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

Campo	Tipo	Descrição
`active`obrigatório	boolean	The membership is active and (for an endpoint or a tenant connection) still an Owner or Admin.
`name`	string \| null
`userId`obrigatório	string (uuid)

NamedRefDto

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

Campo	Tipo	Descrição
`id`obrigatório	string (uuid)
`name`obrigatório	string

OrganizationChoice

One organization of the person (sec.user_memberships).

Campo	Tipo	Descrição
`current`obrigatório	boolean
`id`obrigatório	string (uuid)
`name`obrigatório	string
`role`obrigatório	string
`selectable`obrigatório	boolean	Can this session's sign-in method open it (design §4.5.3)?

PatchMember

PATCH /v1/members/{id}.

Campo	Tipo	Descrição
`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}.

Campo	Tipo	Descrição
`description`	string \| null
`name`	string \| null

PeriodReportDto

GET /v1/reports/productivity.

Campo	Tipo	Descrição
`from`obrigatório	string (date)
`groupBy`obrigatório	string
`levelContext`obrigatório	LevelContextDto
`periods`obrigatório	ReportPeriodDto[]
`subject`obrigatório	ReportSubjectDto
`teams`obrigatório	TeamPeriodsDto[]	Only for the company subject: every visible team over its current members.
`to`obrigatório	string (date)
`totals`obrigatório	ReportFiguresDto

PlanAbsenceDto

Campo	Tipo	Descrição
`color`obrigatório	string
`countsAsWorked`obrigatório	boolean	`timeEffect == worked`.
`endTime`	string \| null
`half`	string \| null
`id`obrigatório	string (uuid)
`startTime`	string \| null	Local start and end of an `hours` absence.
`status`obrigatório	string	`approved` or `pending`.
`timeEffect`obrigatório	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`obrigatório	string	`days`, `half_day` or `hours`.

PlanShiftDto

Campo	Tipo	Descrição
`color`	string \| null
`end`obrigatório	string (date-time)
`endTime`obrigatório	string	Local end; before the start for a night shift.
`id`obrigatório	string (uuid)
`location`obrigatório	string
`minMinutes`obrigatório	integer (int32)
`start`obrigatório	string (date-time)
`startTime`obrigatório	string	Local start (`HH:mm`, the shift's zone).

Problem

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

Campo	Tipo	Descrição
`action`	string \| null	Permission key of a 403 (`teams.create`).
`code`obrigatório	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`obrigatório	integer (int32)
`title`obrigatório	string	English title of the code (clients translate `code`).
`traceId`	string \| null	W3C trace id of the request.
`type`obrigatório	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).

Campo	Tipo	Descrição
`billableMinor`obrigatório	integer (int64)	The billable hours at their rate.
`costMinor`obrigatório	integer (int64)	Every allocated hour at its rate.
`currency`obrigatório	string

ProjectBudgetUsageDto

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

Campo	Tipo	Descrição
`budgetMinor`	integer (int64) \| null	`null` unless `costsIncluded`.
`budgetMinutes`	integer (int64) \| null
`kind`obrigatório	string	`hours` or `amount`.
`projectId`obrigatório	string (uuid)
`usedMinor`	integer (int64) \| null	The cost in the project's currency; `null` unless `costsIncluded`.
`usedMs`obrigatório	integer (int64)
`usedRatio`	string \| null	Used / budget, 4 decimals (`null` for an amount budget without `costsIncluded`).

ProjectDto

A project.

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

ProjectPage

GET /v1/projects.

Campo	Tipo	Descrição
`items`obrigatório	ProjectDto[]
`nextCursor`	string \| null

ProjectPermissionsDto

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

Campo	Tipo	Descrição
`archive`obrigatório	boolean
`delete`obrigatório	boolean	Only a project without time.
`edit`obrigatório	boolean	The project's fields (Owners and Admins).
`manageMembers`obrigatório	boolean	The team (an Admin or the project's manager; only an Admin changes managers).
`manageTasks`obrigatório	boolean	Tasks (an Admin or the project's manager).
`track`obrigatório	boolean	The caller may track time on it now.

ProjectRefDto

A project reference of an allocation.

Campo	Tipo	Descrição
`color`	string \| null	`#RRGGBB`.
`id`obrigatório	string (uuid)
`name`obrigatório	string

ProjectReportDto

GET /v1/reports/projects.

Campo	Tipo	Descrição
`budgets`obrigatório	ProjectBudgetUsageDto[]
`costsIncluded`obrigatório	boolean	The caller sees rates and amounts (`projects.costs.read`).
`from`obrigatório	string (date)
`groupBy`obrigatório	string[]
`rows`obrigatório	ProjectReportRowDto[]
`to`obrigatório	string (date)
`totals`obrigatório	ProjectReportTotalsDto

ProjectReportKeysDto

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

Campo	Tipo	Descrição
`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.

Campo	Tipo	Descrição
`allocatedMs`obrigatório	integer (int64)
`amounts`	ProjectAmountDto[] \| null	`null` unless `costsIncluded`.
`billableMs`obrigatório	integer (int64)
`keys`obrigatório	ProjectReportKeysDto
`nonBillableMs`obrigatório	integer (int64)
`productiveMs`	integer (int64) \| null	With `includeProductive` only.
`unratedMs`obrigatório	integer (int64)	Time without any rate (it is left out of the amounts).

ProjectReportTotalsDto

The totals of the report.

Campo	Tipo	Descrição
`allocatedMs`obrigatório	integer (int64)
`amounts`	ProjectAmountDto[] \| null
`billableMs`obrigatório	integer (int64)
`nonBillableMs`obrigatório	integer (int64)
`productiveMs`	integer (int64) \| null
`unratedMs`obrigatório	integer (int64)

ProjectRequest

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

Campo	Tipo	Descrição
`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).

Campo	Tipo	Descrição
`absenceCreditMs`obrigatório	integer (int64)
`absentDays`obrigatório	integer (int32)
`activeMs`obrigatório	integer (int64)
`activeUserCount`obrigatório	integer (int32)
`effectivenessPct`	number (double) \| null
`idleMs`obrigatório	integer (int64)
`lateDays`obrigatório	integer (int32)
`leaveDays`obrigatório	number (double)
`leftEarlyDays`obrigatório	integer (int32)
`neutralMs`obrigatório	integer (int64)
`offlineMs`obrigatório	integer (int64)
`overtimeDays`obrigatório	integer (int32)
`overtimeMs`obrigatório	integer (int64)
`productiveMs`obrigatório	integer (int64)
`productivityPct`	number (double) \| null
`targetMs`obrigatório	integer (int64)
`unproductiveMs`obrigatório	integer (int64)
`userCount`obrigatório	integer (int32)
`workedMs`obrigatório	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).

Campo	Tipo	Descrição
`kind`obrigatório	string	`company`, `teams` or `self`.
`teamIds`obrigatório	string (uuid)[]	The visible teams of a `teams` scope, sorted; empty otherwise (company = all).
`unassignedFallback`obrigatório	boolean	A Manager without teams who sees the whole company until assigned.

ReportSubjectDto

Whom a report is about.

Campo	Tipo	Descrição
`id`	string (uuid) \| null
`kind`obrigatório	string	`company`, `team` or `user`.
`name`	string \| null

RotatedWebhookSecretDto

RotatedWebhookSecretDto: the new signing secret, shown once.

Campo	Tipo	Descrição
`previousSecretExpiresAt`obrigatório	string	Until then deliveries carry both signatures.
`secret`obrigatório	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.

Campo	Tipo	Descrição
`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.

Campo	Tipo	Descrição
`breakMinutes`obrigatório	integer (int32)
`color`	string \| null
`createdAt`obrigatório	string (date-time)
`createdBy`obrigatório	CalendarUserRefDto
`crossesMidnight`obrigatório	boolean
`date`obrigatório	string (date)
`durationMinutes`obrigatório	integer (int32)
`end`obrigatório	string (date-time)
`endTime`obrigatório	string
`id`obrigatório	string (uuid)
`location`obrigatório	string
`minMinutes`obrigatório	integer (int32)
`note`	string \| null
`open`obrigatório	boolean	No user assigned.
`permissions`obrigatório	ShiftPermissionsDto
`source`obrigatório	string	`manual`, `template`, `copy` or `request`.
`start`obrigatório	string (date-time)
`startTime`obrigatório	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`obrigatório	string
`updatedAt`obrigatório	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).

Campo	Tipo	Descrição
`items`obrigatório	ShiftDto[]

ShiftPermissionsDto

Campo	Tipo	Descrição
`canDelete`obrigatório	boolean
`canEdit`obrigatório	boolean
`canPickUp`obrigatório	boolean
`canRequestSwap`obrigatório	boolean

SummaryDto

The summary of the visible users over a range.

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

TargetItemDto

Campo	Tipo	Descrição
`activeMs`obrigatório	integer (int64)
`categoryKey`	string \| null
`categorySource`obrigatório	string	`tenant`, `builtin` or `none`.
`domain`	string \| null
`level`obrigatório	string
`levelSource`obrigatório	string	`team`, `company` or `default`.
`matchedKey`	string \| null
`name`obrigatório	string
`percentage`obrigatório	number (double)
`targetKey`obrigatório	string
`targetType`obrigatório	string	`app` for apps, `domain` for domains and hosts.
`userCount`obrigatório	integer (int32)

TargetListDto

The "Apps & URLs" list.

Campo	Tipo	Descrição
`from`obrigatório	string (date)
`items`obrigatório	TargetItemDto[]	By active time descending, then key.
`levelContext`obrigatório	LevelContextDto
`nextCursor`	string \| null
`to`obrigatório	string (date)
`total`obrigatório	integer (int32)	Targets matching the filters (before paging).
`totalActiveMs`obrigatório	integer (int64)	Active time over every target of the type before the filters (the percentage base).
`type`obrigatório	string	`app`, `domain` or `host`.

TaskDto

A task.

Campo	Tipo	Descrição
`archived`obrigatório	boolean
`assignee`	NamedRefDto \| null
`createdAt`obrigatório	string (date-time)
`description`	string \| null
`dueDate`	string (date) \| null
`effectiveBillable`obrigatório	boolean
`estimateMinutes`	integer (int64) \| null
`id`obrigatório	string (uuid)
`isBillable`	boolean \| null	`null` takes the project's value.
`name`obrigatório	string
`permissions`obrigatório	TaskPermissionsDto
`projectId`obrigatório	string (uuid)
`sortOrder`obrigatório	integer (int64)
`spentMs`obrigatório	integer (int64)
`status`obrigatório	string	`open`, `in_progress` or `done`.
`updatedAt`obrigatório	string (date-time)

TaskPage

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

Campo	Tipo	Descrição
`items`obrigatório	TaskDto[]
`nextCursor`	string \| null

TaskPermissionsDto

What the caller may do with a task.

Campo	Tipo	Descrição
`delete`obrigatório	boolean	Only a task without time.
`edit`obrigatório	boolean

TaskRequest

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

Campo	Tipo	Descrição
`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).

Campo	Tipo	Descrição
`archivedAt`	string \| null
`createdAt`obrigatório	string
`description`	string \| null
`id`obrigatório	string (uuid)
`leads`obrigatório	object[]	TeamAdmins and Managers of the team: `[{membershipId, userId, fullName, role}]`.
`memberCount`obrigatório	integer (int64)	Members whose primary team this is (left members excluded).
`name`obrigatório	string
`updatedAt`obrigatório	string

TeamPage

A page of teams (OpenAPI).

Campo	Tipo	Descrição
`items`obrigatório	TeamDto[]
`nextCursor`	string \| null

TeamPeriodsDto

Campo	Tipo	Descrição
`periods`obrigatório	ReportPeriodDto[]
`teamId`obrigatório	string (uuid)
`teamName`	string \| null
`totals`obrigatório	ReportFiguresDto

TeamTotalDto

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

Campo	Tipo	Descrição
`absenceCreditMs`obrigatório	integer (int64)
`absentDays`obrigatório	integer (int32)
`activeMs`obrigatório	integer (int64)
`activeUserCount`obrigatório	integer (int32)
`effectivenessPct`	number (double) \| null
`holidayDays`obrigatório	number (double)
`idleMs`obrigatório	integer (int64)
`lateDays`obrigatório	integer (int32)
`leaveDays`obrigatório	number (double)
`leftEarlyDays`obrigatório	integer (int32)
`memberCount`obrigatório	integer (int32)
`neutralMs`obrigatório	integer (int64)
`offlineMs`obrigatório	integer (int64)
`overtimeMs`obrigatório	integer (int64)
`productiveMs`obrigatório	integer (int64)
`productivityPct`	number (double) \| null
`shiftDays`obrigatório	integer (int32)
`teamId`	string (uuid) \| null	`null` for the users without a team.
`teamName`	string \| null
`unproductiveMs`obrigatório	integer (int64)
`workedMs`obrigatório	integer (int64)

TimeEntryDecisionRequest

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

Campo	Tipo	Descrição
`decision`	string \| null	`approve` or `reject`.
`note`	string \| null	At most 500 characters.

TimeEntryDto

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

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

TimeEntryPage

GET /v1/time-entries: by start.

Campo	Tipo	Descrição
`items`obrigatório	TimeEntryDto[]
`nextCursor`	string \| null

TimeEntryPermissionsDto

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

Campo	Tipo	Descrição
`canApprove`obrigatório	boolean
`canDelete`obrigatório	boolean
`canEdit`obrigatório	boolean

TimeEntryUserRefDto

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

Campo	Tipo	Descrição
`fullName`	string \| null
`id`obrigatório	string (uuid)

TimeIntervalDto

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

Campo	Tipo	Descrição
`end`obrigatório	string (date-time)
`start`obrigatório	string (date-time)

TimerAtRequest

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

Campo	Tipo	Descrição
`at`	string (date-time) \| null

TimerCommandResultDto

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

Campo	Tipo	Descrição
`applied`obrigatório	boolean
`closed`obrigatório	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`obrigatório	TimerDto

TimerDto

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

Campo	Tipo	Descrição
`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`obrigatório	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`obrigatório	string	`running` or `stopped`.
`task`	NamedRefDto \| null

TimerLastDto

The segment that ended last.

Campo	Tipo	Descrição
`endReason`obrigatório	string	`stop`, `switch`, `autostop` or `discard`.
`endedAt`obrigatório	string (date-time)
`segmentId`obrigatório	string (uuid)
`startedAt`obrigatório	string (date-time)

TimerProjectDto

The project of the running segment.

Campo	Tipo	Descrição
`clientName`	string \| null
`color`	string \| null
`id`obrigatório	string (uuid)
`name`obrigatório	string

TimerStartRequest

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

Campo	Tipo	Descrição
`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).

Campo	Tipo	Descrição
`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).

Campo	Tipo	Descrição
`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.

Campo	Tipo	Descrição
`days`obrigatório	UserDayDto[]
`from`obrigatório	string (date)
`teamId`	string (uuid) \| null	The user's current primary team (its rules classify every day).
`timeZone`obrigatório	string
`to`obrigatório	string (date)
`userId`obrigatório	string (uuid)

UserDayDto

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

UserTotalDto

One user of a summary.

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

WebhookDeliveryDetailDto

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

WebhookDeliveryDto

WebhookDeliveryDto.

Campo	Tipo	Descrição
`attempts`obrigatório	integer (int32)
`createdAt`obrigatório	string
`deliveredAt`	string \| null
`eventId`obrigatório	string (uuid)	The `webhook-id` header.
`eventType`obrigatório	string
`id`obrigatório	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`obrigatório	string	`pending`, `succeeded`, `failed`, `dead`.

WebhookDeliveryPage

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

Campo	Tipo	Descrição
`items`obrigatório	WebhookDeliveryDto[]
`nextCursor`	string \| null

WebhookEndpointDto

WebhookEndpointDto.

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

WebhookEndpointPage

GET /v1/webhook-endpoints.

Campo	Tipo	Descrição
`items`obrigatório	WebhookEndpointDto[]
`nextCursor`	string \| null

WebhookEndpointStatsDto

The delivery statistics of an endpoint.

Campo	Tipo	Descrição
`consecutiveFailures`obrigatório	integer (int32)
`lastFailureAt`	string \| null
`lastSuccessAt`	string \| null

WebhookEventDto

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

Campo	Tipo	Descrição
`available`obrigatório	boolean	The tenant's plan has the feature: an endpoint may subscribe.
`description`obrigatório	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`obrigatório	string	The `data.object` of the delivery body.
`type`obrigatório	string	`<object>.<verb>`, e.g. `time_entry.approved`.

WebhookEventsDto

GET /v1/webhook-events.

Campo	Tipo	Descrição
`items`obrigatório	WebhookEventDto[]

WebhookTestDto

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

Campo	Tipo	Descrição
`deliveryId`obrigatório	string	The delivery of the test event (a string: the deliveries' id is a 64-bit integer).

Referência da API pública

Autenticação

Escopos

Limites de requisições

Erros

Webhooks

Operações

Ausências

GET /v1/absences Escopo: reports:read

Parâmetros

POST /v1/absences Escopo: time:write

Parâmetros

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

Parâmetros

Atividade

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

Parâmetros

Alocações de tempo

GET /v1/allocations Escopo: reports:read

Parâmetros

POST /v1/allocations Escopo: time:write

Parâmetros

Exportações

POST /v1/exports Escopo: reports:read

Parâmetros

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

Parâmetros

Eu

GET /v1/me Escopo: me

Membros

POST /v1/invitations Escopo: org:admin

Parâmetros

GET /v1/members Escopo: org:admin

Parâmetros

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

Parâmetros

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

Parâmetros

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

Parâmetros

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

Parâmetros

Projetos

GET /v1/projects Escopo: reports:read

Parâmetros

POST /v1/projects Escopo: org:admin

Parâmetros

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

Parâmetros

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

Parâmetros

Relatórios

GET /v1/reports/productivity Escopo: reports:read

Parâmetros

GET /v1/reports/projects Escopo: reports:read

Parâmetros

GET /v1/reports/summary Escopo: reports:read

Parâmetros

GET /v1/reports/targets Escopo: reports:read

Parâmetros

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

Parâmetros

Turnos

GET /v1/shifts Escopo: reports:read

Parâmetros

POST /v1/shifts Escopo: time:write

Parâmetros

Tarefas

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

Parâmetros

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

Parâmetros

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

Parâmetros

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

Parâmetros

Equipes

GET /v1/teams Escopo: reports:read

Parâmetros

POST /v1/teams Escopo: org:admin

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

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

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

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

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

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

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

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

GET `/v1/me` Escopo: `me`

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

GET `/v1/me/timer` Escopo: `me`

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

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

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

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

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

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

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

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

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

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

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

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

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