API REFERENCE · v0.1.0

The AlgaPSA REST API

A resource-oriented REST API returning JSON. HTTPS-only. API-key authenticated.901 endpoints across 69 resource groups.

Base URL
algapsa.com
Resources
69 groups
Endpoints
901

Access Control & Users v1

POST/api/v1/permission-checksCheck user permissionsGET/api/v1/permissionsList permissionsPOST/api/v1/permissionsCreate permissionGET/api/v1/permissions/categoriesList permission categoriesGET/api/v1/permissions/{id}Get permissionPUT/api/v1/permissions/{id}Update permissionDELETE/api/v1/permissions/{id}Delete permissionGET/api/v1/permissions/{id}/rolesList roles using permissionGET/api/v1/rbac/analyticsGet RBAC analyticsGET/api/v1/rbac/auditGet RBAC audit log (not implemented)GET/api/v1/rolesList rolesPOST/api/v1/rolesCreate rolePOST/api/v1/roles/bulkBulk create rolesGET/api/v1/roles/templatesList role templatesGET/api/v1/roles/{id}Get rolePUT/api/v1/roles/{id}Update roleDELETE/api/v1/roles/{id}Delete rolePOST/api/v1/roles/{id}/cloneClone roleGET/api/v1/roles/{id}/permissionsGet role permissionsPUT/api/v1/roles/{id}/permissionsReplace role permissionsGET/api/v1/teamsList teamsPOST/api/v1/teamsCreate teamPUT/api/v1/teams/bulkBulk update teamsDELETE/api/v1/teams/bulkBulk delete teamsGET/api/v1/teams/hierarchyGet team hierarchyGET/api/v1/teams/searchSearch teamsGET/api/v1/teams/statsGet team statsGET/api/v1/teams/{id}Get teamPUT/api/v1/teams/{id}Update teamDELETE/api/v1/teams/{id}Delete teamGET/api/v1/teams/{id}/analyticsGet team analyticsPOST/api/v1/teams/{id}/hierarchyAttach team to parent hierarchyDELETE/api/v1/teams/{id}/hierarchyDetach team from hierarchyPUT/api/v1/teams/{id}/managerAssign team managerGET/api/v1/teams/{id}/membersList team membersPOST/api/v1/teams/{id}/membersAdd team memberPOST/api/v1/teams/{id}/members/bulkBulk add team membersDELETE/api/v1/teams/{id}/members/{userId}Remove team memberGET/api/v1/teams/{id}/permissionsList team permissionsPOST/api/v1/teams/{id}/permissionsGrant team permissionDELETE/api/v1/teams/{id}/permissions/{permissionId}Revoke team permissionGET/api/v1/teams/{id}/projectsList team projectsGET/api/v1/user-rolesList users with rolesGET/api/v1/usersList usersPOST/api/v1/usersCreate userGET/api/v1/users/activityList global user activityPOST/api/v1/users/bulk/createBulk create users (route currently mapped to single create)PUT/api/v1/users/bulk/deactivateBulk deactivate users (route currently mapped to update-by-id)GET/api/v1/users/searchSearch usersGET/api/v1/users/statsGet user statsGET/api/v1/users/{id}Get userPUT/api/v1/users/{id}Update userDELETE/api/v1/users/{id}Delete userDELETE/api/v1/users/{id}/2fa/disableDisable user 2FAPOST/api/v1/users/{id}/2fa/enableEnable user 2FAGET/api/v1/users/{id}/activityGet user activityPOST/api/v1/users/{id}/avatarUpload user avatarDELETE/api/v1/users/{id}/avatarDelete user avatarPUT/api/v1/users/{id}/passwordChange user passwordGET/api/v1/users/{id}/permissionsGet user effective permissionsGET/api/v1/users/{id}/preferencesGet user preferencesPUT/api/v1/users/{id}/preferencesUpdate user preferencesGET/api/v1/users/{id}/rolesList user rolesPOST/api/v1/users/{id}/rolesAssign user rolesPUT/api/v1/users/{id}/rolesReplace user rolesDELETE/api/v1/users/{id}/rolesRemove user rolesGET/api/v1/users/{id}/teamsList user teamsPOST/api/v1/users/{id}/teamsAdd user to team (route currently mapped to user create)DELETE/api/v1/users/{id}/teams/{teamId}Remove user from team (route currently mapped to user delete)

Accounting

POST/api/accounting/csv/exportPOST accountingPOST/api/accounting/csv/import/taxPOST accountingGET/api/accounting/csv/import/tax/historyGET accountingPOST/api/accounting/csv/import/tax/rollback/{importId}POST accountingGET/api/accounting/csv/import/tax/templateGET accountingGET/api/accounting/exportsGET accountingPOST/api/accounting/exportsPOST accountingPOST/api/accounting/exports/locks/invoice/resetPOST accountingPOST/api/accounting/exports/previewPOST accountingGET/api/accounting/exports/{batchId}GET accountingPATCH/api/accounting/exports/{batchId}PATCH accountingPOST/api/accounting/exports/{batchId}/downloadPOST accountingPOST/api/accounting/exports/{batchId}/errorsPOST accountingPOST/api/accounting/exports/{batchId}/executePOST accountingPOST/api/accounting/exports/{batchId}/linesPOST accounting

Accounting Exports

GET/api/v1/accounting-exports/xero-csv/client-exportGET v1POST/api/v1/accounting-exports/xero-csv/client-importPOST v1POST/api/v1/accounting-exports/xero-csv/tax-importPOST v1GET/api/v1/accounting-exports/{batchId}/downloadGET v1

Admin

GET/api/v1/admin/telemetry-settingsGet telemetry settingsPOST/api/v1/admin/telemetry-settingsCheck telemetry settings update status

Ai

POST/api/v1/ai/document-assistPOST v1

Assets

GET/api/v1/assetsList assetsPOST/api/v1/assetsCreate assetPUT/api/v1/assets/bulk-statusBulk update asset statusPUT/api/v1/assets/bulk-updateBulk update assetsDELETE/api/v1/assets/documents/{associationId}Remove asset document associationGET/api/v1/assets/exportExport assetsPUT/api/v1/assets/maintenance/{scheduleId}Update asset maintenance scheduleDELETE/api/v1/assets/maintenance/{scheduleId}Delete asset maintenance scheduleDELETE/api/v1/assets/relationships/{relationshipId}Delete asset relationshipGET/api/v1/assets/searchSearch assetsGET/api/v1/assets/statsGet asset statisticsGET/api/v1/assets/{id}Get asset detailsPUT/api/v1/assets/{id}Update assetDELETE/api/v1/assets/{id}Delete assetGET/api/v1/assets/{id}/documentsList asset document associationsPOST/api/v1/assets/{id}/documentsAssociate document with assetGET/api/v1/assets/{id}/historyList asset maintenance historyGET/api/v1/assets/{id}/maintenanceList asset maintenance schedulesPOST/api/v1/assets/{id}/maintenanceCreate asset maintenance schedulePOST/api/v1/assets/{id}/maintenance/recordRecord asset maintenanceGET/api/v1/assets/{id}/relationshipsList asset relationshipsPOST/api/v1/assets/{id}/relationshipsCreate asset relationshipGET/api/v1/assets/{id}/notesGET v1PUT/api/v1/assets/{id}/notesPUT v1DELETE/api/v1/assets/{id}/notesDELETE v1GET/api/v1/assets/{id}/rmmGET v1POST/api/v1/assets/{id}/rmm/rebootPOST v1POST/api/v1/assets/{id}/rmm/refreshPOST v1GET/api/v1/assets/{id}/rmm/remote-controlGET v1POST/api/v1/assets/{id}/rmm/scriptPOST v1GET/api/v1/assets/{id}/softwareGET v1GET/api/v1/assets/{id}/summaryGET v1

Auth

GET/api/auth/google/callbackHandle Google OAuth callbackGET/api/auth/microsoft/callbackHandle Microsoft OAuth callbackGET/api/auth/{nextauth}Handle NextAuth GET actionPOST/api/auth/{nextauth}Handle NextAuth POST actionGET/api/auth/sessionGet current Auth.js sessionPOST/api/auth/validate-api-keyValidate API keyPOST/api/auth/validate-tokenValidate session tokenGET/api/auth/e2e/google/authorizeGET authGET/api/auth/e2e/google/completeGET authPOST/api/auth/e2e/google/tokenPOST authGET/api/auth/e2e/google/userinfoGET authGET/api/auth/google/calendar/callbackGET authGET/api/auth/microsoft/calendar/callbackGET authGET/api/auth/microsoft/entra/callbackGET authPOST/api/auth/msp/remember-emailPOST authPOST/api/auth/msp/sso/discoverPOST authPOST/api/auth/msp/sso/resolvePOST authGET/api/auth/sessionsGET authDELETE/api/auth/sessionsDELETE authGET/api/auth/sessions/allGET authDELETE/api/auth/sessions/{sessionId}DELETE auth

Automation

GET/api/v1/automation/executionsList automation executionsGET/api/v1/automation/executions/{id}Get automation executionPOST/api/v1/automation/executions/{id}/retryRetry automation executionGET/api/v1/automation/rulesList automation rulesPOST/api/v1/automation/rulesCreate automation ruleGET/api/v1/automation/rules/{id}Get automation rulePUT/api/v1/automation/rules/{id}Update automation ruleDELETE/api/v1/automation/rules/{id}Delete automation rulePOST/api/v1/automation/rules/{id}/executeExecute automation rule manuallyPOST/api/v1/automation/rules/bulk-statusBulk update automation rule statusPOST/api/v1/automation/rules/bulk-executeBulk execute automation rulesGET/api/v1/automation/templatesList automation templatesPOST/api/v1/automation/templatesCreate automation template from ruleGET/api/v1/automation/templates/{id}Get automation templatePOST/api/v1/automation/templates/{id}/useCreate automation rule from templateGET/api/v1/automation/statisticsGet automation statisticsGET/api/v1/automation/performanceGet automation performance metricsGET/api/v1/automation/metaGet automation metadata

Billing

GET/api/billing/licence-countGet tenant licence usagePOST/api/billing/licence-countUpdate tenant licensed user countGET/api/billing/check-tenantGET billingGET/api/v1/billingGET v1

Billing Analytics

GET/api/v1/billing-analytics/overviewGet billing overview analytics

Boards

GET/api/v1/boardsList boardsPOST/api/v1/boardsCreate boardGET/api/v1/boards/{id}Get board by IDPUT/api/v1/boards/{id}Update boardDELETE/api/v1/boards/{id}Delete board

Calendar

GET/api/calendar/appointment/{id}GET calendarGET/api/calendar/webhooks/googleGET calendarPOST/api/calendar/webhooks/googlePOST calendarOPTIONS/api/calendar/webhooks/googleOPTIONS calendarGET/api/calendar/webhooks/microsoftGET calendarPOST/api/calendar/webhooks/microsoftPOST calendarOPTIONS/api/calendar/webhooks/microsoftOPTIONS calendar

Categories

GET/api/v1/categories/searchSearch categoriesGET/api/v1/categories/analyticsGet category analyticsPOST/api/v1/categories/bulk/deleteBulk delete categories

Chat

POST/api/chat/stream/titleGenerate chat title streamGET/api/chat/stream/{slug}Get chat stream placeholderPOST/api/chat/stream/{slug}Stream AI chat responsePOST/api/chat/v1/completionsPOST chatPOST/api/chat/v1/completions/streamPOST chatPOST/api/chat/v1/executePOST chat

Client Contract Lines

GET/api/v1/client-contract-linesList client contract linesPOST/api/v1/client-contract-linesAssign contract line to clientDELETE/api/v1/client-contract-lines/{id}Unassign contract line from client

Client Portal

POST/api/client-portal/domain-sessionPOST client-portalOPTIONS/api/client-portal/domain-sessionOPTIONS client-portal

Clients

GET/api/v1/clientsList clientsPOST/api/v1/clientsCreate clientGET/api/v1/clients/{id}Get clientPUT/api/v1/clients/{id}Update clientDELETE/api/v1/clients/{id}Delete clientGET/api/v1/clients/statsGet client statsGET/api/v1/clients/{id}/contactsList contacts for clientGET/api/v1/clients/{id}/locationsList client locationsPOST/api/v1/clients/{id}/locationsCreate client locationGET/api/clientsGET clients

Comments

GET/api/v1/commentsGET v1

Company Contract Lines

GET/api/v1/company-contract-linesGET v1POST/api/v1/company-contract-linesPOST v1DELETE/api/v1/company-contract-lines/{id}DELETE v1

Contacts

GET/api/v1/contactsList contactsPOST/api/v1/contactsCreate contactGET/api/v1/contacts/{id}Get contactPUT/api/v1/contacts/{id}Update contactDELETE/api/v1/contacts/{id}Delete contactGET/api/v1/contacts/searchSearch contactsGET/api/v1/contacts/exportExport contactsGET/api/v1/contacts/statsGet contact stats

Contract Lines

GET/api/v1/contract-linesList contract linesPOST/api/v1/contract-linesCreate contract lineGET/api/v1/contract-lines/{id}Get contract linePUT/api/v1/contract-lines/{id}Update contract lineDELETE/api/v1/contract-lines/{id}Delete contract linePOST/api/v1/contract-lines/bulkBulk create contract linesPUT/api/v1/contract-lines/bulkBulk update contract linesDELETE/api/v1/contract-lines/bulkBulk delete contract linesPOST/api/v1/contract-lines/bulk/createBulk create contract lines (explicit route)PUT/api/v1/contract-lines/bulk/updateBulk update contract lines (explicit route)DELETE/api/v1/contract-lines/bulk/deleteBulk delete contract lines (explicit route)POST/api/v1/contract-lines/bulk/add-servicesBulk add services to contract lineDELETE/api/v1/contract-lines/bulk/remove-servicesBulk remove services from contract linePUT/api/v1/contract-lines/{id}/activationSet contract line activationGET/api/v1/contract-lines/{id}/analyticsGet contract line analyticsPOST/api/v1/contract-lines/{id}/copyCopy contract lineGET/api/v1/contract-lines/{id}/fixed-configGet fixed contract line configPUT/api/v1/contract-lines/{id}/fixed-configUpsert fixed contract line configGET/api/v1/contract-lines/{id}/servicesList contract line servicesPOST/api/v1/contract-lines/{id}/servicesAdd service to contract lineGET/api/v1/contract-lines/{id}/services/{serviceId}Get contract line service detailsPUT/api/v1/contract-lines/{id}/services/{serviceId}Update contract line serviceDELETE/api/v1/contract-lines/{id}/services/{serviceId}Remove service from contract lineGET/api/v1/contract-lines/{id}/usage-metricsGet contract line usage metricsPOST/api/v1/contract-line-templatesCreate contract line templatePOST/api/v1/contract-line-templates/{id}/create-contract-lineCreate contract line from template

Documents

GET/api/documents/download/{fileId}Download or export document fileGET/api/documents/{documentId}/downloadDownload document attachmentGET/api/documents/view/{fileId}View document file inlineGET/api/documents/{documentId}/contentGET documentsGET/api/documents/{documentId}/previewGET documentsGET/api/documents/{documentId}/thumbnailGET documentsGET/api/v1/documentsGET v1

Email

POST/api/email/oauth/initiateInitiate email OAuth flowPOST/api/email/refresh-watchRefresh Gmail watch registrationPOST/api/email/webhooks/googleReceive Google Gmail Pub/Sub webhookOPTIONS/api/email/webhooks/googleCORS preflight for Google email webhookGET/api/email/webhooks/microsoftValidate Microsoft email webhook subscriptionPOST/api/email/webhooks/microsoftReceive Microsoft Graph email webhookOPTIONS/api/email/webhooks/microsoftCORS preflight for Microsoft email webhookPOST/api/email/webhooks/testPublish test inbound email eventPOST/api/email/imap/reconnectPOST emailPOST/api/email/imap/resyncPOST emailGET/api/email/oauth/imap/callbackGET emailPOST/api/email/oauth/imap/initiatePOST emailPOST/api/email/webhooks/imapPOST emailPOST/api/email/webhooks/resendPOST emailGET/api/v1/emailGET v1

Ext

OPTIONS/api/ext/{extensionId}/{path}OPTIONS ext

Ext Bundles

POST/api/ext-bundles/abortPOST ext-bundlesPOST/api/ext-bundles/finalizePOST ext-bundlesPOST/api/ext-bundles/upload-proxyPOST ext-bundles

Ext Debug

GET/api/ext-debug/streamGET ext-debugPOST/api/ext-debug/streamPOST ext-debug

Ext Proxy

GET/api/ext-proxy/{extensionId}/{path}GET ext-proxyPOST/api/ext-proxy/{extensionId}/{path}POST ext-proxyPUT/api/ext-proxy/{extensionId}/{path}PUT ext-proxyPATCH/api/ext-proxy/{extensionId}/{path}PATCH ext-proxyDELETE/api/ext-proxy/{extensionId}/{path}DELETE ext-proxy

Extension Gateway

GET/api/ext/{extensionId}/{path}Forward GET request to extension runnerPOST/api/ext/{extensionId}/{path}Forward POST request to extension runnerPUT/api/ext/{extensionId}/{path}Forward PUT request to extension runnerPATCH/api/ext/{extensionId}/{path}Forward PATCH request to extension runnerDELETE/api/ext/{extensionId}/{path}Forward DELETE request to extension runner

Extension Installs

GET/api/installs/lookup-by-hostLookup extension install by runner hostGET/api/installs/validateValidate extension bundle content hash

Extensions

POST/api/v1/extensions/installPOST v1POST/api/v1/extensions/uninstallPOST v1

Files

GET/api/files/{fileId}/downloadDownload file by ID

Financial

POST/api/v1/financial/billing/calculateCalculate client billing chargesGET/api/v1/financial/billing/payment-termsList billing payment termsPOST/api/v1/financial/bulk/invoicesRun bulk invoice operationPOST/api/v1/financial/bulk/transactionsRun bulk transaction operationPOST/api/v1/financial/bulk/creditsRun bulk credit operationGET/api/v1/financial/creditsList credit balances and recordsPOST/api/v1/financial/credits/applyApply credit to invoicePOST/api/v1/financial/credits/prepaymentCreate prepayment invoicePOST/api/v1/financial/credits/transferTransfer credit between clientsPOST/api/v1/financial/credits/validateValidate client credit balanceGET/api/v1/financial/invoicesList financial invoices (transaction list wiring)POST/api/v1/financial/invoices/{id}/finalizeFinalize financial invoice (maps to generic update)POST/api/v1/financial/invoices/{id}/itemsAdd financial invoice item (maps to generic create)GET/api/v1/financial/payment-methodsList payment methods (transaction list wiring)POST/api/v1/financial/payment-methodsCreate payment methodGET/api/v1/financial/payment-methods/{id}Get payment method by id (transaction get wiring)PUT/api/v1/financial/payment-methods/{id}Update payment method by id (transaction update wiring)DELETE/api/v1/financial/payment-methods/{id}Delete payment method by id (transaction delete wiring)POST/api/v1/financial/reconciliation/runRun financial reconciliationPOST/api/v1/financial/reconciliation/{id}/resolveResolve reconciliation reportGET/api/v1/financial/reports/agingGet aging reportGET/api/v1/financial/reports/analyticsGet financial analyticsGET/api/v1/financial/reports/balanceGet account balance reportPOST/api/v1/financial/tax/calculateCalculate financial taxGET/api/v1/financial/tax/ratesList financial tax rates (transaction list wiring)GET/api/v1/financial/transactionsList financial transactionsPOST/api/v1/financial/transactionsCreate financial transactionGET/api/v1/financial/transactions/{id}Get financial transaction by idPUT/api/v1/financial/transactions/{id}Update financial transactionGET/api/v1/financialGET v1

Import

POST/api/import/approvePOST importGET/api/import/detailsGET importGET/api/import/historyGET importGET/api/import/mappingGET importPOST/api/import/previewPOST importGET/api/import/sourcesGET import

Integrations

GET/api/integrations/entraGET integrationsOPTIONS/api/integrations/entraOPTIONS integrationsPOST/api/integrations/entra/connectPOST integrationsOPTIONS/api/integrations/entra/connectOPTIONS integrationsPOST/api/integrations/entra/disconnectPOST integrationsOPTIONS/api/integrations/entra/disconnectOPTIONS integrationsPOST/api/integrations/entra/discoveryPOST integrationsOPTIONS/api/integrations/entra/discoveryOPTIONS integrationsPOST/api/integrations/entra/mappings/confirmPOST integrationsOPTIONS/api/integrations/entra/mappings/confirmOPTIONS integrationsGET/api/integrations/entra/mappings/previewGET integrationsOPTIONS/api/integrations/entra/mappings/previewOPTIONS integrationsPOST/api/integrations/entra/mappings/remapPOST integrationsOPTIONS/api/integrations/entra/mappings/remapOPTIONS integrationsPOST/api/integrations/entra/mappings/unmapPOST integrationsOPTIONS/api/integrations/entra/mappings/unmapOPTIONS integrationsPOST/api/integrations/entra/syncPOST integrationsOPTIONS/api/integrations/entra/syncOPTIONS integrationsGET/api/integrations/entra/sync/runsGET integrationsOPTIONS/api/integrations/entra/sync/runsOPTIONS integrationsGET/api/integrations/entra/sync/runs/{runId}GET integrationsOPTIONS/api/integrations/entra/sync/runs/{runId}OPTIONS integrationsPOST/api/integrations/entra/validate-cippPOST integrationsOPTIONS/api/integrations/entra/validate-cippOPTIONS integrationsPOST/api/integrations/entra/validate-directPOST integrationsOPTIONS/api/integrations/entra/validate-directOPTIONS integrationsGET/api/integrations/ninjaone/callbackGET integrationsGET/api/integrations/xero/callbackGET integrationsGET/api/integrations/xero/connectGET integrations

Integrations - QuickBooks

GET/api/integrations/qbo/statusQuickBooks Online status route unavailableGET/api/integrations/qbo/connectStart QuickBooks Online OAuth flowGET/api/integrations/qbo/callbackHandle QuickBooks Online OAuth callback

Internal

POST/api/internal/check-tenant-emailPOST internalPOST/api/internal/ext-clients/install/{installId}POST internalPOST/api/internal/ext-invoicing/install/{installId}POST internalPOST/api/internal/ext-runner/install-configPOST internalPOST/api/internal/ext-scheduler/install/{installId}POST internalPOST/api/internal/ext-services/install/{installId}POST internalPOST/api/internal/ext-storage/install/{installId}POST internal

Invoices

GET/api/v1/invoicesList invoicesPOST/api/v1/invoicesCreate invoiceGET/api/v1/invoices/analyticsGet invoice analyticsPOST/api/v1/invoices/bulkBulk update invoice statusPOST/api/v1/invoices/bulk/creditBulk apply invoice creditsPOST/api/v1/invoices/bulk/deleteBulk delete invoicesPOST/api/v1/invoices/bulk/sendBulk send invoicesGET/api/v1/invoices/exportExport invoicesPOST/api/v1/invoices/generateGenerate recurring invoicePOST/api/v1/invoices/manualCreate manual invoicePOST/api/v1/invoices/previewPreview recurring invoiceGET/api/v1/invoices/recurringList recurring invoice templatesPOST/api/v1/invoices/recurringCreate recurring invoice templatePUT/api/v1/invoices/recurring/{id}Update recurring invoice templateDELETE/api/v1/invoices/recurring/{id}Delete recurring invoice templateGET/api/v1/invoices/searchSearch invoicesGET/api/v1/invoices/{id}Get invoice by idPUT/api/v1/invoices/{id}Update invoiceDELETE/api/v1/invoices/{id}Delete invoicePOST/api/v1/invoices/{id}/approveApprove invoicePOST/api/v1/invoices/{id}/creditApply credit to invoicePOST/api/v1/invoices/{id}/duplicateDuplicate invoicePOST/api/v1/invoices/{id}/finalizeFinalize invoicePOST/api/v1/invoices/{id}/paymentRecord invoice paymentPOST/api/v1/invoices/{id}/rejectReject invoicePOST/api/v1/invoices/{id}/sendSend invoicePOST/api/v1/invoices/{id}/taxCalculate invoice taxGET/api/v1/invoices/{id}/itemsList invoice itemsGET/api/v1/invoices/{id}/transactionsList invoice transactionsGET/api/v1/invoices/{id}/pdfRedirect to invoice PDF downloadPOST/api/v1/invoices/{id}/pdfGenerate invoice PDF asset

Kb Articles

GET/api/v1/kb-articlesGET v1POST/api/v1/kb-articlesPOST v1GET/api/v1/kb-articles/categoriesGET v1POST/api/v1/kb-articles/from-ticket/{ticketId}POST v1GET/api/v1/kb-articles/templatesGET v1GET/api/v1/kb-articles/{id}GET v1PUT/api/v1/kb-articles/{id}PUT v1DELETE/api/v1/kb-articles/{id}DELETE v1POST/api/v1/kb-articles/{id}/archivePOST v1GET/api/v1/kb-articles/{id}/contentGET v1PUT/api/v1/kb-articles/{id}/contentPUT v1POST/api/v1/kb-articles/{id}/publishPOST v1

Meta & Utility v1

POST/api/v1/feature-accessCheck feature accessGET/api/v1/feature-flagsGet feature flagsPOST/api/v1/feature-flagsEvaluate feature flags with custom contextGET/api/v1/meta/docsGet API docsGET/api/v1/meta/endpointsList API endpoints metadataGET/api/v1/meta/healthGet API health metadataGET/api/v1/meta/openapiGet generated OpenAPI metadataGET/api/v1/meta/permissionsList API permissions metadataGET/api/v1/meta/schemasList API schemas metadataGET/api/v1/meta/sdkGenerate SDK metadata payloadGET/api/v1/meta/statsGet API stats metadataGET/api/v1/test-authTest API key authGET/api/v1/user/telemetry-decisionGet telemetry decisionGET/api/v1/user/telemetry-preferencesGet telemetry preferencesPOST/api/v1/user/telemetry-preferencesSet telemetry preferences (environment-controlled)DELETE/api/v1/user/telemetry-preferencesDelete telemetry preferences (environment-controlled)

Mobile

POST/api/v1/mobile/account/deletePOST v1POST/api/v1/mobile/auth/applePOST v1GET/api/v1/mobile/auth/apple/linkGET v1POST/api/v1/mobile/auth/apple/linkPOST v1DELETE/api/v1/mobile/auth/apple/linkDELETE v1POST/api/v1/mobile/auth/apple/notificationsPOST v1GET/api/v1/mobile/auth/capabilitiesGET v1POST/api/v1/mobile/auth/exchangePOST v1POST/api/v1/mobile/auth/refreshPOST v1POST/api/v1/mobile/auth/revokePOST v1POST/api/v1/mobile/iap/check-emailPOST v1POST/api/v1/mobile/iap/notificationsPOST v1POST/api/v1/mobile/iap/provisionPOST v1POST/api/v1/mobile/iap/restorePOST v1GET/api/v1/mobile/moderation/mutesGET v1POST/api/v1/mobile/moderation/mutesPOST v1DELETE/api/v1/mobile/moderation/mutes/{userId}DELETE v1POST/api/v1/mobile/moderation/reportPOST v1PUT/api/v1/mobile/push-tokenPUT v1DELETE/api/v1/mobile/push-tokenDELETE v1

Platform Feature Flags

GET/api/v1/platform-feature-flagsGET v1POST/api/v1/platform-feature-flagsPOST v1OPTIONS/api/v1/platform-feature-flagsOPTIONS v1GET/api/v1/platform-feature-flags/{flagId}GET v1POST/api/v1/platform-feature-flags/{flagId}POST v1PATCH/api/v1/platform-feature-flags/{flagId}PATCH v1DELETE/api/v1/platform-feature-flags/{flagId}DELETE v1OPTIONS/api/v1/platform-feature-flags/{flagId}OPTIONS v1POST/api/v1/platform-feature-flags/{flagId}/tenantsPOST v1OPTIONS/api/v1/platform-feature-flags/{flagId}/tenantsOPTIONS v1

Platform Notifications

GET/api/v1/platform-notificationsGET v1POST/api/v1/platform-notificationsPOST v1OPTIONS/api/v1/platform-notificationsOPTIONS v1POST/api/v1/platform-notifications/resolve-recipientsPOST v1OPTIONS/api/v1/platform-notifications/resolve-recipientsOPTIONS v1GET/api/v1/platform-notifications/{notificationId}GET v1POST/api/v1/platform-notifications/{notificationId}POST v1PUT/api/v1/platform-notifications/{notificationId}PUT v1DELETE/api/v1/platform-notifications/{notificationId}DELETE v1OPTIONS/api/v1/platform-notifications/{notificationId}OPTIONS v1GET/api/v1/platform-notifications/{notificationId}/readsGET v1OPTIONS/api/v1/platform-notifications/{notificationId}/readsOPTIONS v1GET/api/v1/platform-notifications/{notificationId}/statsGET v1OPTIONS/api/v1/platform-notifications/{notificationId}/statsOPTIONS v1

Platform Reports

GET/api/v1/platform-reportsGET v1POST/api/v1/platform-reportsPOST v1OPTIONS/api/v1/platform-reportsOPTIONS v1POST/api/v1/platform-reports/accessPOST v1OPTIONS/api/v1/platform-reports/accessOPTIONS v1GET/api/v1/platform-reports/auditGET v1OPTIONS/api/v1/platform-reports/auditOPTIONS v1GET/api/v1/platform-reports/schemaGET v1OPTIONS/api/v1/platform-reports/schemaOPTIONS v1GET/api/v1/platform-reports/{reportId}GET v1POST/api/v1/platform-reports/{reportId}POST v1PUT/api/v1/platform-reports/{reportId}PUT v1DELETE/api/v1/platform-reports/{reportId}DELETE v1OPTIONS/api/v1/platform-reports/{reportId}OPTIONS v1POST/api/v1/platform-reports/{reportId}/executePOST v1OPTIONS/api/v1/platform-reports/{reportId}/executeOPTIONS v1

Priorities

GET/api/v1/prioritiesGET v1GET/api/v1/priorities/{id}GET v1

Products

GET/api/v1/productsList productsPOST/api/v1/productsCreate productGET/api/v1/products/{id}Get productPUT/api/v1/products/{id}Update productDELETE/api/v1/products/{id}Delete product

Projects

GET/api/v1/projects/{id}/task-status-mappingsList project task status mappingsGET/api/v1/projects/{id}/tasksList project tasksGET/api/v1/projects/{id}/phases/{phaseId}/tasksList project phase tasksPOST/api/v1/projects/{id}/phases/{phaseId}/tasksCreate project phase taskGET/api/v1/projects/tasks/{taskId}Get project taskPUT/api/v1/projects/tasks/{taskId}Update project taskDELETE/api/v1/projects/tasks/{taskId}Delete project taskGET/api/projectsGET projectsGET/api/projects/templatesGET projectsPOST/api/projects/templatesPOST projectsGET/api/projects/templates/categoriesGET projectsGET/api/projects/templates/{templateId}GET projectsPATCH/api/projects/templates/{templateId}PATCH projectsDELETE/api/projects/templates/{templateId}DELETE projectsPOST/api/projects/templates/{templateId}/applyPOST projectsPOST/api/projects/templates/{templateId}/duplicatePOST projects

Public

POST/api/public/appointment-requestPOST publicGET/api/public/appointment-request/available-datesGET publicGET/api/public/appointment-request/available-servicesGET publicGET/api/public/appointment-request/available-slotsGET public

QuickBooks v1

GET/api/v1/integrations/quickbooks/accountsGet QuickBooks chart of accountsGET/api/v1/integrations/quickbooks/accounts/mappingsList account mappingsPUT/api/v1/integrations/quickbooks/accounts/mappingsConfigure account mappingsPOST/api/v1/integrations/quickbooks/connection/refreshRefresh QuickBooks connection tokensGET/api/v1/integrations/quickbooks/connection/statusGet QuickBooks connection statusPOST/api/v1/integrations/quickbooks/connection/testRun QuickBooks connection testGET/api/v1/integrations/quickbooks/customers/mappingsList customer mappingsDELETE/api/v1/integrations/quickbooks/customers/mappings/{mapping_id}Delete customer mappingPOST/api/v1/integrations/quickbooks/customers/syncSync customersPOST/api/v1/integrations/quickbooks/diagnosticsRun QuickBooks diagnosticsGET/api/v1/integrations/quickbooks/healthGet integration healthGET/api/v1/integrations/quickbooks/health/configGet health monitoring configPUT/api/v1/integrations/quickbooks/health/configUpdate health monitoring configPOST/api/v1/integrations/quickbooks/invoices/exportExport invoices to QuickBooksPOST/api/v1/integrations/quickbooks/invoices/importImport invoices from QuickBooksGET/api/v1/integrations/quickbooks/itemsList QuickBooks itemsGET/api/v1/integrations/quickbooks/mappingsList data mappingsPOST/api/v1/integrations/quickbooks/mappingsCreate data mappingGET/api/v1/integrations/quickbooks/mappings/{mapping_id}Get data mapping by idPUT/api/v1/integrations/quickbooks/mappings/{mapping_id}Update data mappingDELETE/api/v1/integrations/quickbooks/mappings/{mapping_id}Delete data mappingPOST/api/v1/integrations/quickbooks/oauth/callbackHandle QuickBooks OAuth callback payloadDELETE/api/v1/integrations/quickbooks/oauth/disconnectDisconnect QuickBooks OAuthPOST/api/v1/integrations/quickbooks/oauth/initiateInitiate QuickBooks OAuth flowGET/api/v1/integrations/quickbooks/payment-methodsList QuickBooks payment methodsPOST/api/v1/integrations/quickbooks/payments/syncSync paymentsPOST/api/v1/integrations/quickbooks/sync/bulkRun bulk QuickBooks syncPOST/api/v1/integrations/quickbooks/sync/fullRun full QuickBooks syncGET/api/v1/integrations/quickbooks/sync/historyList sync historyGET/api/v1/integrations/quickbooks/sync/statusGet current sync statusGET/api/v1/integrations/quickbooks/sync/status/{sync_id}Get sync status by idPOST/api/v1/integrations/quickbooks/sync/{sync_id}/cancelCancel sync operationPOST/api/v1/integrations/quickbooks/sync/{sync_id}/retryRetry sync operationGET/api/v1/integrations/quickbooks/tax-codesList QuickBooks tax codesGET/api/v1/integrations/quickbooks/tax-codes/mappingsList tax mappingsPUT/api/v1/integrations/quickbooks/tax-codes/mappingsConfigure tax mappingsGET/api/v1/integrations/quickbooks/termsList QuickBooks termsGET/api/v1/quickbooks/accountsGet QuickBooks chart of accountsGET/api/v1/quickbooks/accounts/mappingsList account mappingsPUT/api/v1/quickbooks/accounts/mappingsConfigure account mappingsPOST/api/v1/quickbooks/connection/refreshRefresh QuickBooks connection tokensGET/api/v1/quickbooks/connection/statusGet QuickBooks connection statusPOST/api/v1/quickbooks/connection/testRun QuickBooks connection testGET/api/v1/quickbooks/customers/mappingsList customer mappingsDELETE/api/v1/quickbooks/customers/mappings/{mapping_id}Delete customer mappingPOST/api/v1/quickbooks/customers/syncSync customersPOST/api/v1/quickbooks/diagnosticsRun QuickBooks diagnosticsGET/api/v1/quickbooks/healthGet integration healthGET/api/v1/quickbooks/health/configGet health monitoring configPUT/api/v1/quickbooks/health/configUpdate health monitoring configPOST/api/v1/quickbooks/invoices/exportExport invoices to QuickBooksPOST/api/v1/quickbooks/invoices/importImport invoices from QuickBooksGET/api/v1/quickbooks/itemsList QuickBooks itemsGET/api/v1/quickbooks/mappingsList data mappingsPOST/api/v1/quickbooks/mappingsCreate data mappingGET/api/v1/quickbooks/mappings/{mapping_id}Get data mapping by idPUT/api/v1/quickbooks/mappings/{mapping_id}Update data mappingDELETE/api/v1/quickbooks/mappings/{mapping_id}Delete data mappingPOST/api/v1/quickbooks/oauth/callbackHandle QuickBooks OAuth callback payloadDELETE/api/v1/quickbooks/oauth/disconnectDisconnect QuickBooks OAuthPOST/api/v1/quickbooks/oauth/initiateInitiate QuickBooks OAuth flowGET/api/v1/quickbooks/payment-methodsList QuickBooks payment methodsPOST/api/v1/quickbooks/payments/syncSync paymentsPOST/api/v1/quickbooks/sync/bulkRun bulk QuickBooks syncPOST/api/v1/quickbooks/sync/fullRun full QuickBooks syncGET/api/v1/quickbooks/sync/historyList sync historyGET/api/v1/quickbooks/sync/statusGet current sync statusGET/api/v1/quickbooks/sync/status/{sync_id}Get sync status by idPOST/api/v1/quickbooks/sync/{sync_id}/cancelCancel sync operationPOST/api/v1/quickbooks/sync/{sync_id}/retryRetry sync operationGET/api/v1/quickbooks/tax-codesList QuickBooks tax codesGET/api/v1/quickbooks/tax-codes/mappingsList tax mappingsPUT/api/v1/quickbooks/tax-codes/mappingsConfigure tax mappingsGET/api/v1/quickbooks/termsList QuickBooks terms

Quotes & Contracts v1

GET/api/v1/quotesList quotesPOST/api/v1/quotesCreate quoteGET/api/v1/quotes/{id}Get quotePUT/api/v1/quotes/{id}Update quoteDELETE/api/v1/quotes/{id}Delete quoteGET/api/v1/quotes/{id}/activitiesList quote activitiesPOST/api/v1/quotes/{id}/approveApprove quotePOST/api/v1/quotes/{id}/convertConvert quoteGET/api/v1/quotes/{id}/convert/previewPreview quote conversionGET/api/v1/quotes/{id}/itemsList quote itemsPOST/api/v1/quotes/{id}/itemsAdd quote itemPUT/api/v1/quotes/{id}/items/{itemId}Update quote itemDELETE/api/v1/quotes/{id}/items/{itemId}Delete quote itemPOST/api/v1/quotes/{id}/items/reorderReorder quote itemsPOST/api/v1/quotes/{id}/remindSend quote reminderPOST/api/v1/quotes/{id}/request-changesRequest quote changesPOST/api/v1/quotes/{id}/resendResend quoteGET/api/v1/quotes/{id}/revisionsList quote revisionsPOST/api/v1/quotes/{id}/revisionsCreate quote revisionPOST/api/v1/quotes/{id}/sendSend quotePOST/api/v1/quotes/{id}/submit-for-approvalSubmit quote for approvalGET/api/v1/contractsList contractsPOST/api/v1/contractsCreate contractPOST/api/v1/contracts/{contractId}/contract-linesAttach contract lineDELETE/api/v1/contracts/{contractId}/contract-lines/{contractLineId}Detach contract line

Secrets

GET/api/secretsGET secretsPOST/api/secretsPOST secretsGET/api/secrets/{name}GET secretsPATCH/api/secrets/{name}PATCH secretsDELETE/api/secrets/{name}DELETE secretsHEAD/api/secrets/{name}HEAD secrets

Service Categories

GET/api/v1/categories/serviceList service categoriesPOST/api/v1/categories/serviceCreate service categoryGET/api/v1/categories/service/{id}Get service categoryPUT/api/v1/categories/service/{id}Update service categoryDELETE/api/v1/categories/service/{id}Delete service category

Service Types

GET/api/v1/service-typesList service typesGET/api/v1/service-types/{id}Get service type

Services

GET/api/v1/servicesList servicesPOST/api/v1/servicesCreate serviceGET/api/v1/services/{id}Get servicePUT/api/v1/services/{id}Update serviceDELETE/api/v1/services/{id}Delete service

Share

GET/api/share/{token}GET shareGET/api/share/{token}/infoGET share

Software

GET/api/v1/software/searchGET v1

SoftwareOne Extensions

GET/api/extensions/softwareone/agreementsList SoftwareOne agreementsPOST/api/extensions/softwareone/agreementsSync SoftwareOne agreementsGET/api/extensions/softwareone/agreements/{id}Get SoftwareOne agreementGET/api/extensions/softwareone/statementsList SoftwareOne statementsPOST/api/extensions/softwareone/statementsSync SoftwareOne statementsGET/api/extensions/softwareone/statements/{id}Get SoftwareOne statementGET/api/extensions/softwareone/statements/{id}/chargesList SoftwareOne statement chargesPOST/api/extensions/softwareone/syncSync SoftwareOne dataGET/api/extensions/{extensionId}/agreementsList agreements for extensionGET/api/extensions/{extensionId}/agreements/{id}Get agreement for extensionGET/api/extensions/{extensionId}/statementsList statements for extensionGET/api/extensions/{extensionId}/statements/{id}Get statement for extensionGET/api/extensions/{extensionId}/statements/{id}/chargesList charges for extension statementPOST/api/extensions/{extensionId}/syncSync extension data

Statuses

GET/api/v1/statusesList statusesPOST/api/v1/statusesCreate statusGET/api/v1/statuses/{id}Get status by IDPUT/api/v1/statuses/{id}Update statusDELETE/api/v1/statuses/{id}Delete status

Storage

GET/api/v1/storage/namespaces/{namespace}/recordsList records in a namespacePOST/api/v1/storage/namespaces/{namespace}/recordsBulk insert or update recordsGET/api/v1/storage/namespaces/{namespace}/records/{key}Get a record by keyPUT/api/v1/storage/namespaces/{namespace}/records/{key}Create or update a record by keyDELETE/api/v1/storage/namespaces/{namespace}/records/{key}Delete a record by key

System

GET/api/healthHealth checkGET/api/healthzLiveness probeGET/api/readyzReadiness probe

Teams

GET/api/teams/auth/callback/botGET teamsOPTIONS/api/teams/auth/callback/botOPTIONS teamsGET/api/teams/auth/callback/message-extensionGET teamsOPTIONS/api/teams/auth/callback/message-extensionOPTIONS teamsGET/api/teams/auth/callback/tabGET teamsOPTIONS/api/teams/auth/callback/tabOPTIONS teamsPOST/api/teams/bot/messagesPOST teamsOPTIONS/api/teams/bot/messagesOPTIONS teamsPOST/api/teams/message-extension/queryPOST teamsOPTIONS/api/teams/message-extension/queryOPTIONS teamsGET/api/teams/packageGET teamsPOST/api/teams/packagePOST teamsOPTIONS/api/teams/packageOPTIONS teamsGET/api/teams/package/downloadGET teamsOPTIONS/api/teams/package/downloadOPTIONS teamsPOST/api/teams/quick-actionsPOST teamsOPTIONS/api/teams/quick-actionsOPTIONS teams

Tenant Management

GET/api/v1/tenant-management/auditGET v1POST/api/v1/tenant-management/confirm-deletionPOST v1POST/api/v1/tenant-management/create-tenantPOST v1POST/api/v1/tenant-management/export-tenantPOST v1GET/api/v1/tenant-management/exportsGET v1POST/api/v1/tenant-management/exports/{exportId}/download-urlPOST v1GET/api/v1/tenant-management/pending-deletionsGET v1POST/api/v1/tenant-management/resend-welcome-emailPOST v1POST/api/v1/tenant-management/rollback-deletionPOST v1POST/api/v1/tenant-management/start-deletionPOST v1POST/api/v1/tenant-management/start-premium-trialPOST v1GET/api/v1/tenant-management/tenantsGET v1

Ticket Categories

GET/api/v1/categories/ticketList ticket categoriesPOST/api/v1/categories/ticketCreate ticket categoryGET/api/v1/categories/ticket/{id}Get ticket categoryPUT/api/v1/categories/ticket/{id}Update ticket categoryDELETE/api/v1/categories/ticket/{id}Delete ticket categoryGET/api/v1/categories/ticket/treeGet ticket category tree (implicit board id)GET/api/v1/categories/ticket/tree/{boardId}Get ticket category tree by boardPOST/api/v1/categories/ticket/moveMove ticket category in hierarchy

Tickets

GET/api/v1/tickets/from-assetGET v1GET/api/v1/tickets/prioritiesGET v1GET/api/v1/tickets/statusesGET v1PUT/api/v1/tickets/{id}/comments/{commentId}PUT v1POST/api/v1/tickets/{id}/comments/{commentId}/reactionsPOST v1GET/api/v1/tickets/{id}/documentsGET v1POST/api/v1/tickets/{id}/documentsPOST v1GET/api/v1/tickets/{id}/documents/{documentId}GET v1DELETE/api/v1/tickets/{id}/documents/{documentId}DELETE v1GET/api/v1/tickets/{id}/materialsGET v1POST/api/v1/tickets/{id}/materialsPOST v1

Webhooks

GET/api/v1/webhooksList webhooksPOST/api/v1/webhooksCreate webhookGET/api/v1/webhooks/analyticsGet system webhook analyticsGET/api/v1/webhooks/eventsList available webhook eventsGET/api/v1/webhooks/templatesList webhook templatesPOST/api/v1/webhooks/templatesCreate webhook templateGET/api/v1/webhooks/templates/{id}Get webhook template detail (webhook getById wiring)PUT/api/v1/webhooks/templates/{id}Update webhook template (webhook update wiring)DELETE/api/v1/webhooks/templates/{id}Delete webhook template (webhook delete wiring)POST/api/v1/webhooks/templates/{id}/createCreate webhook from templatePOST/api/v1/webhooks/testTest webhook configurationPOST/api/v1/webhooks/verifyVerify webhook signatureGET/api/v1/webhooks/{id}Get webhookPUT/api/v1/webhooks/{id}Update webhookDELETE/api/v1/webhooks/{id}Delete webhookGET/api/v1/webhooks/{id}/analyticsGet webhook analyticsGET/api/v1/webhooks/{id}/deliveriesList webhook deliveriesGET/api/v1/webhooks/{id}/deliveries/{delivery_id}Get delivery detailPOST/api/v1/webhooks/{id}/deliveries/{delivery_id}/retryRetry deliveryGET/api/v1/webhooks/{id}/healthGet webhook healthPOST/api/v1/webhooks/{id}/secret/rotateRotate webhook secretGET/api/v1/webhooks/{id}/subscriptionsList webhook event subscriptionsPOST/api/v1/webhooks/{id}/testTest webhook by idGET/api/webhooks/ninjaoneGET webhooksPOST/api/webhooks/ninjaonePOST webhooksOPTIONS/api/webhooks/ninjaoneOPTIONS webhooksPOST/api/webhooks/stripePOST webhooksPOST/api/webhooks/stripe/paymentsPOST webhooksPOST/api/webhooks/tacticalrmmPOST webhooksOPTIONS/api/webhooks/tacticalrmmOPTIONS webhooks

Work Management v1

GET/api/v1/projectsList projectsPOST/api/v1/projectsCreate projectPUT/api/v1/projects/bulk-assignBulk assign projectsPUT/api/v1/projects/bulk-statusBulk update project statusPUT/api/v1/projects/bulk-updateBulk update projectsGET/api/v1/projects/exportExport projectsGET/api/v1/projects/searchSearch projectsGET/api/v1/projects/statsGet project statsGET/api/v1/projects/tasks/{taskId}/checklistList task checklist itemsPOST/api/v1/projects/tasks/{taskId}/checklistCreate task checklist itemGET/api/v1/projects/{id}Get projectPUT/api/v1/projects/{id}Update projectDELETE/api/v1/projects/{id}Delete projectGET/api/v1/projects/{id}/phasesList project phasesPOST/api/v1/projects/{id}/phasesCreate project phasePUT/api/v1/projects/{id}/phases/{phaseId}Update project phaseDELETE/api/v1/projects/{id}/phases/{phaseId}Delete project phaseGET/api/v1/projects/{id}/ticketsList project ticketsGET/api/v1/schedulesList schedule entriesPOST/api/v1/schedulesCreate schedule entryGET/api/v1/schedules/searchSearch schedulesGET/api/v1/schedules/{id}Get schedule entryPUT/api/v1/schedules/{id}Update schedule entryDELETE/api/v1/schedules/{id}Delete schedule entryGET/api/v1/schedules/{id}/conflictsGet schedule conflictsGET/api/v1/tagsList tagsPOST/api/v1/tagsCreate tagGET/api/v1/tags/analyticsGet tag analyticsPOST/api/v1/tags/bulkBulk create tagsDELETE/api/v1/tags/bulkBulk delete tagsPOST/api/v1/tags/bulk/mergeBulk merge tagsPOST/api/v1/tags/bulk/tagBulk tag entitiesDELETE/api/v1/tags/bulk/untagBulk untag entitiesDELETE/api/v1/tags/by-textDelete tags by textGET/api/v1/tags/cloudGet tag cloudGET/api/v1/tags/entity/{entityType}/{entityId}List tags for entityPOST/api/v1/tags/entity/{entityType}/{entityId}Attach tags to entityDELETE/api/v1/tags/entity/{entityType}/{entityId}Remove tags from entityGET/api/v1/tags/searchSearch tagsGET/api/v1/tags/{id}Get tagPUT/api/v1/tags/{id}Update tagDELETE/api/v1/tags/{id}Delete tagPUT/api/v1/tags/{id}/colorsUpdate tag colorsPUT/api/v1/tags/{id}/textUpdate tag textGET/api/v1/ticketsList ticketsPOST/api/v1/ticketsCreate ticketPOST/api/v1/tickets/from-assetCreate ticket from assetGET/api/v1/tickets/searchSearch ticketsGET/api/v1/tickets/statsGet ticket statsGET/api/v1/tickets/{id}Get ticketPUT/api/v1/tickets/{id}Update ticketDELETE/api/v1/tickets/{id}Delete ticketPUT/api/v1/tickets/{id}/assignmentUpdate ticket assignmentGET/api/v1/tickets/{id}/commentsList ticket commentsPOST/api/v1/tickets/{id}/commentsAdd ticket commentPUT/api/v1/tickets/{id}/statusUpdate ticket statusGET/api/v1/tickets/{id}/time-entriesList ticket time entriesGET/api/v1/time-entriesList time entriesPOST/api/v1/time-entriesCreate time entryGET/api/v1/time-entries/active-sessionGet active tracking sessionPOST/api/v1/time-entries/approveApprove time entriesPOST/api/v1/time-entries/bulkBulk create time entriesPUT/api/v1/time-entries/bulkBulk update time entriesDELETE/api/v1/time-entries/bulkBulk delete time entriesGET/api/v1/time-entries/exportExport time entriesPOST/api/v1/time-entries/request-changesRequest time entry changesGET/api/v1/time-entries/searchSearch time entriesPOST/api/v1/time-entries/start-trackingStart time trackingGET/api/v1/time-entries/statsGet time entry statsPOST/api/v1/time-entries/stop-tracking/{sessionId}Stop time trackingGET/api/v1/time-entries/templatesList time entry templatesGET/api/v1/time-entries/{id}Get time entryPUT/api/v1/time-entries/{id}Update time entryDELETE/api/v1/time-entries/{id}Delete time entryGET/api/v1/time-periodsList time periodsPOST/api/v1/time-periodsCreate time periodGET/api/v1/time-periods/currentGet current time periodGET/api/v1/time-periods/{id}Get time periodPUT/api/v1/time-periods/{id}Update time periodDELETE/api/v1/time-periods/{id}Delete time periodPOST/api/v1/time-periods/{id}/closeClose time periodPOST/api/v1/time-periods/{id}/reopenReopen time periodGET/api/v1/time-sheetsList time sheetsPOST/api/v1/time-sheetsCreate time sheetPOST/api/v1/time-sheets/bulkBulk time sheet operationGET/api/v1/time-sheets/exportExport time sheetsGET/api/v1/time-sheets/searchSearch time sheetsGET/api/v1/time-sheets/{id}Get time sheetPUT/api/v1/time-sheets/{id}Update time sheetDELETE/api/v1/time-sheets/{id}Delete time sheetPOST/api/v1/time-sheets/{id}/add-entryAdd time sheet entryPOST/api/v1/time-sheets/{id}/approveApprove time sheetGET/api/v1/time-sheets/{id}/entriesList time sheet entriesPOST/api/v1/time-sheets/{id}/rejectReject time sheetDELETE/api/v1/time-sheets/{id}/remove-entryRemove time sheet entryPOST/api/v1/time-sheets/{id}/request-changesRequest time sheet changesPOST/api/v1/time-sheets/{id}/reverse-approvalReverse time sheet approvalPOST/api/v1/time-sheets/{id}/submitSubmit time sheetGET/api/v1/time-sheets/{id}/summaryGet time sheet summary

Workflow

GET/api/workflow/eventsGET workflowPOST/api/workflow/eventsPOST workflowGET/api/workflow/events/exportGET workflowGET/api/workflow/events/summaryGET workflowGET/api/workflow/events/{eventId}GET workflowGET/api/workflow/registry/actionsGET workflowGET/api/workflow/registry/designer-catalogGET workflowGET/api/workflow/registry/nodesGET workflowGET/api/workflow/registry/schemas/{schemaRef}GET workflow

Workflow Definitions

GET/api/workflow-definitionsGET workflow-definitionsPOST/api/workflow-definitionsPOST workflow-definitionsPOST/api/workflow-definitions/importPOST workflow-definitionsGET/api/workflow-definitions/{workflowId}/auditGET workflow-definitionsGET/api/workflow-definitions/{workflowId}/audit/exportGET workflow-definitionsGET/api/workflow-definitions/{workflowId}/exportGET workflow-definitionsPUT/api/workflow-definitions/{workflowId}/metadataPUT workflow-definitionsGET/api/workflow-definitions/{workflowId}/versionsGET workflow-definitionsGET/api/workflow-definitions/{workflowId}/{version}GET workflow-definitionsPUT/api/workflow-definitions/{workflowId}/{version}PUT workflow-definitionsPOST/api/workflow-definitions/{workflowId}/{version}/publishPOST workflow-definitions

Workflow Runs

GET/api/workflow-runsGET workflow-runsPOST/api/workflow-runsPOST workflow-runsGET/api/workflow-runs/dead-letterGET workflow-runsGET/api/workflow-runs/exportGET workflow-runsGET/api/workflow-runs/latestGET workflow-runsGET/api/workflow-runs/summaryGET workflow-runsGET/api/workflow-runs/{runId}GET workflow-runsGET/api/workflow-runs/{runId}/auditGET workflow-runsGET/api/workflow-runs/{runId}/audit/exportGET workflow-runsPOST/api/workflow-runs/{runId}/cancelPOST workflow-runsGET/api/workflow-runs/{runId}/exportGET workflow-runsPOST/api/workflow-runs/{runId}/replayPOST workflow-runsPOST/api/workflow-runs/{runId}/requeuePOST workflow-runsPOST/api/workflow-runs/{runId}/resumePOST workflow-runsPOST/api/workflow-runs/{runId}/retryPOST workflow-runsGET/api/workflow-runs/{runId}/stepsGET workflow-runsGET/api/workflow-runs/{runId}/summaryGET workflow-runsGET/api/workflow-runs/{runId}/timelineGET workflow-runs

Workflows v1

GET/api/v1/workflowsList workflows (route inventory only)POST/api/v1/workflowsCreate workflow (route inventory only)GET/api/v1/workflows/analyticsGet workflow analytics (route inventory only)GET/api/v1/workflows/eventsList workflow events (route inventory only)POST/api/v1/workflows/eventsCreate workflow event (route inventory only)GET/api/v1/workflows/events/{id}Get workflow event by id (route inventory only)GET/api/v1/workflows/executionsList workflow executions (route inventory only)POST/api/v1/workflows/executionsCreate workflow execution (route inventory only)POST/api/v1/workflows/executions/bulkBulk create workflow executions (route inventory only)POST/api/v1/workflows/executions/bulk-actionBulk action workflow executions (route inventory only)GET/api/v1/workflows/executions/{id}Get workflow execution by id (route inventory only)PUT/api/v1/workflows/executions/{id}Update workflow execution (route inventory only)POST/api/v1/workflows/executions/{id}/cancelCancel workflow execution (route inventory only)POST/api/v1/workflows/executions/{id}/pausePause workflow execution (route inventory only)POST/api/v1/workflows/executions/{id}/restartRestart workflow execution (route inventory only)POST/api/v1/workflows/executions/{id}/resumeResume workflow execution (route inventory only)GET/api/v1/workflows/exportExport workflows (route inventory only)POST/api/v1/workflows/importImport workflows (route inventory only)GET/api/v1/workflows/searchSearch workflows (route inventory only)GET/api/v1/workflows/tasksList workflow tasks (route inventory only)POST/api/v1/workflows/tasksCreate workflow task (route inventory only)POST/api/v1/workflows/tasks/bulk-assignBulk assign workflow tasks (route inventory only)GET/api/v1/workflows/tasks/{id}Get workflow task by id (route inventory only)PUT/api/v1/workflows/tasks/{id}Update workflow task (route inventory only)POST/api/v1/workflows/tasks/{id}/claimClaim workflow task (route inventory only)POST/api/v1/workflows/tasks/{id}/completeComplete workflow task (route inventory only)GET/api/v1/workflows/templatesList workflow templates (route inventory only)POST/api/v1/workflows/templatesCreate workflow template (route inventory only)GET/api/v1/workflows/templates/{id}Get workflow template by id (route inventory only)PUT/api/v1/workflows/templates/{id}Update workflow template (route inventory only)DELETE/api/v1/workflows/templates/{id}Delete workflow template (route inventory only)GET/api/v1/workflows/{id}Get workflow by id (route inventory only)PUT/api/v1/workflows/{id}Update workflow (route inventory only)DELETE/api/v1/workflows/{id}Delete workflow by id (route inventory only)