API reference · version 0.1.0
Hubtask API
Rendered from the contract, which is the source: 306
operations under 27 tags, every schema, every event. The base address is https://{host}/api/v1.
About
What the contract says of itself
The Hubtask API contract (API first). This file is the single source of truth: server interfaces and client SDKs are generated from it.
The conventions:
- one major path
/api/v1, additive changes without a version bump - errors per RFC 9457 with a stable
code - cursor pagination,
Idempotency-Key,ETag/If-Match - actions as a suffix (
POST /items/{id}:complete) - no display text, only codes and parameters
By tag
The operations
8 operations
meta
19 operations
identity
POST/accounts:invitePOST/accounts/{accountId}:renew-invitationPOST/accounts:create-managedGET/accounts/meGET/accounts/{accountId}POST/accounts/{accountId}:issue-start-passwordPOST/accounts/{accountId}:add-addressPATCH/accounts/{accountId}/preferencesGET/accounts/{accountId}/notification-preferencesPUT/accounts/{accountId}/notification-preferences/{category}/{channel}GET/accounts/me/emergency-noticesGET/membershipsPOST/membershipsDELETE/memberships/{membershipId}GET/groupsPOST/groupsGET/groups/{groupId}PATCH/groups/{groupId}DELETE/groups/{groupId}
44 operations
auth
POST/auth/sessionsGET/auth/sessionsDELETE/auth/sessionsPOST/auth/sessions:revoke-othersPOST/auth/sessions:refreshDELETE/auth/sessions/{sessionId}POST/auth/invitations:redeemPOST/auth/invitations:inspectPOST/auth/installation:set-upPOST/auth/sessions:verifyPOST/auth/sessions:linkPOST/auth/sessions:agree-termsPOST/auth/passwordPOST/auth/password:forgotPOST/auth/password:resetPOST/auth/address:confirmPOST/auth/password:checkPOST/auth/sessions:set-passwordPOST/auth/sessions:elevateGET/auth/sign-in-rulesPOST/auth/mfa/totp:enrollPOST/auth/mfa/totp:confirmPOST/auth/step-upPOST/auth/step-up:providerPOST/auth/mfa/totp:replacePOST/auth/mfa/totp/replacement:confirmPOST/auth/mfa/recovery:regeneratePOST/auth/mfa:disableGET/auth/tokensPOST/auth/tokensDELETE/auth/tokens/{tokenId}GET/auth/service-accountsPOST/auth/service-accountsPOST/auth/oidc:startPOST/auth/oidc:callbackGET/tenant/accounts-without-providerGET/identity-providerPUT/identity-providerGET/identity-providersPOST/identity-providersPUT/identity-providers/{providerId}DELETE/identity-providers/{providerId}POST/identity-providers/{providerId}:offerGET/identity-provider-presets
8 operations
oauth
30 operations
admin
GET/admin/tenantsPOST/admin/tenantsPOST/admin/tenants/{tenantId}:suspendPOST/admin/tenants/{tenantId}:resumePOST/admin/tenants/{tenantId}:cancel-deletionPOST/admin/tenants/{tenantId}:deletePOST/admin/tenants/{tenantId}:open-passwordPOST/admin/tenants/{tenantId}:close-passwordPOST/admin/tenants/{tenantId}:replace-legal-holdsPOST/admin/tenants/{tenantId}:exportGET/admin/settingsPUT/admin/settingsGET/admin/operatorsPOST/admin/operatorsDELETE/admin/operators/{accountId}GET/admin/overviewGET/admin/journalGET/admin/ai-providersPOST/admin/ai-providersPUT/admin/ai-providers/{providerId}DELETE/admin/ai-providers/{providerId}GET/admin/identity-providersPOST/admin/identity-providersPUT/admin/identity-providers/{providerId}DELETE/admin/identity-providers/{providerId}POST/admin/identity-providers/{providerId}:withdrawPOST/admin/identity-providers/{providerId}:cancel-withdrawalGET/admin/encryptionPOST/admin/encryption:resealPATCH/admin/tenants/{tenantId}/quotas
12 operations
containers
GET/containersPOST/containersGET/containers/{containerId}PATCH/containers/{containerId}DELETE/containers/{containerId}PUT/containers/{containerId}/policiesPUT/containers/{containerId}/privacyPOST/containers/{containerId}:movePOST/containers/{containerId}:reorderPOST/containers/{containerId}:restorePOST/containers/{containerId}:archivePOST/containers/{containerId}:unarchive
36 operations
items
GET/trashPOST/trash:emptyGET/itemsPOST/itemsGET/items/{itemId}PATCH/items/{itemId}DELETE/items/{itemId}POST/items:queryPOST/searchPOST/search:reindexPOST/items/{itemId}:completePOST/items/{itemId}:reopenPOST/items/{itemId}:assignPOST/items/{itemId}:unassignPOST/items/{itemId}:auto-assignPOST/items/{itemId}:purgePOST/items/{itemId}:restorePOST/items/{itemId}:archivePOST/items/{itemId}:unarchivePOST/items/{itemId}:reorderPOST/items/{itemId}:movePOST/items/{itemId}:duplicatePOST/items:bulkGET/items/{itemId}/activityPUT/items/{itemId}/labels/{labelId}DELETE/items/{itemId}/labels/{labelId}PUT/items/{itemId}/members/{accountId}DELETE/items/{itemId}/members/{accountId}PUT/items/{itemId}/custom-fields/{key}PUT/items/{itemId}/coverDELETE/items/{itemId}/coverPUT/items/{itemId}/dueDELETE/items/{itemId}/dueGET/items/{itemId}/attachmentsPUT/items/{itemId}/attachments/{mediaId}DELETE/items/{itemId}/attachments/{mediaId}
13 operations
structure
GET/containers/{containerId}/bucketsPOST/containers/{containerId}/bucketsPATCH/containers/{containerId}/buckets/{bucketId}DELETE/containers/{containerId}/buckets/{bucketId}POST/containers/{containerId}/buckets/{bucketId}:reorderGET/containers/{containerId}/labelsPOST/containers/{containerId}/labelsPATCH/containers/{containerId}/labels/{labelId}DELETE/containers/{containerId}/labels/{labelId}GET/custom-fieldsPOST/custom-fieldsPATCH/custom-fields/{fieldId}DELETE/custom-fields/{fieldId}
4 operations
comments
4 operations
reminders
4 operations
recurrence
6 operations
templates
6 operations
media
4 operations
audit
11 operations
privacy
GET/privacy/requestsPOST/privacy/requestsPATCH/privacy/requests/{requestId}POST/privacy/requests/{requestId}:extendGET/privacy/requests/{requestId}/erasure-previewPOST/accounts/{accountId}:restrictGET/privacy/consentsPOST/privacy/consents:withdrawPOST/privacy/consents:giveGET/privacy/ai-objectionPOST/privacy/ai-objection:noticed
14 operations
backup
GET/backup-targetsPOST/backup-targetsDELETE/backup-targets/{targetId}POST/backup-targets/{targetId}:testGET/backup-targets/{targetId}/backupsGET/backup-schedulesPOST/backup-schedulesPATCH/backup-schedules/{scheduleId}DELETE/backup-schedules/{scheduleId}POST/backupsGET/backups/{backupId}POST/backups/{backupId}:verifyPOST/restoresGET/restores/{restoreId}
9 operations
retention
6 operations
sync
7 operations
views
4 operations
calendar
10 operations
webhooks
GET/integrations/webhooksPOST/integrations/webhooksGET/integrations/webhooks/{webhookId}PATCH/integrations/webhooks/{webhookId}DELETE/integrations/webhooks/{webhookId}GET/integrations/webhooks/{webhookId}/deliveriesPOST/integrations/webhooks/{webhookId}/deliveries/{deliveryId}:replayPOST/integrations/webhooks/{webhookId}:sendPOST/integrations/webhooks/{webhookId}:rotate-secretGET/integrations/triggers/{eventType}
8 operations
jumble
2 operations
jobs
2 operations
imports
7 operations
ai
12 operations
suggestions
POST/templates:generatePOST/items/{itemId}:decomposePOST/items/{itemId}:suggest-fieldsPOST/items/{itemId}:summarizePOST/items/{itemId}:translatePOST/items/{itemId}:classifyPOST/items/{itemId}:summarize-threadPOST/containers/{containerId}:summarizePOST/items/{itemId}:duplicatesGET/suggestionsPOST/suggestions/{suggestionId}:acceptPOST/suggestions/{suggestionId}:dismiss
16 operations
automation
GET/automation/rulesPOST/automation/rulesGET/automation/rules/{ruleId}PATCH/automation/rules/{ruleId}DELETE/automation/rules/{ruleId}POST/automation/rules/{ruleId}:enablePOST/automation/rules/{ruleId}:disablePOST/automation/rules:checkPOST/automation/rules:testPOST/automation/rules/{ruleId}:triggerPOST/automation/rules/{ruleId}:rotate-inbound-tokenPOST/automation/inbound/{token}GET/automation/runsGET/automation/runs/{runId}POST/automation/runs/{runId}:replayPOST/integrations/http-requests