AbsenceDto
An absence.
| 字段 | 类型 | 说明 |
|---|
createdAt必填 | string (date-time) | |
createdBy必填 | CalendarUserRefDto | |
days必填 | number (double) | Σ deductionByYear; for types that do not deduct, the planned workdays (information only). |
decidedAt | string (date-time) | null | |
decidedBy | CalendarUserRefDto | null | |
decisionNote | string | null | |
deductionByYear必填 | object | The balance deduction per year, e.g. {"2026": 3.5}; empty for types that do not deduct. |
end必填 | string (date-time) | |
endDate必填 | string (date) | |
endTime | string | null | |
half | string | null | |
id必填 | string (uuid) | |
note | string | null | |
permissions必填 | AbsencePermissionsDto | |
start必填 | string (date-time) | UTC coverage start. |
startDate必填 | string (date) | |
startTime | string | null | |
status必填 | string | |
timeZone必填 | string | |
type必填 | AbsenceTypeRefDto | |
unit必填 | string | |
updatedAt必填 | string (date-time) | |
user必填 | CalendarPersonDto | |
userId必填 | string (uuid) | |
AbsencePage
GET /v1/absences.
| 字段 | 类型 | 说明 |
|---|
items必填 | AbsenceDto[] | |
nextCursor | string | null | |
AbsencePermissionsDto
| 字段 | 类型 | 说明 |
|---|
canApprove必填 | boolean | |
canCancel必填 | boolean | |
canEdit必填 | boolean | |
AbsenceRequest
POST /v1/absences, PUT /v1/absences/{id} (the user never changes).
| 字段 | 类型 | 说明 |
|---|
endDate | string (date) | null | |
endTime | string | null | |
half | string | null | am or pm for a half day. |
note | string | null | |
startDate | string (date) | null | |
startTime | string | null | Local HH:mm for hours. |
typeId | string (uuid) | null | |
unit | string | null | days, half_day or hours. |
userId | string (uuid) | null | null = the caller. |
AbsenceTypeRefDto
The absence's type as the absence shows it; name translated for a built-in type that was not renamed.
| 字段 | 类型 | 说明 |
|---|
color必填 | string | |
countsAsWorked必填 | boolean | |
deductsFromBalance必填 | boolean | |
id必填 | string (uuid) | |
key | string | null | |
name必填 | string | |
paid必填 | boolean | |
timeEffect必填 | string | |
AcceptedDto
202 Accepted of a queued job.
| 字段 | 类型 | 说明 |
|---|
accepted必填 | boolean | Always true. |
AccessDto
What the person may see and manage (FAZ1 AccessDto; focus_contracts::access::policy).
| 字段 | 类型 | 说明 |
|---|
assignableRoles必填 | string[] | |
canManageCompanySettings必填 | boolean | |
canManageTeams必填 | boolean | |
canManageUsers必填 | boolean | |
manageTeamIds必填 | string[] | |
scope必填 | string | company, teams or self. |
unassignedFallback必填 | boolean | |
viewTeamIds必填 | string[] | |
ActivityDayDto
One user's local day. A day without activity is a 200 with zero totals, null arrival/leave and empty lists.
| 字段 | 类型 | 说明 |
|---|
absenceCreditMs必填 | integer (int64) | A worked absence tops the worked time up to the expected work. |
activeMs必填 | integer (int64) | Window time ∩ not AFK (computer time only). |
afkCoverage必填 | boolean | False when no device reported AFK data (idle unknown). |
apps必填 | AppUsageDto[] | Daily totals, largest first. |
arrivalAt | string (date-time) | null | |
atWorkMs必填 | integer (int64) | |
attendance | DayAttendanceDto | null | |
categories必填 | CategoryUsageDto[] | Active time per category (null key = uncategorized); offline time is in no category. |
classified必填 | boolean | False for a day written before the Phase 2 classification (all neutral). |
date必填 | string (date) | |
dayEnd必填 | string (date-time) | |
dayStart必填 | string (date-time) | The day's window: local midnight, or the end of the previous day's night shift window. |
deletedMs必填 | integer (int64) | Tracked time removed by approved deletions (part of idle). |
domains必填 | DomainUsageDto[] | |
hosts必填 | HostUsageDto[] | Hosts with a URL, at most 50, largest first. |
idleMs必填 | integer (int64) | |
leftAt | string (date-time) | null | |
meetingMs必填 | integer (int64) | Active time the meeting apps exception turned from idle into active. |
offlineMs必填 | integer (int64) | Approved offline time outside the tracked active time. |
pendingOfflineMs必填 | integer (int64) | Pending offline entries of the day (information only). |
plan | DayPlanDto | null | |
privateIntervals必填 | TimeIntervalDto[] | Private intervals of the day, merged and clipped, without detail. |
privateMs必填 | integer (int64) | Private time outside active and offline time. |
productivity必填 | DayProductivityDto | |
recomputing必填 | boolean | The day waits in the recompute queue (the UI refetches every 15 s). |
slots必填 | ActivitySlotDto[] | One entry per 5-minute UTC slot with activity, by time. |
teamId | string (uuid) | null | The user's current primary team (its rules classify the day). |
timeEntries必填 | TimeEntryDto[] | Offline and deletion entries of every status overlapping the day's window, by start; the caller's permissions. |
timeZone必填 | string | The zone the day was computed in; the UI draws slots at their wall-clock time in it. |
userId必填 | string (uuid) | |
workedMs必填 | integer (int64) | activeMs + offlineMs: the denominator of productivity.productivityPct. |
ActivitySlotDto
Time in one 5-minute slot; activeMs includes approved offline time (offlineMs).
| 字段 | 类型 | 说明 |
|---|
activeMs必填 | integer (int64) | |
apps必填 | AppUsageDto[] | |
neutralMs必填 | integer (int64) | |
offlineMs必填 | integer (int64) | |
productiveMs必填 | integer (int64) | |
slotStart必填 | string (date-time) | |
unproductiveMs必填 | integer (int64) | |
AffectedAllocationDto
An allocation replace changed.
| 字段 | 类型 | 说明 |
|---|
change必填 | string | trimmed, split or deleted. |
id必填 | string (uuid) | |
AllocationCreateRequest
POST /v1/allocations (Idempotency-Key).
| 字段 | 类型 | 说明 |
|---|
endedAt | string (date-time) | null | At most 24 hours after startedAt, at most 5 minutes in the future. |
isBillable | boolean | null | |
note | string | null | |
projectId | string (uuid) | null | |
replace | boolean | null | Trim, split or delete the person's (unbilled) allocations it overlaps; otherwise an overlap is 409
allocation_overlaps. |
source | string | null | manual or assignment (timer only through the timer). |
startedAt | string (date-time) | null | |
taskId | string (uuid) | null | |
userId | string (uuid) | null | null = the caller; another person needs allocations.write and to be managed by the caller. |
AllocationCreatedDto
POST /v1/allocations → 201.
AllocationDto
Time on a project.
| 字段 | 类型 | 说明 |
|---|
createdAt必填 | string (date-time) | |
createdBy必填 | NamedRefDto | |
durationMs必填 | integer (int64) | |
effectiveBillable必填 | boolean | |
endedAt必填 | string (date-time) | |
id必填 | string (uuid) | |
invoiceId | string (uuid) | null | Set once the time is on an invoice. |
isBillable | boolean | null | null takes the task's, then the project's value. |
localDate必填 | string (date) | The start's day in the person's zone (rates, reports). |
note | string | null | |
permissions必填 | AllocationPermissionsDto | |
project必填 | ProjectRefDto | |
source必填 | string | timer, manual or assignment. |
startedAt必填 | string (date-time) | |
task | NamedRefDto | null | |
timeZone必填 | string | |
updatedAt必填 | string (date-time) | |
userId必填 | string (uuid) | |
version必填 | integer (int64) | The row version: If-Match: "v<version>" of a change (the same value as the resource's ETag). |
AllocationPage
GET /v1/allocations.
AllocationPermissionsDto
What the caller may do with an allocation (a billed one is locked).
| 字段 | 类型 | 说明 |
|---|
delete必填 | boolean | |
edit必填 | boolean | |
AppTotalDto
| 字段 | 类型 | 说明 |
|---|
activeMs必填 | integer (int64) | |
appKey必填 | string | |
categoryKey | string | null | |
level | string | null | Level in the response's levelContext. |
name必填 | string | |
percentage必填 | number (double) | Share of the range's worked time (0–100, one decimal). |
AppUsageDto
An app's time; offline rows use the reserved keys _offline_<level> with name: "Offline time" and
levelSource: "offline".
| 字段 | 类型 | 说明 |
|---|
activeMs必填 | integer (int64) | |
appKey必填 | string | |
categoryKey | string | null | |
level | string | null | The app's own rule (productive, unproductive, neutral). |
levelSource | string | null | team, company, default or offline. |
name必填 | string | |
BudgetDto
A project's budget: hours (minutes) or an amount in the project's currency (amountMinor).
| 字段 | 类型 | 说明 |
|---|
amountMinor | integer (int64) | null | |
kind | string | null | hours or amount. |
minutes | integer (int64) | null | |
BudgetRequest
The budget of a project request (kind hours with minutes, or amount with amountMinor).
| 字段 | 类型 | 说明 |
|---|
amountMinor | integer (int64) | null | |
kind | string | null | |
minutes | integer (int64) | null | |
CalendarDecisionRequest
{decision, note?} of the decision endpoints (approve or reject; the note at most 500 characters).
| 字段 | 类型 | 说明 |
|---|
decision | string | null | |
note | string | null | |
CalendarPersonDto
A user with the current team.
| 字段 | 类型 | 说明 |
|---|
fullName | string | null | |
id必填 | string (uuid) | |
teamId | string (uuid) | null | |
teamName | string | null | |
CalendarUserRefDto
A user reference (names from the directory; null when unknown).
| 字段 | 类型 | 说明 |
|---|
fullName | string | null | |
id必填 | string (uuid) | |
CapabilitiesDto
Subscription capabilities.
| 字段 | 类型 | 说明 |
|---|
features必填 | string[] | |
readOnly必填 | boolean | |
CategoryUsageDto
| 字段 | 类型 | 说明 |
|---|
activeMs必填 | integer (int64) | |
categoryKey | string | null | null = uncategorized. |
CreateExportRequest
POST /v1/exports: definition is the full definition the dialog shows; without it the saved template
(templateId) or the built-in one (templateKey) gives it.
| 字段 | 类型 | 说明 |
|---|
definition | ExportDefinitionDto | null | |
from | string (date) | null | |
locale | string | null | tr or en. |
templateId | string (uuid) | null | |
templateKey | string | null | |
to | string (date) | null | |
CreateInvitation
POST /v1/invitations.
| 字段 | 类型 | 说明 |
|---|
email必填 | string | |
fullName必填 | string | |
locale | string | null | Language of the e-mail and the acceptance page (tr, en); the organization's default otherwise. |
role必填 | string | admin, team_admin, manager or employee. |
teamId | string (uuid) | null | |
timeZone | string | null | |
viewerTeamIds | string (uuid)[] | |
CreateTeam
POST /v1/teams.
| 字段 | 类型 | 说明 |
|---|
description | string | null | At most 500 characters. |
name必填 | string | 1–100 characters, unique among active teams (Turkish case folding). |
CreateTimeEntryRequest
POST /v1/time-entries (the .NET CreateTimeEntryRequest).
| 字段 | 类型 | 说明 |
|---|
description | string | null | Offline: 1–500 characters; deletion: optional reason (at most 500). |
end | string (date-time) | null | |
kind | string | null | offline or deletion. |
level | string | null | Offline only (default productive). |
projectId | string (uuid) | null | Must be null (400 project_not_supported). |
start | string (date-time) | null | |
userId | string (uuid) | null | null = the caller; a manager may add time for a user it manages. |
CreateWebhookEndpointRequest
POST /v1/webhook-endpoints.
| 字段 | 类型 | 说明 |
|---|
description | string | null | ≤ 200 characters. |
eventTypes必填 | string[] | 1–50 catalog event types of the tenant's plan. |
url必填 | string | https://… (≤ 2048; no user info, no fragment; every resolved address public). |
CreatedWebhookEndpointDto
CreatedWebhookEndpointDto: the endpoint and its signing secret, shown once.
| 字段 | 类型 | 说明 |
|---|
endpoint必填 | WebhookEndpointDto | |
secret必填 | string | whsec_<base64>: shown once, never again. |
DailyHolidayDto
A holiday of a daily report day.
| 字段 | 类型 | 说明 |
|---|
half | string | null | |
key必填 | string | |
name必填 | string | English name; nameTr is the Turkish one. |
nameTr必填 | string | |
DayAbsenceDto
The dominant absence of a day (/v1/reports/users/{userId}/daily days[].absence).
| 字段 | 类型 | 说明 |
|---|
color必填 | string | |
fraction必填 | number (double) | The day's approved absence coverage (0–1). |
half | string | null | |
typeKey | string | null | |
typeName | string | null | |
unit必填 | string | |
DayAttendanceDto
Attendance of the day on the day plan.
| 字段 | 类型 | 说明 |
|---|
expectedEnd | string (date-time) | null | |
expectedStart | string (date-time) | null | |
flexible必填 | boolean | |
lateByMs必填 | integer (int64) | |
lateToleranceMinutes必填 | integer (int32) | |
leftEarly必填 | boolean | |
leftEarlyByMs必填 | integer (int64) | |
status必填 | string | onTime, late, absent, notStarted, dayOff, onLeave, holiday. |
targetMs必填 | integer (int64) | The plan's target (the Effectiveness % denominator). |
workday必填 | boolean | |
DayPlanDto
The day plan of one user's day.
| 字段 | 类型 | 说明 |
|---|
absences必填 | PlanAbsenceDto[] | Approved and pending absences covering the day (only approved ones change the numbers). |
expectedEnd | string (date-time) | null | |
expectedStart | string (date-time) | null | |
expectedWorkMs必填 | integer (int64) | Overtime target (base × (1 − fLeave)). |
holiday | HolidayRefDto | null | |
kind必填 | string | schedule, shift, dayOff or holiday. |
leaveFraction必填 | number (double) | The approved absence coverage f (0–1). |
shifts必填 | PlanShiftDto[] | Shifts starting on the day, by start. |
targetMs必填 | integer (int64) | Effectiveness % denominator (base × (1 − f)). |
workday必填 | boolean | |
DayProductivityDto
A day's time by productivity level (productive + unproductive + neutral = workedMs).
| 字段 | 类型 | 说明 |
|---|
effectivenessPct | number (double) | null | productive ÷ target × 100 (not capped); null without a target. |
neutralMs必填 | integer (int64) | |
productiveMs必填 | integer (int64) | |
productivityPct | number (double) | null | productive ÷ worked × 100, one decimal; null without worked time. |
targetMs必填 | integer (int64) | |
unproductiveMs必填 | integer (int64) | |
DayTotalDto
One local day of a summary.
| 字段 | 类型 | 说明 |
|---|
activeMs必填 | integer (int64) | |
activeUserCount必填 | integer (int32) | |
atWorkMs必填 | integer (int64) | |
date必填 | string (date) | |
idleMs必填 | integer (int64) | |
neutralMs必填 | integer (int64) | |
offlineMs必填 | integer (int64) | |
privateMs必填 | integer (int64) | |
productiveMs必填 | integer (int64) | |
productivityPct | number (double) | null | |
unproductiveMs必填 | integer (int64) | |
DomainTotalDto
| 字段 | 类型 | 说明 |
|---|
activeMs必填 | integer (int64) | |
categoryKey | string | null | |
domain必填 | string | |
level | string | null | |
percentage必填 | number (double) | |
DomainUsageDto
| 字段 | 类型 | 说明 |
|---|
activeMs必填 | integer (int64) | |
categoryKey | string | null | |
domain必填 | string | |
level | string | null | |
levelSource | string | null | |
EmailVerificationDto
Where the person stands with the e-mail verification (owner decision 3 Oct 2026, focus_auth::email_gate).
| 字段 | 类型 | 说明 |
|---|
dueAt | string (date-time) | null | The deadline of an unverified account (Identity__EmailVerificationGraceHours after its creation). |
state必填 | string | verified, not_required (an account that never has to verify: invited, imported, SCIM, IdP-verified),
pending (unverified, before dueAt) or overdue (after dueAt: every request but a few answers 403
email_verification_required). |
ExportDefinitionDto
What an export contains (FAZ4 §6.1; focus_contracts::reports::export::ExportDefinition on the wire); a saved
template stores it without the date range. Every field is optional so that the validator reports what is wrong
(422 validation_failed with errors[{field, code}]).
| 字段 | 类型 | 说明 |
|---|
columns | string[] | null | Column keys of the dataset in file order (1–40; a PDF at most 12). |
csvDialect | string | null | standard (default) or excel-tr (csv only). |
dataset | string | null | |
durationFormat | string | null | hms (default), hours or minutes. |
filters | ExportFiltersDto | null | |
format | string | null | xlsx, csv or pdf. |
groupBy | string | null | day, week, month, range or none (the dataset decides). |
options | ExportOptionsDto | null | |
ExportFiltersDto
Who is exported: a team, some users, or (neither) everyone the requester can see.
| 字段 | 类型 | 说明 |
|---|
includeInactiveUsers | boolean | |
teamId | string | null | |
userIds | string | null[] | null | |
ExportJobDto
An export job as the panel lists and polls it.
| 字段 | 类型 | 说明 |
|---|
createdAt必填 | string (date-time) | |
dataset必填 | string | |
errorCode | string | null | too_many_rows, too_many_rows_for_pdf, access_lost, feature_not_in_plan, canceled, internal_error. |
expiresAt | string (date-time) | null | |
fileName | string | null | |
fileSize | integer (int64) | null | |
finishedAt | string (date-time) | null | |
format必填 | string | |
from必填 | string (date) | |
groupBy | string | null | |
id必填 | string (uuid) | |
locale必填 | string | |
progress必填 | integer (int32) | 0–100. |
rowCount | integer (int32) | null | |
startedAt | string (date-time) | null | |
status必填 | string | queued, running, succeeded, failed, canceled, expired. |
templateId | string (uuid) | null | |
templateKey | string | null | |
templateName | string | null | The saved template's name, while it still exists. |
to必填 | string (date) | |
ExportOptionsDto
Dataset options; each applies to one dataset and is ignored by the others.
| 字段 | 类型 | 说明 |
|---|
include | string | null | titles: titles, urls or both (default). |
includeCosts | boolean | null | projects (Faz 6): fill the rate, amount and currency columns (needs projects.costs.read, else 403). |
includeOpen | boolean | null | shifts: also open shifts. |
splitByUser | boolean | null | applications: one row per user and target. |
statuses | string | null[] | null | offline_time / absence: status filter (default approved). |
targetType | string | null | applications: app (default), domain or host. |
FieldError
One field error of a 400/422 body.
| 字段 | 类型 | 说明 |
|---|
code必填 | string | Stable snake_case code (required, too_long, invalid, ...). |
field必填 | string | JSON path of the field in camelCase (name, items[2].start), or the parameter/header name. |
message | string | null | |
HolidayRefDto
A holiday of a day (both names; name is the English one).
| 字段 | 类型 | 说明 |
|---|
half | string | null | |
key必填 | string | Built-in key (republic_day, …) or custom. |
name必填 | string | |
nameEn必填 | string | |
nameTr必填 | string | |
source | string | null | builtin or tenant. |
HostUsageDto
| 字段 | 类型 | 说明 |
|---|
activeMs必填 | integer (int64) | |
domain | string | null | |
host必填 | string | |
level必填 | string | |
levelSource必填 | string | |
matchedKey | string | null | Key of the matching domain rule; null for the default. |
InvitationEmail
What happened to the invitation e-mail.
| 字段 | 类型 | 说明 |
|---|
acceptUrl | string | null | The acceptance link, only when no e-mail is sent (not_configured, suppressed_reserved) and only in the
fresh answer (share it by hand). |
status必填 | string | queued; not_configured when no e-mail provider is set up; suppressed_reserved when the address is an
RFC 2606 / RFC 6761 reserved name (example.com, *.test, …) that is never e-mailed. Clients treat
suppressed_reserved like not_configured: nothing arrives, share acceptUrl by hand. |
InvitationRef
{"id","expiresAt"} of a created or re-sent invitation.
| 字段 | 类型 | 说明 |
|---|
expiresAt必填 | string | |
id必填 | string (uuid) | |
InvitationResult
The answer of POST /v1/invitations and POST /v1/invitations/{id}/resend.
LevelContextDto
Which rules the single level of an aggregate list follows (FAZ2 §5 "Listelerde hangi kural").
| 字段 | 类型 | 说明 |
|---|
kind必填 | string | user (a userId filter: that user's current team), team (a teamId filter) or company. |
teamId | string (uuid) | null | |
MeMembership
The membership in the current organization.
| 字段 | 类型 | 说明 |
|---|
id必填 | string (uuid) | |
isTracked必填 | boolean | |
joinedAt | string | null | |
role必填 | string | |
status必填 | string | |
teamId | string (uuid) | null | |
teamName | string | null | |
timeZone | string | null | |
viewerTeamIds必填 | string (uuid)[] | |
MeOrganization
The current organization.
| 字段 | 类型 | 说明 |
|---|
defaultLocale必填 | string | |
id必填 | string (uuid) | |
name必填 | string | |
slug必填 | string | |
status必填 | string | |
timeZone必填 | string | |
MeSession
The current session.
| 字段 | 类型 | 说明 |
|---|
absoluteExpiresAt必填 | string | |
amr必填 | string[] | |
authTime必填 | string | |
clientId必填 | string | |
id必填 | string (uuid) | |
idleExpiresAt必填 | string | |
MeUser
The person (GET /v1/me → user).
| 字段 | 类型 | 说明 |
|---|
email必填 | string | |
emailVerification必填 | EmailVerificationDto | The e-mail verification gate (owner decision 3 Oct 2026). |
emailVerified必填 | boolean | |
fullName | string | null | |
id必填 | string (uuid) | |
locale必填 | string | |
MemberDto
A membership with its person (MemberDto).
| 字段 | 类型 | 说明 |
|---|
createdAt必填 | string | |
email必填 | string | |
emailVerified必填 | boolean | |
fullName | string | null | |
id必填 | string (uuid) | |
invitation | MemberInvitationDto | null | |
isTracked必填 | boolean | |
joinedAt | string | null | |
locale必填 | string | |
role必填 | string | owner, admin, team_admin, manager, employee. |
status必填 | string | invited, active, suspended, left. |
teamId | string (uuid) | null | |
teamName | string | null | |
timeZone | string | null | |
unassignedManager必填 | boolean | A Manager with neither a team nor viewer teams (sees the whole company until assigned). |
userId必填 | string (uuid) | |
viewerTeamIds必填 | string (uuid)[] | |
MemberInvitationDto
The invitation of an invited member.
| 字段 | 类型 | 说明 |
|---|
emailStatus | string | null | queued, sending, sent, failed, suppressed, not_configured, suppressed_reserved (an RFC 2606 /
RFC 6761 reserved domain, never e-mailed), or null before the first e-mail. |
expiresAt必填 | string | |
id必填 | string (uuid) | |
lastSentAt必填 | string | |
sentCount必填 | integer (int32) | |
MemberPage
A page of members (OpenAPI).
| 字段 | 类型 | 说明 |
|---|
items必填 | MemberDto[] | |
nextCursor | string | null | |
MemberRefDto
A member as a reference (current row): the connecting Admin of a connection, the owner of a webhook endpoint.
| 字段 | 类型 | 说明 |
|---|
active必填 | boolean | The membership is active and (for an endpoint or a tenant connection) still an Owner or Admin. |
name | string | null | |
userId必填 | string (uuid) | |
NamedRefDto
A reference by id and display name (a client, a person, a task).
| 字段 | 类型 | 说明 |
|---|
id必填 | string (uuid) | |
name必填 | string | |
OrganizationChoice
One organization of the person (sec.user_memberships).
| 字段 | 类型 | 说明 |
|---|
current必填 | boolean | |
id必填 | string (uuid) | |
name必填 | string | |
role必填 | string | |
selectable必填 | boolean | Can this session's sign-in method open it (design §4.5.3)? |
PatchMember
PATCH /v1/members/{id}.
| 字段 | 类型 | 说明 |
|---|
isTracked | boolean | null | |
role | string | null | admin, team_admin, manager or employee (the Owner is only transferred). |
teamId | string (uuid) | null | Primary team; null removes it. |
timeZone | string | null | IANA zone of the membership; null follows the organization. |
viewerTeamIds | string (uuid)[] | null | Extra read-only teams (Manager and TeamAdmin only). |
PatchTeam
PATCH /v1/teams/{id}.
| 字段 | 类型 | 说明 |
|---|
description | string | null | |
name | string | null | |
PeriodReportDto
GET /v1/reports/productivity.
PlanAbsenceDto
| 字段 | 类型 | 说明 |
|---|
color必填 | string | |
countsAsWorked必填 | boolean | timeEffect == worked. |
endTime | string | null | |
half | string | null | |
id必填 | string (uuid) | |
startTime | string | null | Local start and end of an hours absence. |
status必填 | string | approved or pending. |
timeEffect必填 | string | leave, worked or none. |
typeKey | string | null | |
typeName | string | null | null for a built-in type that was not renamed (the UI translates typeKey). |
unit必填 | string | days, half_day or hours. |
PlanShiftDto
| 字段 | 类型 | 说明 |
|---|
color | string | null | |
end必填 | string (date-time) | |
endTime必填 | string | Local end; before the start for a night shift. |
id必填 | string (uuid) | |
location必填 | string | |
minMinutes必填 | integer (int32) | |
start必填 | string (date-time) | |
startTime必填 | string | Local start (HH:mm, the shift's zone). |
Problem
RFC 9457 problem details (application/problem+json).
| 字段 | 类型 | 说明 |
|---|
action | string | null | Permission key of a 403 (teams.create). |
code必填 | string | Stable snake_case error code (catalog error-codes.json). |
detail | string | null | |
errors | FieldError[] | null | |
requiredPlan | string | null | Lowest plan that includes the feature (402 feature_not_in_plan). |
retryAfterSeconds | integer (int32) | null | Seconds to wait (429, 503; also the Retry-After header). |
status必填 | integer (int32) | |
title必填 | string | English title of the code (clients translate code). |
traceId | string | null | W3C trace id of the request. |
type必填 | string | Help page of the error code: https://workify360.com/help/errors/<code>/. |
ProjectAmountDto
The amounts of one currency (rates are applied per allocation day and layer).
| 字段 | 类型 | 说明 |
|---|
billableMinor必填 | integer (int64) | The billable hours at their rate. |
costMinor必填 | integer (int64) | Every allocated hour at its rate. |
currency必填 | string | |
ProjectBudgetUsageDto
The use of a project's budget, all time.
| 字段 | 类型 | 说明 |
|---|
budgetMinor | integer (int64) | null | null unless costsIncluded. |
budgetMinutes | integer (int64) | null | |
kind必填 | string | hours or amount. |
projectId必填 | string (uuid) | |
usedMinor | integer (int64) | null | The cost in the project's currency; null unless costsIncluded. |
usedMs必填 | integer (int64) | |
usedRatio | string | null | Used / budget, 4 decimals (null for an amount budget without costsIncluded). |
ProjectDto
A project.
| 字段 | 类型 | 说明 |
|---|
access必填 | string | everyone or members. |
archived必填 | boolean | |
budget | BudgetDto | null | |
client | NamedRefDto | null | |
code | string | null | |
color | string | null | |
createdAt必填 | string (date-time) | |
currency必填 | string | The currency of the project's rates and amount budget. |
description | string | null | |
endDate | string (date) | null | |
id必填 | string (uuid) | |
isBillable必填 | boolean | |
memberCount必填 | integer (int64) | |
myRole | string | null | The caller's role in the project team (member, manager), null outside it. |
name必填 | string | |
permissions必填 | ProjectPermissionsDto | |
spentMs必填 | integer (int64) | Every allocation of the project, all time. |
startDate | string (date) | null | |
status必填 | string | active, on_hold or completed. |
taskCount必填 | integer (int64) | |
updatedAt必填 | string (date-time) | |
ProjectPage
GET /v1/projects.
| 字段 | 类型 | 说明 |
|---|
items必填 | ProjectDto[] | |
nextCursor | string | null | |
ProjectPermissionsDto
What the caller may do with a project (decided from the current rows, §5.3).
| 字段 | 类型 | 说明 |
|---|
archive必填 | boolean | |
delete必填 | boolean | Only a project without time. |
edit必填 | boolean | The project's fields (Owners and Admins). |
manageMembers必填 | boolean | The team (an Admin or the project's manager; only an Admin changes managers). |
manageTasks必填 | boolean | Tasks (an Admin or the project's manager). |
track必填 | boolean | The caller may track time on it now. |
ProjectRefDto
A project reference of an allocation.
| 字段 | 类型 | 说明 |
|---|
color | string | null | #RRGGBB. |
id必填 | string (uuid) | |
name必填 | string | |
ProjectReportDto
GET /v1/reports/projects.
ProjectReportKeysDto
The dimensions of a row (the ones not grouped by are null).
| 字段 | 类型 | 说明 |
|---|
clientId | string (uuid) | null | |
clientName | string | null | |
date | string (date) | null | The allocation's local day (groupBy day). |
projectId | string (uuid) | null | |
projectName | string | null | |
taskId | string (uuid) | null | |
taskName | string | null | |
userId | string (uuid) | null | |
userName | string | null | |
ProjectReportRowDto
One row of the project report.
| 字段 | 类型 | 说明 |
|---|
allocatedMs必填 | integer (int64) | |
amounts | ProjectAmountDto[] | null | null unless costsIncluded. |
billableMs必填 | integer (int64) | |
keys必填 | ProjectReportKeysDto | |
nonBillableMs必填 | integer (int64) | |
productiveMs | integer (int64) | null | With includeProductive only. |
unratedMs必填 | integer (int64) | Time without any rate (it is left out of the amounts). |
ProjectReportTotalsDto
The totals of the report.
| 字段 | 类型 | 说明 |
|---|
allocatedMs必填 | integer (int64) | |
amounts | ProjectAmountDto[] | null | |
billableMs必填 | integer (int64) | |
nonBillableMs必填 | integer (int64) | |
productiveMs | integer (int64) | null | |
unratedMs必填 | integer (int64) | |
ProjectRequest
POST /v1/projects; PUT /v1/projects/{id} sends the whole body.
| 字段 | 类型 | 说明 |
|---|
access | string | null | everyone (default) or members. |
budget | BudgetRequest | null | |
clientId | string (uuid) | null | |
code | string | null | [A-Za-z0-9._-]{1,32}, unique among active projects. |
color | string | null | #RRGGBB. |
currency | string | null | TRY, USD or EUR; locked once the project has rates or invoice lines (409 project_currency_locked). |
description | string | null | |
endDate | string (date) | null | |
isBillable | boolean | null | Default true. |
name | string | null | |
startDate | string (date) | null | |
status | string | null | active (default), on_hold or completed. |
ReportPeriodDto
One period of a grouped report: its key and bounds, then the figures.
ReportScopeDto
What the caller can see (FAZ1 AccessPolicy.ScopeOf).
| 字段 | 类型 | 说明 |
|---|
kind必填 | string | company, teams or self. |
teamIds必填 | string (uuid)[] | The visible teams of a teams scope, sorted; empty otherwise (company = all). |
unassignedFallback必填 | boolean | A Manager without teams who sees the whole company until assigned. |
ReportSubjectDto
Whom a report is about.
| 字段 | 类型 | 说明 |
|---|
id | string (uuid) | null | |
kind必填 | string | company, team or user. |
name | string | null | |
RotatedWebhookSecretDto
RotatedWebhookSecretDto: the new signing secret, shown once.
| 字段 | 类型 | 说明 |
|---|
previousSecretExpiresAt必填 | string | Until then deliveries carry both signatures. |
secret必填 | string | whsec_<base64>: shown once, never again. |
ShiftBody
ShiftBody of POST /v1/shifts, the bulk items and PUT /v1/shifts/{id} (the whole body). Fields left null are
filled from templateId.
| 字段 | 类型 | 说明 |
|---|
breakMinutes | integer (int32) | null | |
color | string | null | |
date | string (date) | null | |
endTime | string | null | |
location | string | null | |
minMinutes | integer (int32) | null | null = the template's, else duration − break. |
note | string | null | |
startTime | string | null | |
teamId | string (uuid) | null | Required for an open shift; ignored for an assigned one (the user's current team is written). |
templateId | string (uuid) | null | |
userId | string (uuid) | null | null = an open shift. |
ShiftDto
A shift: local fields, UTC instants, the caller's permissions.
| 字段 | 类型 | 说明 |
|---|
breakMinutes必填 | integer (int32) | |
color | string | null | |
createdAt必填 | string (date-time) | |
createdBy必填 | CalendarUserRefDto | |
crossesMidnight必填 | boolean | |
date必填 | string (date) | |
durationMinutes必填 | integer (int32) | |
end必填 | string (date-time) | |
endTime必填 | string | |
id必填 | string (uuid) | |
location必填 | string | |
minMinutes必填 | integer (int32) | |
note | string | null | |
open必填 | boolean | No user assigned. |
permissions必填 | ShiftPermissionsDto | |
source必填 | string | manual, template, copy or request. |
start必填 | string (date-time) | |
startTime必填 | string | |
teamId | string (uuid) | null | Open shift: its team; assigned: the user's team when it was written. |
teamName | string | null | |
templateId | string (uuid) | null | |
templateName | string | null | |
timeZone必填 | string | |
updatedAt必填 | string (date-time) | |
user | CalendarUserRefDto | null | |
userId | string (uuid) | null | null for an open shift. |
ShiftListDto
GET /v1/shifts (the shifts **starting** in the range).
ShiftPermissionsDto
| 字段 | 类型 | 说明 |
|---|
canDelete必填 | boolean | |
canEdit必填 | boolean | |
canPickUp必填 | boolean | |
canRequestSwap必填 | boolean | |
SummaryDto
The summary of the visible users over a range.
| 字段 | 类型 | 说明 |
|---|
absenceCreditMs必填 | integer (int64) | |
absentDays必填 | integer (int32) | |
activeMs必填 | integer (int64) | |
activeUserCount必填 | integer (int32) | |
atWorkMs必填 | integer (int64) | |
days必填 | DayTotalDto[] | |
deletedMs必填 | integer (int64) | |
domains必填 | DomainTotalDto[] | Top 10. |
effectivenessPct | number (double) | null | Average of the users' range Effectiveness % (inactive tracked users included). |
from必填 | string (date) | |
holidayDays必填 | number (double) | |
idleMs必填 | integer (int64) | |
inactiveUsers必填 | UserTotalDto[] | Tracked users without activity in the range (zero totals, attendance fields), by user id. |
lateDays必填 | integer (int32) | |
leaveDays必填 | number (double) | |
leftEarlyDays必填 | integer (int32) | |
levelContext必填 | LevelContextDto | |
meetingMs必填 | integer (int64) | |
neutralMs必填 | integer (int64) | |
offlineMs必填 | integer (int64) | |
overtimeMs必填 | integer (int64) | |
privateMs必填 | integer (int64) | |
productiveMs必填 | integer (int64) | |
productivityPct | number (double) | null | Average of the users' range Productivity %. |
scope必填 | ReportScopeDto | |
shiftDays必填 | integer (int32) | |
teams必填 | TeamTotalDto[] | By current team: named teams by name, the teamId: null row last. |
to必填 | string (date) | |
topApps必填 | AppTotalDto[] | Top 10; name is "Offline time" for the reserved offline keys. |
unproductiveMs必填 | integer (int64) | |
users必填 | UserTotalDto[] | One row per user with a computed day in the range, by activeMs. |
workedMs必填 | integer (int64) | |
TargetItemDto
| 字段 | 类型 | 说明 |
|---|
activeMs必填 | integer (int64) | |
categoryKey | string | null | |
categorySource必填 | string | tenant, builtin or none. |
domain | string | null | |
level必填 | string | |
levelSource必填 | string | team, company or default. |
matchedKey | string | null | |
name必填 | string | |
percentage必填 | number (double) | |
targetKey必填 | string | |
targetType必填 | string | app for apps, domain for domains and hosts. |
userCount必填 | integer (int32) | |
TargetListDto
The "Apps & URLs" list.
| 字段 | 类型 | 说明 |
|---|
from必填 | string (date) | |
items必填 | TargetItemDto[] | By active time descending, then key. |
levelContext必填 | LevelContextDto | |
nextCursor | string | null | |
to必填 | string (date) | |
total必填 | integer (int32) | Targets matching the filters (before paging). |
totalActiveMs必填 | integer (int64) | Active time over every target of the type before the filters (the percentage base). |
type必填 | string | app, domain or host. |
TaskDto
A task.
| 字段 | 类型 | 说明 |
|---|
archived必填 | boolean | |
assignee | NamedRefDto | null | |
createdAt必填 | string (date-time) | |
description | string | null | |
dueDate | string (date) | null | |
effectiveBillable必填 | boolean | |
estimateMinutes | integer (int64) | null | |
id必填 | string (uuid) | |
isBillable | boolean | null | null takes the project's value. |
name必填 | string | |
permissions必填 | TaskPermissionsDto | |
projectId必填 | string (uuid) | |
sortOrder必填 | integer (int64) | |
spentMs必填 | integer (int64) | |
status必填 | string | open, in_progress or done. |
updatedAt必填 | string (date-time) | |
TaskPage
GET /v1/projects/{id}/tasks.
| 字段 | 类型 | 说明 |
|---|
items必填 | TaskDto[] | |
nextCursor | string | null | |
TaskPermissionsDto
What the caller may do with a task.
| 字段 | 类型 | 说明 |
|---|
delete必填 | boolean | Only a task without time. |
edit必填 | boolean | |
TaskRequest
POST /v1/projects/{id}/tasks; PUT /v1/tasks/{id} sends the whole body.
| 字段 | 类型 | 说明 |
|---|
assigneeUserId | string (uuid) | null | Must be able to track time on the project (422 project_not_trackable). |
description | string | null | |
dueDate | string (date) | null | |
estimateMinutes | integer (int64) | null | 1–1 000 000. |
isBillable | boolean | null | null takes the project's value. |
name | string | null | |
sortOrder | integer (int64) | null | |
status | string | null | open (default), in_progress or done. |
TeamDto
A team with its size and leads (TeamDto).
| 字段 | 类型 | 说明 |
|---|
archivedAt | string | null | |
createdAt必填 | string | |
description | string | null | |
id必填 | string (uuid) | |
leads必填 | object[] | TeamAdmins and Managers of the team: [{membershipId, userId, fullName, role}]. |
memberCount必填 | integer (int64) | Members whose primary team this is (left members excluded). |
name必填 | string | |
updatedAt必填 | string | |
TeamPage
A page of teams (OpenAPI).
| 字段 | 类型 | 说明 |
|---|
items必填 | TeamDto[] | |
nextCursor | string | null | |
TeamTotalDto
One team row of a summary (current teams; percentages the members' average).
| 字段 | 类型 | 说明 |
|---|
absenceCreditMs必填 | integer (int64) | |
absentDays必填 | integer (int32) | |
activeMs必填 | integer (int64) | |
activeUserCount必填 | integer (int32) | |
effectivenessPct | number (double) | null | |
holidayDays必填 | number (double) | |
idleMs必填 | integer (int64) | |
lateDays必填 | integer (int32) | |
leaveDays必填 | number (double) | |
leftEarlyDays必填 | integer (int32) | |
memberCount必填 | integer (int32) | |
neutralMs必填 | integer (int64) | |
offlineMs必填 | integer (int64) | |
overtimeMs必填 | integer (int64) | |
productiveMs必填 | integer (int64) | |
productivityPct | number (double) | null | |
shiftDays必填 | integer (int32) | |
teamId | string (uuid) | null | null for the users without a team. |
teamName | string | null | |
unproductiveMs必填 | integer (int64) | |
workedMs必填 | integer (int64) | |
TimeEntryDecisionRequest
POST /v1/time-entries/{id}/decision.
| 字段 | 类型 | 说明 |
|---|
decision | string | null | approve or reject. |
note | string | null | At most 500 characters. |
TimeEntryDto
An offline entry or a deletion (design §8.2).
| 字段 | 类型 | 说明 |
|---|
createdAt必填 | string (date-time) | |
createdBy必填 | TimeEntryUserRefDto | |
date必填 | string (date) | The user's local day of the entry, in the zone effective when it was written. |
decidedAt | string (date-time) | null | |
decidedBy | TimeEntryUserRefDto | null | |
decisionNote | string | null | |
description | string | null | |
durationMs必填 | integer (int64) | |
end必填 | string (date-time) | |
id必填 | string (uuid) | |
kind必填 | string | offline or deletion. |
level | string | null | Offline: productive, neutral or unproductive; deletion: null. |
permissions必填 | TimeEntryPermissionsDto | |
projectId | string (uuid) | null | Always null until projects (Phase 6). |
source必填 | string | manual (Phase 8 adds calendar). |
start必填 | string (date-time) | |
status必填 | string | pending, approved or rejected. |
timeZone必填 | string | |
updatedAt必填 | string (date-time) | |
userId必填 | string (uuid) | |
TimeEntryPage
GET /v1/time-entries: by start.
TimeEntryPermissionsDto
What the caller may do with the entry (TimeEntryPolicy.PermissionsFor), the same on every endpoint.
| 字段 | 类型 | 说明 |
|---|
canApprove必填 | boolean | |
canDelete必填 | boolean | |
canEdit必填 | boolean | |
TimeEntryUserRefDto
A user reference of an entry (fullName from the directory; null when unknown).
| 字段 | 类型 | 说明 |
|---|
fullName | string | null | |
id必填 | string (uuid) | |
TimeIntervalDto
A UTC interval without any detail (e.g. a private interval).
| 字段 | 类型 | 说明 |
|---|
end必填 | string (date-time) | |
start必填 | string (date-time) | |
TimerAtRequest
POST /v1/me/timer/stop and /discard.
| 字段 | 类型 | 说明 |
|---|
at | string (date-time) | null | |
TimerCommandResultDto
The result of a command (200 also when it did not apply).
| 字段 | 类型 | 说明 |
|---|
applied必填 | boolean | |
closed必填 | AllocationDto[] | The allocations written from the segment this command closed (may be empty). |
reason | string | null | stale, not_running or unchanged; null when applied. |
timer必填 | TimerDto | |
TimerDto
GET /v1/me/timer (ETag: "v<rowVersion>", "v0" before the first command).
| 字段 | 类型 | 说明 |
|---|
autoStopAt | string (date-time) | null | startedAt + 24 hours. |
effectiveBillable | boolean | null | |
isBillable | boolean | null | |
last | TimerLastDto | null | |
note | string | null | |
project | TimerProjectDto | null | |
segmentId | string (uuid) | null | |
serverTime必填 | string (date-time) | The server's clock (clients compute the elapsed time against it). |
source | string | null | web, desktop or api. |
startedAt | string (date-time) | null | |
state必填 | string | running or stopped. |
task | NamedRefDto | null | |
TimerLastDto
The segment that ended last.
| 字段 | 类型 | 说明 |
|---|
endReason必填 | string | stop, switch, autostop or discard. |
endedAt必填 | string (date-time) | |
segmentId必填 | string (uuid) | |
startedAt必填 | string (date-time) | |
TimerProjectDto
The project of the running segment.
| 字段 | 类型 | 说明 |
|---|
clientName | string | null | |
color | string | null | |
id必填 | string (uuid) | |
name必填 | string | |
TimerStartRequest
POST /v1/me/timer/start (Idempotency-Key: the client's command id): start, or switch while running.
| 字段 | 类型 | 说明 |
|---|
at | string (date-time) | null | The client's clock when the command was given (default: the server's now; at most 5 minutes ahead, at most 7
days back). |
isBillable | boolean | null | |
note | string | null | |
projectId | string (uuid) | null | |
source | string | null | web (default), desktop or api. |
taskId | string (uuid) | null | |
UpdateTimeEntryRequest
PUT /v1/time-entries/{id}: the whole editable body (kind and user never change; If-Match instead of version).
| 字段 | 类型 | 说明 |
|---|
description | string | null | |
end | string (date-time) | null | |
level | string | null | |
projectId | string (uuid) | null | |
start | string (date-time) | null | |
UpdateWebhookEndpointRequest
PATCH /v1/webhook-endpoints/{id} (If-Match).
| 字段 | 类型 | 说明 |
|---|
description | string | null | null clears it. |
eventTypes | string[] | null | |
status | string | null | active (also opens a disabled endpoint and resets its failure counters) or paused. |
takeOver | boolean | null | true: the caller becomes the endpoint's owner (lifts an owner_inactive pause). |
url | string | null | |
UserDailyDto
A user's days: computed days plus the workdays without activity up to the user's today.
| 字段 | 类型 | 说明 |
|---|
days必填 | UserDayDto[] | |
from必填 | string (date) | |
teamId | string (uuid) | null | The user's current primary team (its rules classify every day). |
timeZone必填 | string | |
to必填 | string (date) | |
userId必填 | string (uuid) | |
UserDayDto
| 字段 | 类型 | 说明 |
|---|
absence | DayAbsenceDto | null | |
absenceCreditMs必填 | integer (int64) | |
activeMs必填 | integer (int64) | |
afkCoverage必填 | boolean | |
arrivalAt | string (date-time) | null | |
atWorkMs必填 | integer (int64) | |
attendanceStatus | string | null | onTime, late, absent, notStarted, dayOff, onLeave, holiday; null outside the directory. |
classified必填 | boolean | |
date必填 | string (date) | |
dayOffWorkedMs必填 | integer (int64) | |
deletedMs必填 | integer (int64) | |
effectivenessPct | number (double) | null | |
eventCount必填 | integer (int64) | |
expectedWorkMs必填 | integer (int64) | |
holiday | DailyHolidayDto | null | |
idleMs必填 | integer (int64) | |
lateByMs必填 | integer (int64) | |
leftAt | string (date-time) | null | |
leftEarly必填 | boolean | |
leftEarlyByMs必填 | integer (int64) | |
meetingMs必填 | integer (int64) | |
neutralMs必填 | integer (int64) | |
offlineMs必填 | integer (int64) | |
overtimeMs必填 | integer (int64) | |
planKind | string | null | schedule, shift, dayOff or holiday. |
privateMs必填 | integer (int64) | |
productiveMs必填 | integer (int64) | |
productivityPct | number (double) | null | |
shiftCount必填 | integer (int32) | |
targetMs必填 | integer (int64) | |
topApp | string | null | Display name of the app with the most active time. |
unproductiveMs必填 | integer (int64) | |
workday | boolean | null | |
workedMs必填 | integer (int64) | |
UserTotalDto
One user of a summary.
| 字段 | 类型 | 说明 |
|---|
absenceCreditMs必填 | integer (int64) | |
absentDays | integer (int32) | null | Only for tracked users. |
activeDays必填 | integer (int32) | Local days with active time. |
activeMs必填 | integer (int64) | |
arrivalAt | string (date-time) | null | Earliest arrival and latest leave in the range. |
atWorkMs必填 | integer (int64) | |
classifiedDays必填 | integer (int32) | |
dayOffWorkedMs必填 | integer (int64) | |
deletedMs必填 | integer (int64) | |
effectivenessPct | number (double) | null | null without a target and for users missing from the directory. |
email | string | null | |
eventCount必填 | integer (int64) | |
fullName | string | null | |
holidayDays必填 | number (double) | |
idleMs必填 | integer (int64) | |
lateDays | integer (int32) | null | |
leaveDays必填 | number (double) | |
leftAt | string (date-time) | null | |
leftEarlyDays | integer (int32) | null | |
meetingMs必填 | integer (int64) | |
neutralMs必填 | integer (int64) | |
offlineMs必填 | integer (int64) | |
overtimeDays必填 | integer (int32) | |
overtimeMs必填 | integer (int64) | |
privateMs必填 | integer (int64) | |
productiveMs必填 | integer (int64) | |
productivityPct | number (double) | null | |
shiftDays必填 | integer (int32) | |
targetMs | integer (int64) | null | |
teamId | string (uuid) | null | |
teamName | string | null | |
timeZone必填 | string | |
unproductiveMs必填 | integer (int64) | |
userId必填 | string (uuid) | |
workdays | integer (int32) | null | |
workedMs必填 | integer (int64) | |
WebhookDeliveryDetailDto
GET /v1/webhook-endpoints/{id}/deliveries/{deliveryId}: the delivery and the body that was (or is) sent.
WebhookDeliveryDto
WebhookDeliveryDto.
| 字段 | 类型 | 说明 |
|---|
attempts必填 | integer (int32) | |
createdAt必填 | string | |
deliveredAt | string | null | |
eventId必填 | string (uuid) | The webhook-id header. |
eventType必填 | string | |
id必填 | string | A 64-bit integer as a string. |
lastDurationMs | integer (int32) | null | |
lastError | string | null | timeout, connect, tls, not_allowed, http_<code>, not_in_plan, owner_inactive. |
lastStatusCode | integer (int32) | null | |
nextAttemptAt | string | null | |
status必填 | string | pending, succeeded, failed, dead. |
WebhookDeliveryPage
GET /v1/webhook-endpoints/{id}/deliveries (newest first).
WebhookEndpointDto
WebhookEndpointDto.
| 字段 | 类型 | 说明 |
|---|
createdAt必填 | string | |
description | string | null | |
eventTypes必填 | string[] | |
id必填 | string (uuid) | |
owner必填 | MemberRefDto | The member who owns the endpoint (G1: a delivery needs an active Owner or Admin owner). |
previousSecretExpiresAt | string | null | After a rotation the previous secret still signs until then (24 hours). |
secretPrefix必填 | string | The first 8 characters of the signing secret (whsec_Kx); never the secret. |
stats必填 | WebhookEndpointStatsDto | |
status必填 | string | active, paused, disabled. |
statusReason | string | null | manual, owner_inactive, failing, gone; null while active. |
updatedAt必填 | string | |
url必填 | string | |
version必填 | integer (int64) | row_version (ETag: "v<n>", If-Match of PATCH). |
WebhookEndpointPage
GET /v1/webhook-endpoints.
WebhookEndpointStatsDto
The delivery statistics of an endpoint.
| 字段 | 类型 | 说明 |
|---|
consecutiveFailures必填 | integer (int32) | |
lastFailureAt | string | null | |
lastSuccessAt | string | null | |
WebhookEventDto
One event type of GET /v1/webhook-events.
| 字段 | 类型 | 说明 |
|---|
available必填 | boolean | The tenant's plan has the feature: an endpoint may subscribe. |
description必填 | string | One English sentence (the panel translates by type). |
feature | string | null | The plan feature the event needs (null: every plan with api_access). |
object必填 | string | The data.object of the delivery body. |
type必填 | string | <object>.<verb>, e.g. time_entry.approved. |
WebhookEventsDto
GET /v1/webhook-events.
WebhookTestDto
202 of POST /v1/webhook-endpoints/{id}/test.
| 字段 | 类型 | 说明 |
|---|
deliveryId必填 | string | The delivery of the test event (a string: the deliveries' id is a 64-bit integer). |