Traceline.
Sign in Request demo
ProductAsset LifecycleProcurementInventoryCommercialMobileReportingSecurity
Product Tour
SolutionsManufacturingHealthcareEducationGovernmentITWarehousing
Pricing
ResourcesDocumentationAPIRelease notesKnowledge baseFAQ
CompanyAboutContact
Sign inRequest demo

Developers

API reference

391 operations across 28 areas, version 1.1.0 — generated from the server's route table, so an endpoint cannot exist and be missing here. The machine-readable OpenAPI 3.1 document is at /api/public/openapi.json.

Authentication at a glance

  • Public — no token. Registration, pricing, recovery, and the per-tenant SSO doors.
  • Tenant token — a sess_… bearer from POST /api/auth/login, or a scoped API key (tlk_…) minted in the console.
  • Operator token — a psess_… bearer from the platform plane; refused everywhere else.
  • SCIM token — minted at POST /api/identity/scim-tokens, pasted into your IdP, valid only under /scim/v2.

Operations · Platform - administration · Platform - authentication · Platform - backup and restore · Platform - operator security · Platform - organisations · Public - registration, pricing and recovery · Public - single sign-on · SCIM provisioning · Tenant - account and billing · Tenant - administration · Tenant - allocation and custody · Tenant - approvals · Tenant - assets and scanning · Tenant - assistant · Tenant - authentication · Tenant - depreciation and periods · Tenant - estate import · Tenant - identity administration · Tenant - inventory · Tenant - ledger integrity and signing · Tenant - maintenance and repair · Tenant - master data · Tenant - notifications and jobs · Tenant - offline sync and desktop · Tenant - procurement · Tenant - reporting and search · Tenant - service contracts and AMC

Operations · 3

MethodPathAuth
GET/api/healthPublic
GET/api/health/deepToken if configured
GET/metricsToken if configured

Platform - administration · 47

MethodPathAuth
GET/api/platform/billingOperator token
GET/api/platform/billing-periodsOperator token
PATCH/api/platform/billing-periods/{code}Operator token
POST/api/platform/billing/run-cycleOperator token
GET/api/platform/couponsOperator token
POST/api/platform/couponsOperator token
PATCH/api/platform/coupons/{code}Operator token
GET/api/platform/coupons/{code}/redemptionsOperator token
GET/api/platform/discountsOperator token
POST/api/platform/discountsOperator token
PATCH/api/platform/discounts/{code}Operator token
GET/api/platform/eventsOperator token
GET/api/platform/events/verifyOperator token
GET/api/platform/failed-jobsOperator token
GET/api/platform/identityOperator token
PUT/api/platform/identity/{provider}Operator token
POST/api/platform/identity/{provider}/testOperator token
GET/api/platform/invoices/{id}/documentOperator token
GET/api/platform/leadsOperator token
PATCH/api/platform/leads/{id}Operator token
GET/api/platform/meOperator token
GET/api/platform/monitoringOperator token
GET/api/platform/plansOperator token
PATCH/api/platform/plans/{code}Operator token
GET/api/platform/plans/{code}/pricesOperator token
PUT/api/platform/plans/{code}/pricesOperator token
POST/api/platform/pricing/simulateOperator token
GET/api/platform/provisioning-runsOperator token
GET/api/platform/settingsOperator token
PATCH/api/platform/settings/{key}Operator token
GET/api/platform/simulatorOperator token
POST/api/platform/simulator/chargebacksOperator token
GET/api/platform/simulator/checkoutsOperator token
POST/api/platform/simulator/checkoutsOperator token
POST/api/platform/simulator/checkouts/{ref}/{action}Operator token
POST/api/platform/simulator/deliverOperator token
GET/api/platform/simulator/deliveriesOperator token
POST/api/platform/simulator/deliveries/{id}/replayOperator token
POST/api/platform/simulator/deliveries/{id}/retryOperator token
POST/api/platform/simulator/eventsOperator token
GET/api/platform/simulator/logOperator token
POST/api/platform/simulator/payment-method-expiryOperator token
POST/api/platform/simulator/refundsOperator token
POST/api/platform/simulator/resetOperator token
GET/api/platform/statsOperator token
GET/api/platform/subscriptionsOperator token
GET/api/platform/usageOperator token

Platform - authentication · 5

MethodPathAuth
POST/api/platform/auth/loginPublic
POST/api/platform/auth/logoutOperator token
POST/api/platform/auth/mfaPublic
POST/api/platform/auth/mfa/resendPublic
POST/api/platform/auth/refreshPublic

Platform - backup and restore · 4

MethodPathAuth
GET/api/platform/backupsOperator token
POST/api/platform/backups/runOperator token
GET/api/platform/restore-checksOperator token
POST/api/platform/restore-checks/runOperator token

Platform - operator security · 17

MethodPathAuth
GET/api/platform/adminsOperator token
POST/api/platform/adminsOperator token
PATCH/api/platform/admins/{id}Operator token
POST/api/platform/admins/{id}/force-logoutOperator token
POST/api/platform/admins/{id}/unlockOperator token
GET/api/platform/securityOperator token
DELETE/api/platform/security/devices/{id}Operator token
POST/api/platform/security/email/disableOperator token
POST/api/platform/security/email/enableOperator token
POST/api/platform/security/passwordOperator token
POST/api/platform/security/recovery/regenerateOperator token
DELETE/api/platform/security/sessions/{id}Operator token
POST/api/platform/security/sessions/revoke-othersOperator token
POST/api/platform/security/totp/beginOperator token
POST/api/platform/security/totp/confirmOperator token
POST/api/platform/security/totp/disableOperator token
POST/api/platform/security/totp/rotateOperator token

Platform - organisations · 14

MethodPathAuth
GET/api/platform/organizationsOperator token
POST/api/platform/organizationsOperator token
GET/api/platform/organizations/{id}Operator token
PATCH/api/platform/organizations/{id}Operator token
POST/api/platform/organizations/{id}/activateOperator token
POST/api/platform/organizations/{id}/archiveOperator token
POST/api/platform/organizations/{id}/deleteOperator token
GET/api/platform/organizations/{id}/eventsOperator token
POST/api/platform/organizations/{id}/impersonateOperator token
POST/api/platform/organizations/{id}/lockOperator token
POST/api/platform/organizations/{id}/owner/resetOperator token
POST/api/platform/organizations/{id}/reactivateOperator token
POST/api/platform/organizations/{id}/suspendOperator token
POST/api/platform/organizations/{id}/unlockOperator token

Public - registration, pricing and recovery · 19

MethodPathAuth
POST/api/orgs/registerPublic
GET/api/public-keyPublic
GET/api/public/billing/return/{provider}Public
GET/api/public/brandingPublic
POST/api/public/forgotPublic
GET/api/public/invitation/{token}Public
POST/api/public/invitation/acceptPublic
POST/api/public/leadPublic
GET/api/public/openapi.jsonPublic
GET/api/public/plansPublic
GET/api/public/pricingPublic
GET/api/public/promotionsPublic
POST/api/public/registerPublic
POST/api/public/register/resendPublic
POST/api/public/resetPublic
GET/api/public/reset/{token}Public
GET/api/public/turnstilePublic
POST/api/public/verifyPublic
POST/api/public/webhooks/{provider}Public

Public - single sign-on · 8

MethodPathAuth
POST/api/public/saml/{id}/acsPublic
GET/api/public/saml/{id}/metadataPublic
GET/api/public/saml/{id}/startPublic
GET/api/public/sso/{provider}/callbackPublic
GET/api/public/sso/{provider}/startPublic
POST/api/public/sso/discoverPublic
POST/api/public/sso/exchangePublic
GET/api/public/sso/providersPublic

SCIM provisioning · 8

MethodPathAuth
GET/scim/v2/ResourceTypesSCIM token
GET/scim/v2/ServiceProviderConfigSCIM token
GET/scim/v2/UsersSCIM token
POST/scim/v2/UsersSCIM token
DELETE/scim/v2/Users/{id}SCIM token
GET/scim/v2/Users/{id}SCIM token
PATCH/scim/v2/Users/{id}SCIM token
PUT/scim/v2/Users/{id}SCIM token

Tenant - account and billing · 24

MethodPathAuth
GET/api/account/api-keysTenant token
POST/api/account/api-keysTenant token
DELETE/api/account/api-keys/{id}Tenant token
POST/api/account/delete-requestTenant token
POST/api/account/delete-request/cancelTenant token
GET/api/account/invitationsTenant token
POST/api/account/invitationsTenant token
DELETE/api/account/invitations/{id}Tenant token
GET/api/account/invoicesTenant token
GET/api/account/invoices/{id}Tenant token
GET/api/account/invoices/{id}/documentTenant token
POST/api/account/onboarding/completeTenant token
GET/api/account/organizationTenant token
PATCH/api/account/organizationTenant token
GET/api/account/payment-methodsTenant token
DELETE/api/account/payment-methods/{id}Tenant token
GET/api/account/paymentsTenant token
GET/api/account/subscriptionTenant token
POST/api/account/subscription/cancelTenant token
POST/api/account/subscription/changeTenant token
POST/api/account/subscription/checkoutTenant token
POST/api/account/subscription/reactivateTenant token
POST/api/account/supportTenant token
GET/api/account/usageTenant token

Tenant - administration · 15

MethodPathAuth
POST/api/admin/backupTenant token
GET/api/admin/eventsTenant token
GET/api/admin/events/export.csvTenant token
GET/api/admin/events/verifyTenant token
GET/api/capabilitiesTenant token
GET/api/my/scopeTenant token
GET/api/org/brandingTenant token
PATCH/api/org/brandingTenant token
PUT/api/org/mobile-capabilitiesTenant token
GET/api/usersTenant token
POST/api/usersTenant token
PATCH/api/users/{id}Tenant token
POST/api/users/{id}/passwordTenant token
GET/api/users/{id}/scopeTenant token
PUT/api/users/{id}/scopeTenant token

Tenant - allocation and custody · 6

MethodPathAuth
POST/api/custody/allocateTenant token
GET/api/custody/assetsTenant token
POST/api/custody/checkTenant token
GET/api/custody/dimensionsTenant token
GET/api/custody/history/{assetId}Tenant token
GET/api/custody/holdersTenant token

Tenant - approvals · 9

MethodPathAuth
GET/api/approvals/analyticsTenant token
GET/api/approvals/delegationsTenant token
POST/api/approvals/delegationsTenant token
POST/api/approvals/delegations/{id}/revokeTenant token
GET/api/approvals/policiesTenant token
POST/api/approvals/policiesTenant token
GET/api/approvals/queueTenant token
GET/api/approvals/settingsTenant token
PUT/api/approvals/settingsTenant token

Tenant - assets and scanning · 15

MethodPathAuth
GET/api/assetsTenant token
POST/api/assetsTenant token
PATCH/api/assets/{id}Tenant token
GET/api/assets/{id}/coverageTenant token
GET/api/assets/{id}/label-linkTenant token
GET/api/assets/{id}/qr.pngTenant token
GET/api/assets/{id}/scheduleTenant token
GET/api/assets/deltaTenant token
GET/api/assets/selectTenant token
GET/api/labels/layoutsTenant token
POST/api/labels/sheetTenant token
GET/api/pairing/qr.pngTenant token
GET/api/resolveTenant token
POST/api/scanTenant token
POST/api/scan/syncTenant token

Tenant - assistant · 10

MethodPathAuth
GET/api/ai/analyticsTenant token
POST/api/ai/askTenant token
GET/api/ai/conversationTenant token
POST/api/ai/conversation/clearTenant token
GET/api/ai/document/{id}Tenant token
POST/api/ai/feedbackTenant token
GET/api/ai/knowledgeTenant token
GET/api/ai/statusTenant token
POST/api/ai/statusTenant token
POST/api/ai/streamTenant token

Tenant - authentication · 15

MethodPathAuth
POST/api/auth/desktop/loginTenant token
POST/api/auth/desktop/mfaTenant token
POST/api/auth/loginPublic
POST/api/auth/logoutTenant token
POST/api/auth/mfaPublic
POST/api/auth/mfa/confirmTenant token
POST/api/auth/mfa/disableTenant token
POST/api/auth/mfa/enrollTenant token
GET/api/auth/mfa/qr.pngTenant token
GET/api/auth/mfa/statusTenant token
POST/api/auth/passwordTenant token
POST/api/auth/refreshPublic
GET/api/auth/sessionsTenant token
DELETE/api/auth/sessions/{id}Tenant token
POST/api/auth/sessions/revoke-othersTenant token

Tenant - depreciation and periods · 10

MethodPathAuth
POST/api/depreciation/postTenant token
GET/api/depreciation/previewTenant token
GET/api/depreciation/runsTenant token
GET/api/depreciation/runs/{id}Tenant token
POST/api/depreciation/runs/{id}/reverseTenant token
GET/api/depreciation/settingsTenant token
PATCH/api/depreciation/settingsTenant token
GET/api/periodsTenant token
POST/api/periods/{id}/{action}Tenant token
POST/api/periods/yearTenant token

Tenant - estate import · 5

MethodPathAuth
POST/api/imports/commitTenant token
POST/api/imports/estate/commitTenant token
GET/api/imports/estate/kindsTenant token
POST/api/imports/estate/previewTenant token
POST/api/imports/previewTenant token

Tenant - identity administration · 7

MethodPathAuth
GET/api/identity/providersTenant token
POST/api/identity/providersTenant token
DELETE/api/identity/providers/{id}Tenant token
PATCH/api/identity/providers/{id}Tenant token
GET/api/identity/scim-tokensTenant token
POST/api/identity/scim-tokensTenant token
DELETE/api/identity/scim-tokens/{id}Tenant token

Tenant - inventory · 19

MethodPathAuth
GET/api/stockTenant token
GET/api/stock/availabilityTenant token
PATCH/api/stock/levels/{id}Tenant token
GET/api/stock/movesTenant token
POST/api/stock/movesTenant token
GET/api/stock/reservationsTenant token
POST/api/stock/reservationsTenant token
POST/api/stock/reservations/{id}/releaseTenant token
GET/api/stock/valuationTenant token
PATCH/api/stock/valuationTenant token
GET/api/stocktakesTenant token
POST/api/stocktakesTenant token
GET/api/stocktakes/{id}Tenant token
POST/api/stocktakes/{id}/abandonTenant token
POST/api/stocktakes/{id}/approveTenant token
POST/api/stocktakes/{id}/countsTenant token
GET/api/stocktakes/{id}/export.csvTenant token
PATCH/api/stocktakes/{id}/lines/{lineId}Tenant token
POST/api/stocktakes/{id}/submitTenant token

Tenant - ledger integrity and signing · 4

MethodPathAuth
GET/api/integrityTenant token
GET/api/integrity/chainTenant token
GET/api/keysTenant token
POST/api/keys/rotateTenant token

Tenant - maintenance and repair · 8

MethodPathAuth
GET/api/maintenance-plansTenant token
POST/api/maintenance-plansTenant token
PATCH/api/maintenance-plans/{id}Tenant token
GET/api/repairsTenant token
POST/api/repairsTenant token
POST/api/repairs/{id}/cancelTenant token
POST/api/repairs/{id}/completeTenant token
POST/api/repairs/{id}/startTenant token

Tenant - master data · 16

MethodPathAuth
GET/api/companies/{id}/logoTenant token
GET/api/locationsTenant token
POST/api/locationsTenant token
PATCH/api/locations/{id}Tenant token
GET/api/locations/{id}/label-linkTenant token
POST/api/locations/{id}/mergeTenant token
GET/api/locations/{id}/qr.pngTenant token
GET/api/masters/{kind}Tenant token
POST/api/masters/{kind}Tenant token
PATCH/api/masters/{kind}/{id}Tenant token
GET/api/peopleTenant token
POST/api/peopleTenant token
GET/api/people/{id}/holdingsTenant token
POST/api/people/{id}/mergeTenant token
GET/api/stores/{id}/itemsTenant token
PUT/api/stores/{id}/itemsTenant token

Tenant - notifications and jobs · 14

MethodPathAuth
GET/api/jobsTenant token
PATCH/api/jobs/{id}Tenant token
POST/api/jobs/{id}/runTenant token
GET/api/notification-rulesTenant token
POST/api/notification-rulesTenant token
DELETE/api/notification-rules/{id}Tenant token
PATCH/api/notification-rules/{id}Tenant token
GET/api/notificationsTenant token
GET/api/notifications/{id}/explainTenant token
POST/api/notifications/{id}/readTenant token
GET/api/notifications/catalogTenant token
GET/api/notifications/preferencesTenant token
POST/api/notifications/preferencesTenant token
POST/api/notifications/read-allTenant token

Tenant - offline sync and desktop · 14

MethodPathAuth
GET/api/desktop/releaseTenant token
GET/api/desktop/sessionsTenant token
GET/api/desktop/update/{target}/{version}Tenant token
GET/api/desktop/update/download/{file}Tenant token
GET/api/mobile/download/{file}Tenant token
GET/api/mobile/releaseTenant token
GET/api/sync/devicesTenant token
GET/api/sync/devices/{id}/eventsTenant token
POST/api/sync/devices/{id}/revokeTenant token
GET/api/sync/pullTenant token
POST/api/sync/pushTenant token
POST/api/sync/registerTenant token
GET/api/sync/snapshotTenant token
GET/api/sync/statusTenant token

Tenant - procurement · 43

MethodPathAuth
GET/api/purchase-ordersTenant token
POST/api/purchase-ordersTenant token
GET/api/purchase-orders/{id}Tenant token
PATCH/api/purchase-orders/{id}Tenant token
POST/api/purchase-orders/{id}/cancelTenant token
POST/api/purchase-orders/{id}/closeTenant token
POST/api/purchase-orders/{id}/decideTenant token
POST/api/purchase-orders/{id}/issueTenant token
GET/api/purchase-orders/{id}/matchTenant token
POST/api/purchase-orders/{id}/submitTenant token
GET/api/purchasesTenant token
POST/api/purchasesTenant token
GET/api/purchases/{id}Tenant token
PATCH/api/purchases/{id}Tenant token
POST/api/purchases/{id}/allocateTenant token
GET/api/purchases/{id}/allocationTenant token
GET/api/purchases/{id}/approvalTenant token
POST/api/purchases/{id}/cancelTenant token
POST/api/purchases/{id}/decideTenant token
POST/api/purchases/{id}/postTenant token
GET/api/purchases/{id}/previewTenant token
GET/api/purchases/{id}/receiptsTenant token
POST/api/purchases/{id}/receiptsTenant token
POST/api/purchases/{id}/submitTenant token
GET/api/purchases/export/tally.xmlTenant token
GET/api/purchases/export/zoho-books.csvTenant token
GET/api/purchases/line-defaultsTenant token
GET/api/receipts/{id}Tenant token
POST/api/receipts/{id}/completeTenant token
POST/api/receipts/{id}/identifyTenant token
POST/api/receipts/{id}/linesTenant token
POST/api/receipts/{id}/lines/import-csvTenant token
POST/api/receipts/{id}/reverseTenant token
POST/api/receipts/parseTenant token
GET/api/receivingTenant token
GET/api/supplier-returnsTenant token
POST/api/supplier-returnsTenant token
GET/api/supplier-returns/{id}Tenant token
PATCH/api/supplier-returns/{id}Tenant token
POST/api/supplier-returns/{id}/cancelTenant token
POST/api/supplier-returns/{id}/completeTenant token
POST/api/supplier-returns/{id}/decideTenant token
POST/api/supplier-returns/{id}/submitTenant token
MethodPathAuth
GET/api/activityTenant token
GET/api/activity/export.csvTenant token
GET/api/dashboard/executiveTenant token
POST/api/documentsTenant token
GET/api/documents/{id}Tenant token
GET/api/documents/{id}/linkTenant token
GET/api/eventsTenant token
GET/api/events/{id}/documentsTenant token
GET/api/events/{id}/explainTenant token
GET/api/overviewTenant token
GET/api/reports/{type}.csvTenant token
GET/api/reports/{type}.xlsxTenant token
GET/api/reports/{type}/explainTenant token
GET/api/reports/{type}/runTenant token
GET/api/reports/catalogTenant token
POST/api/reports/drillTenant token
GET/api/reports/widgetsTenant token
GET/api/searchTenant token
GET/api/viewsTenant token
POST/api/viewsTenant token
DELETE/api/views/{id}Tenant token

Tenant - service contracts and AMC · 11

MethodPathAuth
GET/api/contractsTenant token
POST/api/contractsTenant token
GET/api/contracts/{id}Tenant token
POST/api/contracts/{id}/activateTenant token
POST/api/contracts/{id}/assetsTenant token
POST/api/contracts/{id}/assets/removeTenant token
POST/api/contracts/{id}/cancelTenant token
GET/api/contracts/{id}/historyTenant token
POST/api/contracts/{id}/renewTenant token
POST/api/contracts/{id}/rulesTenant token
GET/api/contracts/uncoveredTenant token

See it on your own assets

Book a guided demo, or talk to our team about enterprise terms.

Request demoView pricing