{ "openapi": "3.0.1", "info": { "title": "Tickr API", "description": "Time tracking API. Authenticate JWT (header `Authorization: Bearer `) for /api/* private routes, or an API key (header `Authorization: Bearer tkr__`) for /api/v1/* public routes.", "version": "v1" }, "paths": { "/api/me/workspaces/{wid}/api-keys": { "get": { "tags": [ "ApiKeys" ], "parameters": [ { "name": "wid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "ApiKeys" ], "parameters": [ { "name": "wid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/me/workspaces/{wid}/api-keys/{id}": { "delete": { "tags": [ "ApiKeys" ], "parameters": [ { "name": "wid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/register": { "post": { "tags": [ "Auth" ], "operationId": "Register", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/login": { "post": { "tags": [ "Auth" ], "operationId": "Login", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/refresh": { "post": { "tags": [ "Auth" ], "operationId": "Refresh", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshHttpRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/logout": { "post": { "tags": [ "Auth" ], "operationId": "Logout", "responses": { "200": { "description": "OK" } } } }, "/api/auth/me": { "get": { "tags": [ "Auth" ], "operationId": "Me", "responses": { "200": { "description": "OK" } } } }, "/api/auth/providers": { "get": { "tags": [ "Auth" ], "operationId": "ListAuthProviders", "responses": { "200": { "description": "OK" } } } }, "/api/auth/password/set": { "post": { "tags": [ "Auth" ], "operationId": "SetPassword", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPasswordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/me/external-logins/{provider}": { "delete": { "tags": [ "Auth" ], "operationId": "UnlinkExternalLogin", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/me/preferences": { "patch": { "tags": [ "Auth" ], "operationId": "UpdatePreferences", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePreferencesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/api-keys": { "get": { "tags": [ "Auth" ], "operationId": "ListUserApiKeys", "responses": { "200": { "description": "OK" } } } }, "/api/auth/password-reset/request": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordResetRequestHttpRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/password-reset/confirm": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordResetConfirmHttpRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/sso/microsoft/start": { "get": { "tags": [ "Auth" ], "operationId": "SsoMicrosoftStart", "parameters": [ { "name": "return_to", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/sso/microsoft/callback": { "get": { "tags": [ "Auth" ], "operationId": "SsoMicrosoftCallback", "parameters": [ { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/sso/microsoft/verify-email": { "get": { "tags": [ "Auth" ], "operationId": "SsoMicrosoftVerifyEmail", "parameters": [ { "name": "token", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Auth" ], "operationId": "SsoMicrosoftVerifyEmailConfirm", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyEmailRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/billable-settings": { "get": { "tags": [ "Billable settings" ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Billable settings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBillableSettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/billable-settings/resnapshot": { "post": { "tags": [ "Billable settings" ], "parameters": [ { "name": "apply", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResnapshotAllRequest" } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/billable-settings/apply": { "post": { "tags": [ "Billable settings" ], "parameters": [ { "name": "dryRun", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyBillingBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/calendar-events": { "get": { "tags": [ "Calendar" ], "operationId": "ListCalendarEvents", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/calendar-connections": { "get": { "tags": [ "Calendar" ], "operationId": "GetCalendarConnections", "responses": { "200": { "description": "OK" } } } }, "/api/calendar-connections/microsoft/start": { "get": { "tags": [ "Calendar" ], "operationId": "CalendarMicrosoftStart", "responses": { "200": { "description": "OK" } } } }, "/api/calendar-connections/microsoft/callback": { "get": { "tags": [ "Calendar" ], "operationId": "CalendarMicrosoftCallback", "parameters": [ { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/calendar-connections/{provider}": { "delete": { "tags": [ "Calendar" ], "operationId": "CalendarDisconnect", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/calendar-connections/{provider}/calendars": { "patch": { "tags": [ "Calendar" ], "operationId": "CalendarUpdateSelection", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSelectionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/public/client-approval/{token}": { "get": { "tags": [ "ClientApproval" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/public/client-approval/{token}/approve": { "post": { "tags": [ "ClientApproval" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovePublicRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/public/client-approval/{token}/contest": { "post": { "tags": [ "ClientApproval" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContestPublicRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/public/client-approval/{token}/document": { "get": { "tags": [ "ClientApproval" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/clients": { "get": { "tags": [ "Clients" ], "parameters": [ { "name": "include_archived", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Clients" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateClientRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/clients/monthly-stats": { "get": { "tags": [ "Clients" ], "responses": { "200": { "description": "OK" } } } }, "/api/clients/{id}": { "get": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClientRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/clients/{id}/unarchive": { "post": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/clients/{id}/move": { "post": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "dryRun", "in": "query", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveClientRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/clients/{id}/identity": { "get": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClientIdentityRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/clients/{id}/logo": { "get": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/clients/{id}/contacts": { "get": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateClientContactRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/clients/{id}/contacts/{contactId}": { "delete": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/clients/{id}/approval-readiness": { "get": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "periodStart", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "periodEnd", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/clients/{id}/approval-requests/prepare": { "get": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "periodStart", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "periodEnd", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/clients/{id}/approval-requests": { "post": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendApprovalRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/clients/{id}/approval-requests/{reqId}/document": { "get": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reqId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/clients/{id}/approval-requests/{reqId}/resend": { "post": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reqId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/clients/{id}/approval-requests/{reqId}/reopen-lines": { "post": { "tags": [ "Clients" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reqId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/": { "get": { "tags": [ "CoderiseToggl.Api" ], "responses": { "200": { "description": "OK" } } } }, "/api/dashboard/analytics": { "get": { "tags": [ "Dashboard" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "projects", "in": "query", "schema": { "type": "string" } }, { "name": "users", "in": "query", "schema": { "type": "string" } }, { "name": "clients", "in": "query", "schema": { "type": "string" } }, { "name": "tags", "in": "query", "schema": { "type": "string" } }, { "name": "compare_with_previous", "in": "query", "schema": { "type": "boolean" } }, { "name": "tasks", "in": "query", "schema": { "type": "string" } }, { "name": "description_contains", "in": "query", "schema": { "type": "string" } }, { "name": "rounding[grain]", "in": "query", "schema": { "type": "string" } }, { "name": "rounding[mode]", "in": "query", "schema": { "type": "string" } }, { "name": "summary[breakdown_by]", "in": "query", "schema": { "type": "string" } }, { "name": "summary[and_by]", "in": "query", "schema": { "type": "string" } }, { "name": "summary[stack_by]", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardAnalyticsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } } } } }, "/api/entries": { "get": { "tags": [ "Entries" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "projectId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "clientId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "tagId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "project_ids", "in": "query", "schema": { "type": "string" } }, { "name": "client_ids", "in": "query", "schema": { "type": "string" } }, { "name": "task_ids", "in": "query", "schema": { "type": "string" } }, { "name": "tag_ids", "in": "query", "schema": { "type": "string" } }, { "name": "member_ids", "in": "query", "schema": { "type": "string" } }, { "name": "description_contains", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Entries" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/entries/{id}": { "patch": { "tags": [ "Entries" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEntryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Entries" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/entries/:bulk": { "post": { "tags": [ "Entries" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpsertEntriesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/me/workspaces/{wid}/exports/entries.xlsx": { "get": { "tags": [ "Exports" ], "parameters": [ { "name": "wid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "project_ids", "in": "query", "schema": { "type": "string" } }, { "name": "task_ids", "in": "query", "schema": { "type": "string" } }, { "name": "tag_ids", "in": "query", "schema": { "type": "string" } }, { "name": "client_ids", "in": "query", "schema": { "type": "string" } }, { "name": "member_ids", "in": "query", "schema": { "type": "string" } }, { "name": "description_contains", "in": "query", "schema": { "type": "string" } }, { "name": "rounding[grain]", "in": "query", "schema": { "type": "string" } }, { "name": "rounding[mode]", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{wid}/exports/entries/count": { "get": { "tags": [ "Exports" ], "parameters": [ { "name": "wid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "year", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{wid}/exports/entries/{format}": { "get": { "tags": [ "Exports" ], "parameters": [ { "name": "wid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "format", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "year", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{wid}/exports/data/{format}": { "get": { "tags": [ "Exports" ], "parameters": [ { "name": "wid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "format", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categories", "in": "query", "schema": { "type": "string" } }, { "name": "year", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/health/live": { "get": { "tags": [ "Health" ], "operationId": "HealthLive", "responses": { "200": { "description": "OK" } } } }, "/api/health/ready": { "get": { "tags": [ "Health" ], "operationId": "HealthReady", "responses": { "200": { "description": "OK" } } } }, "/api/health": { "get": { "tags": [ "Health" ], "operationId": "Health", "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{workspaceId}/import/toggl": { "post": { "tags": [ "Import" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "dryRun", "in": "query", "required": true, "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportTogglRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{workspaceId}/import/tickr": { "post": { "tags": [ "Import" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "dryRun", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "overwriteExisting", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "ignoreUnknownEmails", "in": "query", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{workspaceId}/invitations": { "post": { "tags": [ "Invitations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvitationHttpRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Invitations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{workspaceId}/invitations/{invitationId}/resend": { "post": { "tags": [ "Invitations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "invitationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{workspaceId}/invitations/{invitationId}/revoke": { "post": { "tags": [ "Invitations" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "invitationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/invitations/{token}": { "get": { "tags": [ "Invitations" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/invitations/{token}/accept": { "post": { "tags": [ "Invitations" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/invitations/{token}/signup-and-accept": { "post": { "tags": [ "Invitations" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignupAndAcceptHttpRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/me/profile": { "patch": { "tags": [ "Me" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/me/workspaces/{wid}": { "patch": { "tags": [ "Me" ], "parameters": [ { "name": "wid", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWorkspaceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/me/pending-invitations/{invitationId}/accept": { "post": { "tags": [ "Me" ], "parameters": [ { "name": "invitationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{workspaceId}/members": { "get": { "tags": [ "Members" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "include_deactivated", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{workspaceId}/members/{userId}": { "patch": { "tags": [ "Members" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeMemberRoleHttpRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Members" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{workspaceId}/members/{userId}/password-reset": { "post": { "tags": [ "Members" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/projects/{id}/member-rates": { "get": { "tags": [ "Project member rates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/projects/{id}/member-rates/{user_id}": { "put": { "tags": [ "Project member rates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetProjectMemberRateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Project member rates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/projects/{id}/rate": { "get": { "tags": [ "Project rates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Project rates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetProjectRateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Project rates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/projects/{projectId}/members": { "get": { "tags": [ "ProjectMembers" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "ProjectMembers" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddProjectMemberRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/projects/{projectId}/members/{userId}": { "delete": { "tags": [ "ProjectMembers" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/projects/{projectId}/members/{userId}/manager": { "patch": { "tags": [ "ProjectMembers" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetProjectManagerRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/projects": { "get": { "tags": [ "Projects" ], "parameters": [ { "name": "archived", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Projects" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/projects/monthly-stats": { "get": { "tags": [ "Projects" ], "responses": { "200": { "description": "OK" } } } }, "/api/projects/{id}": { "get": { "tags": [ "Projects" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "Projects" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/projects/{id}/archive": { "post": { "tags": [ "Projects" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/projects/{id}/unarchive": { "post": { "tags": [ "Projects" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/entries": { "get": { "tags": [ "PublicV1" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "project_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "task_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "tag_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "PublicV1" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/entries/{id}": { "patch": { "tags": [ "PublicV1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEntryRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "PublicV1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/entries:bulk": { "post": { "tags": [ "PublicV1" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpsertEntriesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/timers/start": { "post": { "tags": [ "PublicV1" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartTimerRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/timers/{id}/stop": { "post": { "tags": [ "PublicV1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopTimerRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/timers/active": { "get": { "tags": [ "PublicV1" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/projects": { "get": { "tags": [ "PublicV1" ], "parameters": [ { "name": "archived", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/tasks": { "get": { "tags": [ "PublicV1" ], "parameters": [ { "name": "project_id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "archived", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/tags": { "get": { "tags": [ "PublicV1" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/clients": { "get": { "tags": [ "PublicV1" ], "parameters": [ { "name": "include_archived", "in": "query", "schema": { "type": "boolean" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/clients/{id}": { "get": { "tags": [ "PublicV1" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{wsId}/saved-reports": { "get": { "tags": [ "SavedReports" ], "parameters": [ { "name": "wsId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "SavedReports" ], "parameters": [ { "name": "wsId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSavedReportInput" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{wsId}/saved-reports/{id}": { "get": { "tags": [ "SavedReports" ], "parameters": [ { "name": "wsId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "SavedReports" ], "parameters": [ { "name": "wsId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSavedReportInput" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "SavedReports" ], "parameters": [ { "name": "wsId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/tags": { "get": { "tags": [ "Tags" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Tags" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/tags/{id}": { "patch": { "tags": [ "Tags" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTagRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Tags" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/projects/{projectId}/tasks": { "get": { "tags": [ "Tasks" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "archived", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Tasks" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTaskRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/tasks/{id}": { "patch": { "tags": [ "Tasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTaskRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/tasks/{id}/archive": { "post": { "tags": [ "Tasks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/timers/start": { "post": { "tags": [ "Timers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartTimerRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/timers/{id}/stop": { "post": { "tags": [ "Timers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopTimerRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/timers/active": { "get": { "tags": [ "Timers" ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/timesheet-settings": { "get": { "tags": [ "Timesheets" ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Timesheets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTimesheetSettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/timesheet-submissions": { "get": { "tags": [ "Timesheets" ], "parameters": [ { "name": "queue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Timesheets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitTimesheetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/timesheet-submissions/preview": { "post": { "tags": [ "Timesheets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewSubmissionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/timesheet-submissions/{submissionId}/resubmit": { "post": { "tags": [ "Timesheets" ], "parameters": [ { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/timesheet-submissions/{submissionId}/reopen": { "post": { "tags": [ "Timesheets" ], "parameters": [ { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/timesheet-submissions/{submissionId}/events": { "get": { "tags": [ "Timesheets" ], "parameters": [ { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/timesheet-submissions/{submissionId}/approve-all": { "post": { "tags": [ "Timesheets" ], "parameters": [ { "name": "submissionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/submission-lines/{lineId}/approve": { "post": { "tags": [ "Timesheets" ], "parameters": [ { "name": "lineId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/submission-lines/{lineId}/reject": { "post": { "tags": [ "Timesheets" ], "parameters": [ { "name": "lineId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectLineRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/period-closings": { "post": { "tags": [ "Timesheets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePeriodClosingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Timesheets" ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/period-closings/{id}/remind": { "post": { "tags": [ "Timesheets" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/branding": { "get": { "tags": [ "Timesheets" ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Timesheets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWorkspaceBrandingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/branding/logo": { "get": { "tags": [ "Timesheets" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Timesheets" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Timesheets" ], "responses": { "200": { "description": "OK" } } } }, "/api/tracker/suggestions": { "get": { "tags": [ "Tracker" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "entriesLimit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "tasksLimit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "projectsLimit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/member-rates": { "get": { "tags": [ "Workspace member rates" ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/me/member-rates/{user_id}": { "put": { "tags": [ "Workspace member rates" ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMemberRateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Workspace member rates" ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces": { "post": { "tags": [ "Workspaces" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWorkspaceHttpRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{workspaceId}/settings": { "patch": { "tags": [ "Workspaces" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateWorkspaceSettingsHttpRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{workspaceId}/transfer-ownership": { "post": { "tags": [ "Workspaces" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferOwnershipRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{workspaceId}/leave": { "post": { "tags": [ "Workspaces" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/{workspaceId}": { "delete": { "tags": [ "Workspaces" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AddProjectMemberRequest": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "isManager": { "type": "boolean" } }, "additionalProperties": false }, "ApplyBillingBody": { "type": "object", "properties": { "scopeKind": { "$ref": "#/components/schemas/BillingScopeKind" }, "clientId": { "type": "string", "format": "uuid", "nullable": true }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "memberIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "from": { "type": "string", "format": "date-time", "nullable": true }, "to": { "type": "string", "format": "date-time", "nullable": true }, "target": { "$ref": "#/components/schemas/BillingTarget" }, "confirmationToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApprovePublicRequest": { "type": "object", "properties": { "signerName": { "type": "string", "nullable": true }, "signerEmail": { "type": "string", "nullable": true }, "attestationAccepted": { "type": "boolean" } }, "additionalProperties": false }, "BillingScopeKind": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "BillingTarget": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "BreakdownDto": { "type": "object", "properties": { "primary": { "type": "array", "items": { "$ref": "#/components/schemas/BreakdownRowDto" }, "nullable": true } }, "additionalProperties": false }, "BreakdownRowDto": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "seconds": { "type": "integer", "format": "int64" }, "secondsPct": { "type": "number", "format": "double" }, "amount": { "$ref": "#/components/schemas/ReportsAmountDto" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/BreakdownRowDto" }, "nullable": true } }, "additionalProperties": false }, "BulkEntryItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid", "nullable": true }, "taskId": { "type": "string", "format": "uuid", "nullable": true }, "description": { "type": "string", "nullable": true }, "startedAt": { "type": "string", "format": "date-time" }, "stoppedAt": { "type": "string", "format": "date-time", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "isBillable": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "BulkUpsertEntriesRequest": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BulkEntryItem" }, "nullable": true } }, "additionalProperties": false }, "ChangeMemberRoleHttpRequest": { "type": "object", "properties": { "role": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContestPublicRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateApiKeyRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateClientContactRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateClientRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "defaultHourlyRate": { "type": "number", "format": "double", "nullable": true }, "defaultIsBillable": { "type": "boolean", "nullable": true }, "color": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateEntryRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "projectId": { "type": "string", "format": "uuid", "nullable": true }, "taskId": { "type": "string", "format": "uuid", "nullable": true }, "description": { "type": "string", "nullable": true }, "startedAt": { "type": "string", "format": "date-time" }, "stoppedAt": { "type": "string", "format": "date-time" }, "tagIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "isBillable": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreateInvitationHttpRequest": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "role": { "type": "string", "nullable": true }, "personalNote": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreatePeriodClosingRequest": { "type": "object", "properties": { "periodStart": { "type": "string", "format": "date" }, "periodEnd": { "type": "string", "format": "date" }, "deadline": { "type": "string", "format": "date" }, "clientId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CreateProjectRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "visibility": { "$ref": "#/components/schemas/ProjectVisibility" }, "clientId": { "type": "string", "format": "uuid", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateSavedReportInput": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isShared": { "type": "boolean" }, "filters": { "type": "string", "nullable": true }, "viewConfig": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateTagRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateTaskRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateWorkspaceHttpRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "defaultProjectVisibility": { "type": "string", "nullable": true }, "membersCanCreateProjects": { "type": "boolean", "nullable": true }, "membersCanCreateTags": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "DashboardAnalyticsDto": { "type": "object", "properties": { "period": { "$ref": "#/components/schemas/DashboardPeriodDto" }, "previousPeriod": { "$ref": "#/components/schemas/DashboardPeriodDto" }, "totals": { "$ref": "#/components/schemas/DashboardTotalsDto" }, "previousTotals": { "$ref": "#/components/schemas/DashboardTotalsDto" }, "byDay": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardByDayPointDto" }, "nullable": true }, "byProject": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardByProjectDto" }, "nullable": true }, "byUser": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardByUserDto" }, "nullable": true }, "byClient": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardByClientDto" }, "nullable": true }, "byTag": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardByTagDto" }, "nullable": true }, "pivot": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardPivotRowDto" }, "nullable": true }, "breakdown": { "$ref": "#/components/schemas/BreakdownDto" }, "avgDailySeconds": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "DashboardByClientDto": { "type": "object", "properties": { "clientId": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "hours": { "type": "number", "format": "double" }, "revenue": { "type": "number", "format": "double" } }, "additionalProperties": false }, "DashboardByDayPointDto": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "hours": { "type": "number", "format": "double" }, "previousHours": { "type": "number", "format": "double", "nullable": true }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardByDayProjectPointDto" }, "nullable": true }, "stacks": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardByDayStackDto" }, "nullable": true } }, "additionalProperties": false }, "DashboardByDayProjectPointDto": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "hours": { "type": "number", "format": "double" } }, "additionalProperties": false }, "DashboardByDayStackDto": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "seconds": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "DashboardByProjectDto": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "hours": { "type": "number", "format": "double" }, "revenue": { "type": "number", "format": "double" } }, "additionalProperties": false }, "DashboardByTagDto": { "type": "object", "properties": { "tagId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "hours": { "type": "number", "format": "double" } }, "additionalProperties": false }, "DashboardByUserDto": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "displayName": { "type": "string", "nullable": true }, "hours": { "type": "number", "format": "double" }, "revenue": { "type": "number", "format": "double" } }, "additionalProperties": false }, "DashboardPeriodDto": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time" }, "to": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "DashboardPivotRowDto": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "projectName": { "type": "string", "nullable": true }, "userId": { "type": "string", "format": "uuid" }, "userDisplayName": { "type": "string", "nullable": true }, "clientId": { "type": "string", "format": "uuid", "nullable": true }, "clientName": { "type": "string", "nullable": true }, "hours": { "type": "number", "format": "double" }, "pct": { "type": "number", "format": "double" } }, "additionalProperties": false }, "DashboardTotalsDto": { "type": "object", "properties": { "hours": { "type": "number", "format": "double" }, "billableHours": { "type": "number", "format": "double" }, "activeProjects": { "type": "integer", "format": "int32" }, "revenue": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "HttpValidationProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": { } }, "ImportTogglRequest": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "encoding": { "type": "string", "nullable": true }, "applyMojibakeFix": { "type": "boolean" }, "timezone": { "type": "string", "nullable": true }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/ImportTogglRow" }, "nullable": true } }, "additionalProperties": false }, "ImportTogglRow": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "client": { "type": "string", "nullable": true }, "project": { "type": "string", "nullable": true }, "task": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "billable": { "type": "boolean" }, "startedAtLocal": { "type": "string", "nullable": true }, "stoppedAtLocal": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "LoginRequest": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MoveClientRequest": { "type": "object", "properties": { "targetWorkspaceId": { "type": "string", "format": "uuid" }, "merge": { "type": "boolean" } }, "additionalProperties": false }, "PasswordResetConfirmHttpRequest": { "type": "object", "properties": { "token": { "type": "string", "nullable": true }, "newPassword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PasswordResetRequestHttpRequest": { "type": "object", "properties": { "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PreviewSubmissionRequest": { "type": "object", "properties": { "periodStart": { "type": "string", "format": "date" }, "periodEnd": { "type": "string", "format": "date" }, "clientId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "ProjectVisibility": { "enum": [ 0, 1 ], "type": "integer", "format": "int32" }, "RefreshHttpRequest": { "type": "object", "properties": { "workspaceId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "RegisterRequest": { "type": "object", "properties": { "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RejectLineRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportsAmountDto": { "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResnapshotAllRequest": { "type": "object", "properties": { "apply": { "type": "boolean" }, "confirmationToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SendApprovalRequest": { "type": "object", "properties": { "periodStart": { "type": "string", "format": "date" }, "periodEnd": { "type": "string", "format": "date" }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "showTaskDetail": { "type": "boolean" }, "showAmounts": { "type": "boolean" }, "contactIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "adHocEmails": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "SetMemberRateRequest": { "type": "object", "properties": { "hourlyRate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "SetPasswordRequest": { "type": "object", "properties": { "currentPassword": { "type": "string", "nullable": true }, "newPassword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SetProjectManagerRequest": { "type": "object", "properties": { "isManager": { "type": "boolean" } }, "additionalProperties": false }, "SetProjectMemberRateRequest": { "type": "object", "properties": { "hourlyRate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "SetProjectRateRequest": { "type": "object", "properties": { "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "defaultIsBillable": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "SignupAndAcceptHttpRequest": { "type": "object", "properties": { "password": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "preferredLanguage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StartTimerRequest": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "nullable": true }, "taskId": { "type": "string", "format": "uuid", "nullable": true }, "description": { "type": "string", "nullable": true }, "tagIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "isBillable": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "StopTimerRequest": { "type": "object", "properties": { "stoppedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SubmitTimesheetRequest": { "type": "object", "properties": { "periodStart": { "type": "string", "format": "date" }, "periodEnd": { "type": "string", "format": "date" }, "clientId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "TransferOwnershipRequest": { "type": "object", "properties": { "targetUserId": { "type": "string", "format": "uuid" }, "currentPassword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateBillableSettingsRequest": { "type": "object", "properties": { "currency": { "type": "string", "nullable": true }, "clearDefaultHourlyRate": { "type": "boolean" }, "defaultHourlyRate": { "type": "number", "format": "double", "nullable": true }, "defaultIsBillable": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdateClientIdentityRequest": { "type": "object", "properties": { "legalName": { "type": "string", "nullable": true }, "addressLines": { "type": "string", "nullable": true }, "contactEmail": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateClientRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "defaultHourlyRate": { "type": "number", "format": "double", "nullable": true }, "clearDefaultHourlyRate": { "type": "boolean" }, "defaultIsBillable": { "type": "boolean", "nullable": true }, "clearDefaultIsBillable": { "type": "boolean" }, "color": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateEntryRequest": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "nullable": true }, "clearProject": { "type": "boolean" }, "taskId": { "type": "string", "format": "uuid", "nullable": true }, "clearTask": { "type": "boolean" }, "description": { "type": "string", "nullable": true }, "startedAt": { "type": "string", "format": "date-time", "nullable": true }, "stoppedAt": { "type": "string", "format": "date-time", "nullable": true }, "clearStop": { "type": "boolean" }, "tagIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "isBillable": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdatePreferencesRequest": { "type": "object", "properties": { "preferredLanguage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateProfileRequest": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "currentPassword": { "type": "string", "nullable": true }, "newPassword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateProjectRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true }, "clientId": { "type": "string", "format": "uuid", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateSavedReportInput": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isShared": { "type": "boolean" }, "filters": { "type": "string", "nullable": true }, "viewConfig": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateSelectionRequest": { "type": "object", "properties": { "calendarIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UpdateTagRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "color": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateTaskRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isArchived": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdateTimesheetSettingsRequest": { "type": "object", "properties": { "timesheetValidationEnabled": { "type": "boolean" }, "allowSelfValidation": { "type": "boolean" } }, "additionalProperties": false }, "UpdateWorkspaceBrandingRequest": { "type": "object", "properties": { "legalName": { "type": "string", "nullable": true }, "addressLines": { "type": "string", "nullable": true }, "contactEmail": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateWorkspaceRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateWorkspaceSettingsHttpRequest": { "type": "object", "properties": { "membersCanCreateProjects": { "type": "boolean", "nullable": true }, "membersCanCreateTags": { "type": "boolean", "nullable": true }, "defaultProjectVisibility": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VerifyEmailRequest": { "type": "object", "properties": { "token": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "bearer": { "type": "http", "description": "JWT for private endpoints, or API key (tkr_...) for /api/v1/*", "scheme": "bearer", "bearerFormat": "JWT or tkr__" } } }, "security": [ { "bearer": [ ] } ] }