The complete BizKitHub API
Every endpoint, parameter, response shape and example in one searchable explorer — backed by the same OpenAPI schema the server publishes at runtime.
Mix of API endpoints used to power BizKitHub and related apps. Please contact at info@bizkithub.com for more information.
All endpoints require a valid API key. Pass it as the apiKey query parameter or as a Bearer token in the Authorization header.
across 991 paths
tags · 100 total
v1 · service · bff
Branch
58 operations · methods: GET · POST
- get
/api/v1/branch/detailGet public branch detail
200 - get
/api/v1/branch/listList public branches
200 - post
/bff/branch/add-branch-personbffAdd (or upsert) a person on a branch
200 - post
/bff/branch/add-emailbffAdd branch email
200 - post
/bff/branch/add-opening-hour-exceptionbffAdd opening hour exception
200 - post
/bff/branch/add-phonebffAdd branch phone
200 - post
/bff/branch/attach-calendarbffAttach calendar to branch
200 - post
/bff/branch/attach-lockbffAttach a lock to a branch
200 - get
/bff/branch/attachable-calendarsbffList attachable calendars for a branch
200 - get
/bff/branch/attachable-locksbffList locks available to attach
200 - post
/bff/branch/auto-parse-opening-hoursbffAuto-fill opening hours from a free-text description (AI)
200 - post
/bff/branch/change-slugbffChange branch slug
200 - post
/bff/branch/closure-createbffRecord a new branch closure
200 - post
/bff/branch/closure-deletebffRemove a branch closure (soft delete)
200 - get
/bff/branch/closure-listbffList all closures recorded for a branch
200 - post
/bff/branch/closure-updatebffUpdate an existing branch closure
200 - post
/bff/branch/createbffCreate branch
200 - get
/bff/branch/customersbffPaginated list of customers who visited a branch
200 - get
/bff/branch/customers-summarybffHeadline aggregates for the branch customer ledger
200 - post
/bff/branch/deletebffDeactivate branch
200 - post
/bff/branch/delete-emailbffRemove branch email
200 - post
/bff/branch/delete-opening-hour-exceptionbffRemove opening hour exception
200 - post
/bff/branch/delete-phonebffRemove branch phone
200 - post
/bff/branch/detach-calendarbffDetach calendar from any branch
200 - post
/bff/branch/detach-lockbffDetach a lock from a branch
200 - get
/bff/branch/detailbffGet branch detail
200 - get
/bff/branch/finance-report-pdfbffOn-demand monthly finance report PDF for a branch
200 - post
/bff/branch/franchise-fee-addbffAdd a franchise-fee validity period
200 - post
/bff/branch/franchise-fee-deletebffDelete a franchise-fee period
200 - get
/bff/branch/franchise-fee-listbffList franchise-fee validity periods for a branch
200 - post
/bff/branch/franchise-fee-updatebffUpdate a franchise-fee period
200 - get
/bff/branch/gallery-image-deletebffDelete gallery image
200 - get
/bff/branch/gallery-image-mark-mainbffSet main branch photo
200 - get
/bff/branch/gallery-image-set-logobffMark image as logo
200 - get
/bff/branch/gallery-image-toggle-activebffToggle gallery image active status
200 - get
/bff/branch/gallery-image-update-metabffUpdate gallery image description
200 - get
/bff/branch/gallery-link-blobbffAdd image to branch gallery
200 - get
/bff/branch/gallery-listbffList branch gallery images
200 - get
/bff/branch/holding-treebffHolding (legal-entity) tree
200 - post
/bff/branch/holding/linkbffCreate a holding link
200 - post
/bff/branch/holding/unlinkbffDelete a holding link
200 - get
/bff/branch/inkaso-entriesbffPer-row audit list for the branch "Inkaso" tab
200 - get
/bff/branch/listbffList branches
200 - get
/bff/branch/monthly-breakdownbffPer-month financial roll-up for the branch detail "Finance" tab
200 - get
/bff/branch/operating-company-optionsbffList candidate operating companies
200 - get
/bff/branch/order-itemsbffPaginated list of order items attributed to a branch
200 - get
/bff/branch/order-items-summarybffHeadline aggregates for the branch order-item ledger
200 - get
/bff/branch/product-optionsbffList products available to attach to a branch
200 - post
/bff/branch/remove-branch-personbffRemove a branch_person row
200 - post
/bff/branch/resolve-operating-company-by-icobffResolve operating company by IČO
200 - post
/bff/branch/save-addressbffSave branch address
200 - post
/bff/branch/save-opening-hoursbffSave regular opening hours
200 - post
/bff/branch/save-productsbffSave branch product assortment
200 - post
/bff/branch/set-branch-contactbffSet or clear the branch technical contact
200 - post
/bff/branch/settlement/issue-invoicebffIssue a settlement order for a branch month
200409422 - get
/bff/branch/treebffBranch operational tree
200 - post
/bff/branch/updatebffUpdate branch
200 - post
/bff/branch/update-branch-personbffUpdate a branch_person row
200
Post
56 operations · methods: GET · POST
- get
/api/v1/post/categoryGet post category detail
200 - get
/api/v1/post/comment/countCount post comments
200 - post
/api/v1/post/comment/createCreate post comment
200 - post
/api/v1/post/comment/deleteDelete post comment
200 - post
/api/v1/post/comment/editEdit post comment
200 - get
/api/v1/post/comment/listList post comments
200 - post
/api/v1/post/comment/restoreRestore post comment
200 - post
/api/v1/post/createCreate or update a post (idempotent upsert by code)
200 - get
/api/v1/post/feedGet post feed
200 - get
/api/v1/post/historyList post version history
200 - get
/api/v1/post/history/diffDiff two post revisions
200 - get
/api/v1/post/history/versionGet post history version detail
200 - get
/api/v1/post/last-updateGet last post update timestamp
200 - get
/api/v1/post/metaGet post structured metadata
200 - get
/api/v1/post/postGet post detail
200 - get
/api/v1/post/rssGet RSS feed
200 - get
/api/v1/post/searchSearch posts
200 - post
/bff/post/addbffCreate a new post
200 - post
/bff/post/ai-apply-fact-check-fixbffAI-apply a single fact-check finding to a post body
200 - post
/bff/post/ai-create-from-topicbffAI-generate a private draft article from a suggested topic
200 - post
/bff/post/ai-fact-checkbffAI fact-check of an existing post
200 - post
/bff/post/ai-suggest-topicsbffAI-suggest blog topics from existing categories and recent titles
200 - get
/bff/post/category-opportunitiesbffPer-category opportunity score for AI topic brainstorming
200 - post
/bff/post/comment-deletebffDelete a post comment
200 - get
/bff/post/comment-listbffList post comments
200 - post
/bff/post/deletebffSoft-delete a post
200 - get
/bff/post/detailbffGet post detail
200 - get
/bff/post/export-pdfbffExport post as PDF
200 - post
/bff/post/generate-thumbnailbffAI-generate a thumbnail for a post
200 - get
/bff/post/history-detailbffGet post history version detail
200 - get
/bff/post/history-diffbffDiff two post revisions
200 - get
/bff/post/history-listbffList post version history
200 - post
/bff/post/history-restorebffRestore a post to a historical revision
200 - get
/bff/post/listbffList posts
200 - post
/bff/post/mood-prompt-savebffSave organisation mood prompt
200 - get
/bff/post/post-attachment-deletebffDetach file from post
200 - get
/bff/post/post-attachment-link-blobbffAttach uploaded file to post
200 - get
/bff/post/post-attachment-listbffList post attachments
200 - post
/bff/post/post-auto-translatebffAuto-translate post
200 - get
/bff/post/post-gallery-link-blobbffAdd image to post gallery
200 - get
/bff/post/post-gallery-listbffList post gallery images
200 - get
/bff/post/post-image-active-togglebffToggle image active status
200 - get
/bff/post/post-image-deletebffDelete gallery image
200 - get
/bff/post/post-image-mark-mainbffSet main post image
200 - get
/bff/post/post-image-update-metabffUpdate image metadata
200 - post
/bff/post/post-meta-deletebffDelete one metadata entry by key
200 - get
/bff/post/post-meta-listbffList post metadata entries (content__post_meta)
200 - post
/bff/post/post-meta-upsertbffCreate or update one metadata entry
200 - post
/bff/post/post-toggle-starbffToggle post star status
200 - post
/bff/post/reference-image-deletebffSoft-delete a reference image
200 - post
/bff/post/reference-image-link-blobbffLink an uploaded blob as a reference image
200 - get
/bff/post/reference-image-listbffList organisation reference images and mood prompt
200 - post
/bff/post/reference-image-toggle-activebffToggle reference image active flag
200 - post
/bff/post/resolve-category-by-aibffAuto-categorize post by AI
200 - post
/bff/post/restorebffRestore a soft-deleted post
200 - post
/bff/post/savebffUpdate an existing post
200
Contact
54 operations · methods: GET · POST
- get
/bff/contact-segment/contactsbffList contacts that match a segment
200 - get
/bff/contact-segment/contacts-exportbffExport all contacts matching a segment
200 - get
/bff/contact-segment/countbffCount contacts matching a segment
200 - post
/bff/contact-segment/createbffCreate a new contact segment
200 - post
/bff/contact-segment/deletebffDelete a contact segment (soft delete)
200 - get
/bff/contact-segment/detailbffGet contact segment detail
200 - get
/bff/contact-segment/fieldsbffList available segment filter fields
200 - get
/bff/contact-segment/listbffList contact segments
200 - get
/bff/contact-segment/optionsbffAutocomplete options for segment entity-ref fields
200 - post
/bff/contact-segment/previewbffPreview an unsaved segment definition
200 - post
/bff/contact-segment/updatebffUpdate a contact segment
200 - post
/bff/contact/add-groupsbffAdd groups (tags) to a contact
200 - post
/bff/contact/add-workspacebffAdd workspace to contact
200 - post
/bff/contact/anonymizebffAnonymise contact (GDPR right-to-erasure)
200 - post
/bff/contact/block-contactbffBlock or unblock contact
200 - post
/bff/contact/bulk-importbffBulk import contacts
200 - post
/bff/contact/check-email-availabilitybffCheck whether an e-mail can be used for a new contact
200 - post
/bff/contact/company-refreshbffForce-refresh company registry record
200 - post
/bff/contact/consent/grantbffGrant consent
200 - post
/bff/contact/consent/revokebffRevoke consent
200 - post
/bff/contact/createbffQuick-create contact
200 - get
/bff/contact/custom-field/definition-listbffList custom field definitions
200 - post
/bff/contact/custom-field/definition-savebffSave custom field definition
200 - post
/bff/contact/custom-field/deletebffDelete custom field value
200 - post
/bff/contact/custom-field/setbffSet custom field value
200 - post
/bff/contact/deletebffSoft-delete contact
200 - get
/bff/contact/detailbffGet contact detail
200 - get
/bff/contact/detail-addressbffGet contact addresses
200 - post
/bff/contact/detail-change-emailbffChange contact email
200 - post
/bff/contact/detail-change-email-previewbffPreview the effect of changing a contact e-mail
200 - post
/bff/contact/detail-editbffEdit contact detail
200 - get
/bff/contact/detail-ip-reportbffIP address report for a contact
200 - get
/bff/contact/detail-password-logbffGet contact password log
200 - get
/bff/contact/detail-security-infobffGet contact security info
200 - get
/bff/contact/detail-sessionsbffList contact sessions
200 - post
/bff/contact/email-deletebffRemove a billing email role
200 - get
/bff/contact/email-listbffList billing email roles for a contact
200 - post
/bff/contact/email-upsertbffInsert or update a billing email role
200 - get
/bff/contact/export-gdprbffDownload personal data export (GDPR Art. 15)
200 - post
/bff/contact/export-gdpr-emailbffE-mail personal data export to the contact (GDPR Art. 15)
200 - post
/bff/contact/generate-api-keybffGenerate API key
200 - get
/bff/contact/group-listbffList contact groups
200 - get
/bff/contact/hierarchybffGet contact hierarchy
200 - post
/bff/contact/invalidate-sessionsbffInvalidate contact sessions
200 - get
/bff/contact/listbffList contacts
200 - post
/bff/contact/merge-customersbffMerge two contacts
200 - get
/bff/contact/org-treebffGet organisational tree around a contact
200 - post
/bff/contact/process-set-passwordbffProcess password reset
200 - post
/bff/contact/reset-passwordbffRequest password reset
200 - post
/bff/contact/set-billing-flagsbffSet contact billing flags (reverse charge / tax exempt)
200 - post
/bff/contact/set-parentbffSet contact superior
200 - post
/bff/contact/set-passwordbffSet contact password
200 - post
/bff/contact/update-internal-noticebffUpdate contact internal notice
200 - get
/bff/contact/workspace-listbffList contact workspaces
200
Product
49 operations · methods: GET · POST
- get
/api/v1/product/detail200 - get
/api/v1/product/feed200 - get
/bff/product/analyticsbffProduct analytics — KPIs, monthly time-series, top customers, top branches
200 - post
/bff/product/connect-contactbffConnect contact to product
200 - post
/bff/product/connect-eventbffConnect calendar event
200 - post
/bff/product/connect-related-productbffConnect related product
200 - post
/bff/product/delete-product-variantbffDelete product variant
200 - post
/bff/product/detail-change-codebffChange product code
200 - post
/bff/product/disconnect-eventbffDisconnect calendar event
200 - post
/bff/product/disconnect-related-productbffDisconnect related product
200 - get
/bff/product/listbffList products
200 - get
/bff/product/price-historybffGet product price history
200 - post
/bff/product/pricelist-previewbffPreview pricelist resolver
200 - post
/bff/product/pricelist-updatebffSave product pricelist rules
200 - post
/bff/product/product-auto-translatebffAuto-translate product
200 - post
/bff/product/product-category-linkbffLink category to product
200 - get
/bff/product/product-category-set-mainbffSet main product category
200 - post
/bff/product/product-category-unlinkbffUnlink category from product
200 - get
/bff/product/product-category-unset-mainbffUnset main product category
200 - post
/bff/product/product-copybffCopy product
200 - post
/bff/product/product-createbffCreate product
200 - post
/bff/product/product-custom-field-createbffCreate custom field
200 - post
/bff/product/product-custom-field-updatebffUpdate custom field
200 - get
/bff/product/product-detailbffGet product detail
200 - get
/bff/product/product-detail-categorybffGet product categories
200 - get
/bff/product/product-detail-relatedbffList related products
200 - get
/bff/product/product-gallery-link-blobbffAdd image to product gallery
200 - get
/bff/product/product-gallery-listbffList product gallery images
200 - get
/bff/product/product-image-active-togglebffToggle image active status
200 - get
/bff/product/product-image-deletebffDelete gallery image
200 - get
/bff/product/product-image-mark-mainbffSet main product image
200 - get
/bff/product/product-image-update-metabffUpdate image metadata
200 - post
/bff/product/product-reorderbffReorder products by swapping positions
200 - post
/bff/product/product-restorebffRestore soft-deleted product
200 - post
/bff/product/product-soft-deletebffSoft-delete product
200 - post
/bff/product/product-subscription-plan-linkbffLink subscription plan to product
200 - get
/bff/product/product-subscription-plan-listbffList linked subscription plans
200 - post
/bff/product/product-subscription-plan-unlinkbffUnlink subscription plan from product
200 - post
/bff/product/product-updatebffUpdate product
200 - post
/bff/product/product-variant-createbffCreate product variant
200 - get
/bff/product/product-variant-listbffList product variants (paginated)
200 - post
/bff/product/product-voucher-template-linkbffLink voucher template to product
200 - get
/bff/product/product-voucher-template-listbffList linked voucher templates
200 - post
/bff/product/product-voucher-template-unlinkbffUnlink voucher template from product
200 - get
/bff/product/search-product-list-autocompletebffAutocomplete product search
200 - get
/bff/product/search-product-variant-listbffSearch product variants (lightweight)
200 - get
/bff/product/search-related-productsbffSearch products for relating
200 - post
/bff/product/update-variantbffUpdate variant property
200 - post
/bff/product/variant-set-main-imagebffSet or remove variant main image
200
Warehouse
37 operations · methods: GET · POST
- get
/bff/warehouse/alerts/low-stockbffList stock cells under the configured low-stock threshold
200 - post
/bff/warehouse/createbffCreate warehouse
200 - get
/bff/warehouse/dashboard/healthbffStock health dashboard (Tier 1 #4)
200 - post
/bff/warehouse/deletebffDelete an empty warehouse
200 - get
/bff/warehouse/detailbffGet warehouse detail by id or code
200 - get
/bff/warehouse/listbffList warehouses
200 - post
/bff/warehouse/location/createbffCreate a location
200 - post
/bff/warehouse/location/deletebffDelete an empty location
200 - get
/bff/warehouse/location/listbffList locations in a warehouse
200 - post
/bff/warehouse/location/updatebffUpdate a location
200 - get
/bff/warehouse/movement/listbffList movements (audit log)
200 - post
/bff/warehouse/policy/deletebffDelete a stock policy (Tier 1 #4)
200 - get
/bff/warehouse/policy/listbffList stock policies (Tier 1 #4)
200 - post
/bff/warehouse/policy/upsertbffCreate or update a stock policy (Tier 1 #4)
200 - get
/bff/warehouse/product-stockbffAggregate stock breakdown for one product
200 - get
/bff/warehouse/reports/days-of-stockbffDays-of-stock report (Tier 1 #4)
200 - get
/bff/warehouse/reports/dead-stockbffList stock with no movement for N days ("dead stock")
200 - post
/bff/warehouse/reservation/commitbffCommit reservation(s) to outbound (Tier 1 #1)
200 - post
/bff/warehouse/reservation/createbffReserve stock (Tier 1 #1)
200 - post
/bff/warehouse/reservation/releasebffRelease reservation(s) (Tier 1 #1)
200 - post
/bff/warehouse/scanner/quick-opbffMobile/scanner quick stock operation with idempotent offline-queue support (Tier 1 #3)
200 - post
/bff/warehouse/scanner/resolvebffResolve a scanned code to one or more entities (Tier 1 #3)
200 - post
/bff/warehouse/set-defaultbffPromote a warehouse to organisation default
200 - post
/bff/warehouse/stock/adjustbffAdjustment (inventory / write-off)
200 - post
/bff/warehouse/stock/inboundbffInbound (naskladnění)
200 - get
/bff/warehouse/stock/listbffList stock items
200 - post
/bff/warehouse/stock/outboundbffOutbound (vyskladnění)
200 - post
/bff/warehouse/stock/transferbffTransfer between warehouses/locations
200 - post
/bff/warehouse/stocktake/approvebffApprove stocktake — produces adjustment movements (Tier 1 #2)
200 - post
/bff/warehouse/stocktake/cancelbffCancel stocktake session (Tier 1 #2)
200 - post
/bff/warehouse/stocktake/countbffRecord counted quantity (Tier 1 #2)
200 - post
/bff/warehouse/stocktake/createbffCreate stocktake session (Tier 1 #2)
200 - get
/bff/warehouse/stocktake/detailbffStocktake session detail (Tier 1 #2)
200 - get
/bff/warehouse/stocktake/listbffList stocktake sessions (Tier 1 #2)
200 - post
/bff/warehouse/stocktake/startbffStart stocktake session (Tier 1 #2)
200 - post
/bff/warehouse/stocktake/submitbffSubmit stocktake for review (Tier 1 #2)
200 - post
/bff/warehouse/updatebffUpdate warehouse
200
Product Category
33 operations · methods: GET · POST
- get
/api/v1/product-category/detailGet product category detail
200 - get
/api/v1/product-category/listList product categories
200 - get
/api/v1/product-category/treeGet full product category tree
200 - post
/bff/product-category/assign-productsbffBulk (un)assign products to a category
200 - get
/bff/product-category/assignable-productsbffList products to (un)assign to/from a category
200 - get
/bff/product-category/bulk-delete-previewbffPreview cascade delete
200 - post
/bff/product-category/category-ai-restructure-applybffAI: apply a proposed restructure
200 - post
/bff/product-category/category-ai-restructure-suggestbffAI: propose a new category hierarchy
200 - post
/bff/product-category/category-ai-suggestbffAI: generate category description + SEO
200 - get
/bff/product-category/category-analyticsbffCategory KPIs
200 - post
/bff/product-category/category-bulkbffBulk operation on categories
200 - post
/bff/product-category/category-createbffCreate product category
200 - post
/bff/product-category/category-custom-field-deletebffDelete a category-scoped custom field
200 - post
/bff/product-category/category-custom-field-upsertbffCreate/update a category-scoped custom field
200 - get
/bff/product-category/category-custom-fieldsbffList category-scoped custom field definitions
200 - post
/bff/product-category/category-deletebffSoft-delete product category
200 - get
/bff/product-category/category-detailbffGet category detail
200 - post
/bff/product-category/category-locale-deletebffDelete a category translation
200 - post
/bff/product-category/category-locale-upsertbffUpsert a category translation
200 - post
/bff/product-category/category-reorderbffReorder / move category in tree
200 - post
/bff/product-category/category-restorebffRestore soft-deleted category
200 - post
/bff/product-category/category-set-main-imagebffSet or remove category main image
200 - post
/bff/product-category/category-updatebffUpdate product category
200 - post
/bff/product-category/category-update-feed-mappingbffUpdate feed taxonomy mapping
200 - post
/bff/product-category/category-update-schedulebffUpdate category schedule + visibility rules
200 - post
/bff/product-category/category-update-seobffUpdate category SEO fields
200 - get
/bff/product-category/export-csvbffExport categories as CSV
200 - post
/bff/product-category/import-csvbffImport categories from CSV
200 - get
/bff/product-category/listbffList product categories
200 - get
/bff/product-category/list-selectboxbffList categories for selectbox
200 - get
/bff/product-category/list-with-countsbffList categories with product counts
200 - get
/bff/product-category/taxonomy-googlebffBundled Google Product Taxonomy
200 - get
/bff/product-category/treebffGet category tree
200
Order
32 operations · methods: POST · GET
- post
/api/v1/shop/order/check-payment-status200 - post
/api/v1/shop/order/create200 - post
/api/v1/shop/order/create-payment200 - get
/api/v1/shop/order/detail200 - post
/api/v1/shop/order/set-status200 - post
/api/v1/shop/order/storno200 - post
/bff/order/add-creditbffAdd credit item to order
200 - post
/bff/order/add-eventbffAdd event to order
200 - post
/bff/order/add-productbffAdd product to order
200 - post
/bff/order/add-virtual-productbffAdd virtual product to order
200 - post
/bff/order/createbffCreate a new order
200 - get
/bff/order/create-invoicebffCreate invoice for order
200 - post
/bff/order/create-paymentbffCreate payment for order
200 - post
/bff/order/create-recurrence-paymentbffCreate recurrence payment schedule
200 - get
/bff/order/detailbffGet order detail
200 - get
/bff/order/detail-filebffGet order files
200 - get
/bff/order/detail-logbffGet order log entries
200 - get
/bff/order/detail-log-explainbffAI-explain order log
200 - get
/bff/order/detail-recurrencebffGet order recurrence payments
200 - post
/bff/order/detail-recurrence-deletebffDelete recurrence payment
200 - post
/bff/order/detail-recurrence-editbffEdit recurrence payment amount
200 - get
/bff/order/grid-configurationbffGet order grid configuration
200 - get
/bff/order/link-blobbffLink blob to order
200 - get
/bff/order/listbffList orders
200 - post
/bff/order/mark-as-non-paidbffMark order as non-paid
200 - post
/bff/order/mark-as-paidbffMark order as paid
200 - post
/bff/order/remove-itembffRemove order item
200 - post
/bff/order/resend-notificationbffResend order notification
200 - post
/bff/order/set-item-stornobffToggle item storno
200 - post
/bff/order/set-statusbffSet order status
200 - get
/bff/order/statisticsbffGet order statistics
200 - post
/bff/order/update-noticebffUpdate order notices
200
Emailer
30 operations · methods: POST · GET
- post
/api/v1/emailer/sendSend email
200 - post
/api/v1/emailer/webhook-incoming-emailIncoming email webhook
200 - post
/bff/emailer/composebffCompose and send email
200 - get
/bff/emailer/detailbffGet email detail
200 - get
/bff/emailer/detail-log-explainbffAI-explain email log entry
200 - get
/bff/emailer/layoutbffGet email layout
200 - post
/bff/emailer/layout-editbffUpdate email layout
200 - get
/bff/emailer/layout-link-logo-blobbffSet logo from blob
200 - get
/bff/emailer/listbffList email messages
200 - get
/bff/emailer/message-logbffGet message delivery log
200 - get
/bff/emailer/received-detailbffGet received e-mail detail
200 - get
/bff/emailer/received-listbffList received e-mails
200 - post
/bff/emailer/sendbffSend email
200 - get
/bff/emailer/send-againbffRe-send email
200 - get
/bff/emailer/send-nowbffSend email immediately
200 - post
/bff/emailer/setup-smtpbffConfigure SMTP settings
200 - get
/bff/emailer/smtp-infobffGet SMTP configuration
200 - get
/bff/emailer/statisticsbffGet email statistics
200 - get
/bff/emailer/statusbffGet emailer status
200 - post
/bff/emailer/template-addbffCreate email template
200 - get
/bff/emailer/template-coveragebffEmail template coverage matrix
200 - post
/bff/emailer/template-create-overridebffCreate organisation override for a template type
200 - get
/bff/emailer/template-detailbffGet template detail
200 - post
/bff/emailer/template-editbffUpdate email template
200 - get
/bff/emailer/template-listbffList email templates
200 - post
/bff/emailer/template-send-debug-emailbffSend debug template email
200 - get
/bff/emailer/template-type-detailbffEmail template type detail
200 - get
/bff/emailer/template-type-listbffList email template types
200 - post
/bff/emailer/template-validatebffValidate email template
200 - get
/bff/emailer/template-variablesbffList template variables
200
Customer
25 operations · methods: POST · GET
- post
/api/v1/customer/add-bank-accountAdd bank account
200 - post
/api/v1/customer/add-groupsAdd groups (tags) to a customer
200 - post
/api/v1/customer/createCreate customer
200 - post
/api/v1/customer/create-api-keyCreate customer API key
200 - get
/api/v1/customer/credit-logGet credit log
200 - post
/api/v1/customer/credit-spendSpend customer credit
200 - post
/api/v1/customer/customer-match-customerMatch two customers
200 - post
/api/v1/customer/customer-unmatch-customerUnmatch two customers
200 - get
/api/v1/customer/detailGet customer detail
200 - get
/api/v1/customer/export-gdprDownload personal data export (GDPR Art. 15)
200 - get
/api/v1/customer/get-account-infoGet account info
200 - get
/api/v1/customer/hierarchyGet customer hierarchy
200 - get
/api/v1/customer/listList customers
200 - post
/api/v1/customer/loginCustomer login
200 - post
/api/v1/customer/logoutCustomer logout
200 - post
/api/v1/customer/magic-authMagic auth (passwordless login)
200 - get
/api/v1/customer/matched-customer-listList matched customers
200 - get
/api/v1/customer/order-listList customer orders
200 - get
/api/v1/customer/org-treeGet organisational tree
200 - post
/api/v1/customer/register-accountRegister customer account
200 - post
/api/v1/customer/register-account-verifyVerify account registration
200 - post
/api/v1/customer/reset-passwordRequest password reset
200 - post
/api/v1/customer/set-new-passwordSet new password
200 - post
/api/v1/customer/set-parentSet customer superior
200 - post
/api/v1/customer/update-profileUpdate customer profile
200
Member
23 operations · methods: GET · POST
- get
/bff/member/activitybffMember activity timeline
200 - get
/bff/member/assigned-workbffOpen work assigned to one member (counts + 3 examples per surface)
200 - get
/bff/member/available-permissionsbffGet available permissions and roles
200 - post
/bff/member/blockbffBlock/unblock member
200 - post
/bff/member/cancel-invitebffCancel a pending invitation
200 - get
/bff/member/clone-permissions-sourcebffRead a source member’s current permissions for a clone-to flow
200 - post
/bff/member/confirm-invitebffConfirm member invitation
200 - get
/bff/member/detailbffGet member detail
200 - get
/bff/member/invite-detailbffGet invitation details
200 - post
/bff/member/invite-emailbffInvite member by email
200 - get
/bff/member/listbffList organisation members
200 - get
/bff/member/notesbffList internal notes pinned to a member
200 - post
/bff/member/notes/createbffCreate a new internal note
200 - post
/bff/member/notes/deletebffSoft-delete an internal note
200 - post
/bff/member/notes/updatebffUpdate / pin / unpin an internal note
200 - get
/bff/member/permission-templatesbffList permission templates for the organisation
200 - post
/bff/member/permission-templates/createbffCreate a permission template
200 - post
/bff/member/permission-templates/deletebffHard-delete a permission template
200 - post
/bff/member/permission-templates/updatebffUpdate a permission template
200 - get
/bff/member/permissionsbffGet member permissions
200 - post
/bff/member/resend-invitebffResend a pending invitation
200 - post
/bff/member/save-permissionsbffSave member permissions
200 - post
/bff/member/tagsbffReplace the free-form tag list on a member
200
Complaint
22 operations · methods: POST · GET
- post
/api/v1/shop/complaint/create200 - get
/api/v1/shop/complaint/detail200 - post
/api/v1/shop/complaint/set-status200 - post
/bff/complaint/add-eventbffAdd complaint event
200 - post
/bff/complaint/add-itembffAdd complaint item
200 - post
/bff/complaint/createbffCreate complaint
200 - get
/bff/complaint/detailbffComplaint detail
200 - post
/bff/complaint/link-blobbffAttach file to complaint
200 - get
/bff/complaint/listbffList complaints
200 - post
/bff/complaint/policy-createbffCreate complaint policy
200 - get
/bff/complaint/policy-listbffList complaint policies
200 - post
/bff/complaint/policy-updatebffUpdate complaint policy
200 - post
/bff/complaint/remove-itembffRemove complaint item
200 - post
/bff/complaint/resolution-method-createbffCreate resolution method
200 - get
/bff/complaint/resolution-method-listbffList resolution methods
200 - post
/bff/complaint/resolution-method-updatebffUpdate resolution method
200 - post
/bff/complaint/satisfactionbffSubmit satisfaction feedback
200 - post
/bff/complaint/set-statusbffSet complaint status
200 - post
/bff/complaint/updatebffUpdate complaint
200 - post
/bff/complaint/variant-createbffCreate complaint variant
200 - get
/bff/complaint/variant-listbffList complaint variants
200 - post
/bff/complaint/variant-updatebffUpdate complaint variant
200
Dashboard
21 operations · methods: GET
- get
/bff/dashboard/average-order-valuebffAverage Order Value (AOV) trend
200 - get
/bff/dashboard/brand-performancebffBrand performance
200 - get
/bff/dashboard/calendar-utilizationbffCalendar utilization
200 - get
/bff/dashboard/cancelled-eventsbffCancelled calendar events
200 - get
/bff/dashboard/cash-flowbffCash flow overview
200 - get
/bff/dashboard/customer-segmentationbffNew vs returning customers
200 - get
/bff/dashboard/daily-revenuebffDaily revenue overview
200 - get
/bff/dashboard/email-statsbffSystem email statistics
200 - get
/bff/dashboard/inactive-customersbffInactive customers
200 - get
/bff/dashboard/mrrbffMonthly Recurring Revenue (MRR)
200 - get
/bff/dashboard/order-funnelbffOrder conversion funnel
200 - get
/bff/dashboard/orders-by-statusbffOrders by status breakdown
200 - get
/bff/dashboard/overdue-invoicesbffOverdue invoices (receivables)
200 - get
/bff/dashboard/payment-methodsbffPayment methods popularity
200 - get
/bff/dashboard/payment-success-ratebffPayment success rate
200 - get
/bff/dashboard/revenue-retentionbffYear-over-year revenue retention
200 - get
/bff/dashboard/top-productsbffTop selling products
200 - get
/bff/dashboard/unmatched-paymentsbffUnmatched bank payments
200 - get
/bff/dashboard/unpaid-ordersbffUnpaid orders summary
200 - get
/bff/dashboard/upcoming-renewalsbffUpcoming subscription renewals
200 - get
/bff/dashboard/voucher-performancebffVoucher/discount code performance
200
Account
20 operations · methods: GET · POST
- get
/bff/account/bffCheck authentication status
200 - get
/bff/account/audit-login-attemptsbffList login attempts
200 - post
/bff/account/create-accountbffCreate account
200 - post
/bff/account/create-account-by-tokenbffConfirm account by token
200 - post
/bff/account/create-login-attemptbffCreate login attempt
200 - get
/bff/account/detailbffGet account detail
200 - get
/bff/account/detail-contactbffGet account contact information
200 - post
/bff/account/loginbffLog in
200 - post
/bff/account/login-otp-authbffVerify OTP code
200 - post
/bff/account/logoutbffLog out
200 - post
/bff/account/reset-passwordbffReset password
200 - post
/bff/account/restore-personal-accountbffRestore personal account
200 - get
/bff/account/search-historybffList my search history
200 - get
/bff/account/set-activity-statusbffSet activity status
200 - post
/bff/account/set-namebffSet user name
200 - post
/bff/account/setup-otp-disablebffDisable 2FA on the account
200 - post
/bff/account/setup-otp-generate-secretbffGenerate OTP secret
200 - post
/bff/account/setup-otp-savebffActivate 2FA on the account
200 - get
/bff/account/sync-statusbffGet sync status
200 - post
/bff/account/update-profilebffUpdate user profile
200
Payment Gateway
19 operations · methods: POST · GET
- post
/bff/payment-gateway/addbffAdd new gateway
200 - post
/bff/payment-gateway/commission-addbffAdd a commission period
200 - post
/bff/payment-gateway/commission-deletebffDelete a commission period
200 - get
/bff/payment-gateway/commission-listbffList commission periods for a gateway
200 - post
/bff/payment-gateway/commission-updatebffUpdate a commission period
200 - get
/bff/payment-gateway/connection-statusbffCheck gateway connection status
200 - post
/bff/payment-gateway/deletebffDelete gateway
200 - get
/bff/payment-gateway/detailbffGet gateway detail
200 - get
/bff/payment-gateway/keysbffGet gateway credentials
200 - get
/bff/payment-gateway/listbffList payment gateways
200 - get
/bff/payment-gateway/list-for-order-groupbffList gateways selectable for an order-group preference
200 - get
/bff/payment-gateway/monthly-analyticsbffPer-month performance roll-up for the gateway detail "Analytics" tab
200 - get
/bff/payment-gateway/monthly-analytics-by-order-groupbffPer-(month × order group) pivot of received amounts through the gateway
200 - get
/bff/payment-gateway/payment-listbffList payments
200 - get
/bff/payment-gateway/statsbffGet payment statistics
200 - post
/bff/payment-gateway/sync-paymentbffSync payment status
200 - post
/bff/payment-gateway/test-connectionbffTest gateway connection
200 - post
/bff/payment-gateway/toggle-activebffToggle gateway active status
200 - post
/bff/payment-gateway/updatebffUpdate gateway
200
Chat
18 operations · methods: POST · GET · DELETE
- post
/api/v1/chat/ai-turnAI turn — append user prompt + assistant answer in one call
200 - get
/api/v1/chat/roomList chat rooms (paginated)
200 - post
/api/v1/chat/roomCreate a new chat room
200 - get
/api/v1/chat/room/{id}Get a chat room with all its messages
200 - delete
/api/v1/chat/room/{id}Soft-delete a chat room (sets deleted_date)
200 - post
/api/v1/chat/room/{id}/messageAppend a message to a chat room
200 - post
/api/v1/chat/room/{id}/problemToggle the conversation-level problem flag
200 - post
/api/v1/chat/room/{id}/titleRename a chat room
200 - post
/bff/chat/ai-questionbffPersistent AI turn (admin AiChatApp / dashboards)
200 - get
/bff/chat/contact-optionsbffContact dropdown options for the conversation grid filter
200 - post
/bff/chat/createbffCreate a chat room (admin / internal use)
200 - post
/bff/chat/deletebffSoft-delete a chat room
200 - get
/bff/chat/detailbffChat room detail with all messages
200 - get
/bff/chat/listbffList chat rooms for the admin grid
200 - post
/bff/chat/messagebffAppend a message to a chat room
200 - post
/bff/chat/persist-turnbffPersist a finished user/assistant turn into a chat room
200 - post
/bff/chat/problembffToggle the conversation-level problem flag
200 - post
/bff/chat/titlebffRename a chat room
200
Io T
18 operations · methods: GET · POST
- get
/api/v1/lock/listList locks
200 - post
/api/v1/lock/unlockUnlock lock remotely
200 - get
/bff/iot-lock/activity-timelinebffPer-lock activity timeline
200 - get
/bff/iot-lock/credentials-detailbffGet TTLock credentials status
200 - post
/bff/iot-lock/credentials-updatebffUpdate TTLock account credentials
200 - get
/bff/iot-lock/health-overviewbffOrganisation-wide lock health
200 - post
/bff/iot-lock/lock-addbffAdd new lock
200 - get
/bff/iot-lock/lock-detailbffGet lock detail
200 - get
/bff/iot-lock/lock-detail-refreshbffRefresh lock status
200 - get
/bff/iot-lock/lock-electric-quantity-listbffList battery level history
200 - get
/bff/iot-lock/lock-listbffList locks
200 - post
/bff/iot-lock/password-addbffCreate new passcode
200 - get
/bff/iot-lock/password-deletebffDelete passcode
200 - get
/bff/iot-lock/password-listbffList lock passcodes
200 - get
/bff/iot-lock/queue-statsbffTTLock API queue health
200 - post
/bff/iot-lock/save-settingsbffUpdate lock settings
200 - get
/bff/iot-lock/unlock-nowbffUnlock lock remotely
200 - get
/bff/iot-lock/unlock-record-listbffList unlock records
200
Product Parameter
18 operations · methods: POST · GET
- post
/bff/product-parameter/addbffCreate parameter
200 - post
/bff/product-parameter/category-assignbffAssign parameter to category
200 - get
/bff/product-parameter/category-parametersbffList category parameters
200 - post
/bff/product-parameter/category-removebffRemove parameter from category
200 - post
/bff/product-parameter/deletebffDelete parameter
200 - post
/bff/product-parameter/group-addbffCreate parameter group
200 - post
/bff/product-parameter/group-deletebffDelete parameter group
200 - get
/bff/product-parameter/group-listbffList parameter groups
200 - post
/bff/product-parameter/group-updatebffUpdate parameter group
200 - get
/bff/product-parameter/listbffList parameters
200 - post
/bff/product-parameter/product-assignbffAssign parameter value to product
200 - post
/bff/product-parameter/product-removebffRemove parameter assignment from product
200 - get
/bff/product-parameter/product-valuesbffList product parameter values
200 - post
/bff/product-parameter/updatebffUpdate parameter
200 - post
/bff/product-parameter/value-addbffAdd parameter value
200 - post
/bff/product-parameter/value-deletebffDelete parameter value
200 - get
/bff/product-parameter/value-listbffList parameter values
200 - post
/bff/product-parameter/value-updatebffUpdate parameter value
200
Calendar Analytics
17 operations · methods: GET
- get
/bff/calendar/calendar-analytics-average-event-durationbffAverage event duration
200 - get
/bff/calendar/calendar-analytics-cancellation-analysisbffCancellation analysis
200 - get
/bff/calendar/calendar-analytics-event-completion-ratebffEvent completion rate
200 - get
/bff/calendar/calendar-analytics-last-minute-bookingsbffLast-minute bookings (<24h)
200 - get
/bff/calendar/calendar-analytics-lead-time-bookingbffLead time booking analysis
200 - get
/bff/calendar/calendar-analytics-lost-revenue-capacitybffLost revenue due to capacity
200 - get
/bff/calendar/calendar-analytics-monthly-trendbffMonthly utilization trend
200 - get
/bff/calendar/calendar-analytics-peak-hours-heatmapbffPeak hours heatmap
200 - get
/bff/calendar/calendar-analytics-reportbffGet calendar analytics report
200 - get
/bff/calendar/calendar-analytics-revenue-per-event-typebffRevenue per event type
200 - get
/bff/calendar/calendar-analytics-revenue-per-hourbffRevenue per hour of day
200 - get
/bff/calendar/calendar-analytics-simultaneous-eventsbffSimultaneous events analysis
200 - get
/bff/calendar/calendar-analytics-sold-out-ratebffEvent attendance analysis
200 - get
/bff/calendar/calendar-analytics-time-to-fillbffTime-to-fill analysis
200 - get
/bff/calendar/calendar-analytics-top-event-typesbffTop event types
200 - get
/bff/calendar/calendar-analytics-utilization-ratebffAttendance utilization rate
200 - get
/bff/calendar/calendar-analytics-weekend-vs-weekdaybffWeekend vs weekday comparison
200
Calendar
16 operations · methods: POST · GET
- post
/api/v1/calendar/add-event200 - get
/api/v1/calendar/detail200 - post
/api/v1/calendar/event-find-conflict200 - get
/api/v1/calendar/event-list200 - get
/api/v1/calendar/scheduling-assistant200 - get
/api/v1/calendar/timezones200 - post
/bff/calendar/calendar-addbffCreate a new calendar
200 - get
/bff/calendar/calendar-detailbffGet calendar detail
200 - get
/bff/calendar/calendar-listbffList calendars
200 - get
/bff/calendar/calendar-settingsbffGet calendar settings (admin shape)
200 - post
/bff/calendar/calendar-settings-updatebffUpdate calendar settings
200 - get
/bff/calendar/colleague-overlaybffSee a colleague calendar (their cross-org events shown as Busy)
200 - get
/bff/calendar/conflictsbffList cross-org calendar conflicts for the viewer
200 - get
/bff/calendar/detail-reservationsbffList reservations
200 - get
/bff/calendar/mebffGet the viewer's personal calendar in the current organisation
200 - get
/bff/calendar/my-overlaybffUnified cross-org overlay of the viewer events
200
Service
16 operations · methods: POST · GET
- post
/api/service/aiservice200 - get
/api/service/emailer/queue-listservice200 - get
/api/service/emailer/send-mailservice200 - get
/api/service/frontend/confirm-registrationservice200 - get
/api/service/frontend/newsletter-confirmservice200 - get
/api/service/frontend/order-payservice200 - get
/api/service/frontend/order-statusservice200 - get
/api/service/frontend/order-stornoservice200 - get
/api/service/frontend/reset-password-verify-tokenservice200 - get
/api/service/frontend/unsubscribe-newsletterservice200 - post
/api/service/scheduler/claimservice200 - post
/api/service/scheduler/completeservice200 - post
/api/service/scheduler/heartbeatservice200 - post
/api/service/scheduler/logservice200 - post
/api/service/scheduler/peekservice200 - get
/api/service/status-pageservice200
Form
15 operations · methods: GET · POST
- get
/api/v1/form/detailGet form detail
200 - post
/bff/form/addbffCreate form
200 - post
/bff/form/add-fieldbffAdd field
200 - post
/bff/form/copy-formbffCopy form
200 - post
/bff/form/delete-formbffDelete form
200 - post
/bff/form/delete-recordbffDelete record
200 - post
/bff/form/duplicate-fieldbffDuplicate field
200 - get
/bff/form/listbffList forms
200 - get
/bff/form/record-detailbffGet record detail
200 - post
/bff/form/remove-fieldbffRemove field
200 - post
/bff/form/rename-field-keybffRename field key
200 - post
/bff/form/reorder-fieldsbffReorder fields
200 - get
/bff/form/structurebffGet form structure
200 - get
/bff/form/tablebffGet form submissions table
200 - post
/bff/form/update-structurebffUpdate form structure
200
Organisation
15 operations · methods: GET · DELETE · POST
- get
/bff/organisation/available-countriesbffList all system countries
200 - get
/bff/organisation/available-currenciesbffList all system currencies
200 - get
/bff/organisation/available-localesbffList all system locales
200 - get
/bff/organisation/internal-contactbffGet the organisation internal contact display info
200 - get
/bff/organisation/legal-formsbffList legal forms (optionally filtered by country)
200 - get
/bff/organisation/link-blobbffLink blob to organisation
200 - get
/bff/organisation/link-print-logo-blobbffSet print logo from blob
200 - get
/bff/organisation/localesbffGet organisation locales
200 - get
/bff/organisation/membersbffList organisation members (simple)
200 - delete
/bff/organisation/print-logobffRemove print logo
200 - get
/bff/organisation/profilebffGet organisation profile
200 - post
/bff/organisation/save-localesbffSave organisation locales
200 - get
/bff/organisation/timezonesbffList available timezones
200 - post
/bff/organisation/update-profilebffUpdate organisation profile
200 - get
/bff/organisation/vat-ratesbffGet VAT rates
200
Workflow
15 operations · methods: POST · GET
- post
/bff/workflow/add-statusbffAdd workflow status
200 - post
/bff/workflow/assign-group-statusbffAssign status to order group
200 - post
/bff/workflow/assign-group-templatebffAssign email template to group status
200 - post
/bff/workflow/group-addbffCreate order group
200 - get
/bff/workflow/group-listbffList order groups
200 - post
/bff/workflow/group-set-invoice-issuerbffSet invoice-issuer contact for an order group
200 - post
/bff/workflow/group-set-payment-gatewaybffSet payment-gateway preference for an order group
200 - post
/bff/workflow/group-set-positionbffReorder order group
200 - get
/bff/workflow/group-templatesbffList group email templates
200 - post
/bff/workflow/group-updatebffUpdate order group
200 - post
/bff/workflow/remove-group-statusbffRemove status from order group
200 - post
/bff/workflow/remove-group-templatebffRemove email template from group status
200 - post
/bff/workflow/set-status-positionbffChange workflow status position
200 - get
/bff/workflow/statusbffGet workflow status list
200 - post
/bff/workflow/updatebffUpdate workflow status
200
Calendar Event
14 operations · methods: POST · GET
- post
/bff/calendar/event-addbffCreate calendar event
200 - get
/bff/calendar/event-detailbffGet full event detail
200 - get
/bff/calendar/event-download-icsbffDownload event as ICS file
200 - post
/bff/calendar/event-editbffEdit calendar event
200 - post
/bff/calendar/event-find-conflictbffFind calendar event conflicts
200 - post
/bff/calendar/event-make-recurringbffConvert a single event into a recurring series
200 - post
/bff/calendar/event-retry-accessbffRetry lock access code generation for an event
200 - post
/bff/calendar/event-stornobffStorno single calendar event
200 - post
/bff/calendar/event-storno-seriesbffStorno entire recurring event series
200 - post
/bff/calendar/event-type-addbffAdd event type
200 - get
/bff/calendar/event-type-gridbffList event types for settings grid
200 - get
/bff/calendar/event-type-listbffList event types
200 - get
/bff/calendar/event-unlock-nowbffUnlock smart lock now
200 - get
/bff/calendar/upcoming-without-accessbffUpcoming events without a working lock access code
200
Invoice
14 operations · methods: POST · GET
- post
/bff/invoice/clonebffClone invoice as a new draft
200 - get
/bff/invoice/detailbffInvoice detail
200 - get
/bff/invoice/exportbffExport invoices
200 - get
/bff/invoice/export-isdocbffExport invoice as ISDOC 6.0.2
200 - get
/bff/invoice/export-pohodabffExport invoice as Pohoda XML (Stormware data package)
200 - get
/bff/invoice/listbffList invoices
200 - post
/bff/invoice/lock-snapshotbffLock invoice immutability snapshot
200 - post
/bff/invoice/mark-as-paidbffMark invoice as paid
200 - post
/bff/invoice/send-reminderbffSend overdue payment reminder for one invoice
200 - post
/bff/invoice/send-reminders-bulkbffSend overdue payment reminders for multiple invoices
200 - get
/bff/invoice/statsbffInvoice statistics
200 - get
/bff/invoice/typesbffList invoice types
200 - post
/bff/invoice/update-notesbffUpdate invoice notes
200 - post
/bff/invoice/update-statusbffUpdate invoice status
200
Issue
12 operations · methods: POST · GET
- post
/bff/issue/add-commentbffAdd comment
200 - get
/bff/issue/commentsbffList issue comments
200 - post
/bff/issue/createbffCreate issue
200 - get
/bff/issue/detailbffGet issue detail
200 - get
/bff/issue/listbffList issues
200 - post
/bff/issue/run-ai-workflowbffRun AI workflow
200 - post
/bff/issue/set-spambffSet spam status
200 - get
/bff/issue/statisticsbffGet statistics
200 - get
/bff/issue/statusesbffList statuses
200 - post
/bff/issue/support-createbffCreate support ticket against BizKitHub
200 - get
/bff/issue/support-listbffList support tickets filed by current organisation
200 - post
/bff/issue/updatebffUpdate issue
200
Terminal
12 operations · methods: GET · POST · DELETE
- get
/bff/terminal/aliasesbffGet user aliases
200 - post
/bff/terminal/aliasesbffCreate or update alias
200 - delete
/bff/terminal/aliasesbffDelete alias
200 - post
/bff/terminal/cancelbffCancel running command
200 - get
/bff/terminal/commandsbffGet available commands
200 - post
/bff/terminal/executebffExecute terminal command
200 - post
/bff/terminal/execute-streambffExecute terminal command with SSE streaming
200 - get
/bff/terminal/historybffGet command history
200 - delete
/bff/terminal/historybffClear command history
200 - post
/bff/terminal/interactbffRespond to interactive prompt
200 - post
/bff/terminal/sessionbffInitialize terminal session
200 - get
/bff/terminal/suggestbffGet autocomplete suggestions
200
Voucher
12 operations · methods: POST · GET
- post
/bff/voucher/addbffCreate new voucher
200 - get
/bff/voucher/analyzebffAnalyze voucher code
200 - post
/bff/voucher/bulk-createbffBulk-create vouchers
200 - get
/bff/voucher/check-code-availablebffCheck voucher code availability
200 - get
/bff/voucher/dashboard-summarybffVoucher dashboard summary (KPI tiles)
200 - post
/bff/voucher/deactivatebffDeactivate voucher
200 - get
/bff/voucher/detailbffGet voucher detail
200 - get
/bff/voucher/full-detailbffGet comprehensive voucher detail
200 - get
/bff/voucher/listbffList vouchers
200 - get
/bff/voucher/statisticsbffGet voucher statistics
200 - post
/bff/voucher/updatebffUpdate existing voucher
200 - get
/bff/voucher/usage-historybffGet voucher usage history
200
Admin
11 operations · methods: POST · GET
- post
/bff/admin/add-memberbffAdd member to organisation
200 - post
/bff/admin/add-self-as-rootbffAdd the calling internal admin as a root member
200 - post
/bff/admin/block-memberbffBlock organisation member
200 - get
/bff/admin/member-detailbffGet member detail
200 - get
/bff/admin/member-listbffList organisation members
200 - get
/bff/admin/organisation-detailbffGet organisation detail
200 - get
/bff/admin/organisation-listbffList organisations
200 - post
/bff/admin/set-member-rootbffGrant or revoke root permission on a member
200 - post
/bff/admin/switch-to-organisationbffSwitch to organisation
200 - get
/bff/admin/system-logbffView system log
200 - get
/bff/admin/user-organisationsbffList user organisations
200
Contract
11 operations · methods: POST · GET
- post
/bff/contract/createbffCreate contract
200 - post
/bff/contract/deletebffDelete contract
200 - get
/bff/contract/detailbffGet contract detail
200 - post
/bff/contract/finalizebffFinalize contract
200 - get
/bff/contract/listbffList contracts
200 - post
/bff/contract/party/addbffAdd contract party
200 - post
/bff/contract/party/removebffRemove contract party
200 - get
/bff/contract/pdf-previewbffPreview contract as PDF
200 - get
/bff/contract/template/detailbffGet contract template detail
200 - get
/bff/contract/template/listbffList contract templates
200 - post
/bff/contract/updatebffUpdate contract
200
Crm Dashboard
11 operations · methods: GET · POST
- get
/bff/crm/action-itemsbffList the operator's action items (Akce pro tebe)
200 - post
/bff/crm/action-items/dismissbffDismiss an action-item category
200 - post
/bff/crm/action-items/restorebffRestore a previously dismissed action-item category
200 - post
/bff/crm/action-items/restore-allbffRestore all dismissals for the current member
200 - get
/bff/crm/aging-payablesbffAging of payables
200 - get
/bff/crm/aging-receivablesbffAging of receivables
200 - get
/bff/crm/churn-riskbffClients at risk of churn
200 - get
/bff/crm/concentrationbffCustomer concentration risk (Pareto)
200 - get
/bff/crm/payment-healthbffDSO + punctuality + payment-time histogram
200 - get
/bff/crm/top-clientsbffTop clients ranked by CZK revenue
200 - get
/bff/crm/top-vendorsbffTop vendors ranked by CZK costs
200
Expense
11 operations · methods: POST · GET
- post
/bff/expense/approvebffApprove expense (records status=approved)
200 - post
/bff/expense/attachment-addbffAttach a blob to an expense
200 - post
/bff/expense/attachment-removebffRemove an expense attachment
200 - post
/bff/expense/createbffCreate expense
200 - post
/bff/expense/deletebffSoft-delete expense
200 - get
/bff/expense/detailbffGet expense detail — record timeline
200 - get
/bff/expense/listbffList expense ledger entries
200 - post
/bff/expense/mark-paidbffMark expense paid
200 - post
/bff/expense/record-addbffAppend a record (state change / comment / attachment) to an expense
200 - post
/bff/expense/rejectbffReject expense (records status=rejected)
200 - post
/bff/expense/updatebffUpdate expense (payer + supplier swaps allowed on any status)
200
Cart
10 operations · methods: POST · GET
- post
/api/v1/cart/buyAdd product to cart
200 - post
/api/v1/cart/change-quantityChange cart item quantity
200 - get
/api/v1/cart/detailGet cart detail
200 - post
/api/v1/cart/set-deliverySet cart delivery method
200 - post
/api/v1/cart/set-packeta-branchSet Packeta pickup branch
200 - post
/api/v1/cart/set-paymentSet cart payment method
200 - post
/bff/cart/deletebffDelete cart
200 - get
/bff/cart/detailbffGet cart detail
200 - get
/bff/cart/listbffList shopping carts
200 - get
/bff/cart/statsbffCart statistics
200
Contact Credit
10 operations · methods: POST · GET
- post
/bff/contact-credit/createbffCreate credit transaction
200 - get
/bff/contact-credit/credit-by-payer-branchbffList credit transactions paid by branch
200 - get
/bff/contact-credit/expiration-breakdownbffGet a breakdown of a contact's currently open credits grouped by expiration date
200 - get
/bff/contact-credit/listbffGet contact credit history
200 - post
/bff/contact-credit/reason/createbffCreate credit reason
200 - post
/bff/contact-credit/reason/deletebffSoft-delete credit reason
200 - get
/bff/contact-credit/reason/detailbffGet credit reason detail
200 - get
/bff/contact-credit/reason/listbffList credit reasons
200 - get
/bff/contact-credit/reason/list-selectboxbffList credit reasons for selectbox
200 - post
/bff/contact-credit/reason/updatebffUpdate credit reason
200
Vikitron
9 operations · methods: POST · GET
- post
/api/v1/vikitron/crawl-startStart on-demand crawl
200 - get
/api/v1/vikitron/crawl-statusGet crawl status
200 - get
/api/v1/vikitron/dns-explorerSearch DNS records
200 - get
/api/v1/vikitron/dns-records-checkerCheck DNS records for a domain
200 - get
/api/v1/vikitron/ip-lookupIP address lookup
200 - get
/api/v1/vikitron/robots-txt-checkerCheck robots.txt history
200 - get
/api/v1/vikitron/ssl-certificate-checkerCheck SSL certificate
200 - get
/api/v1/vikitron/subdomain-finderFind subdomains
200 - get
/api/v1/vikitron/tor-ip-listList known Tor exit nodes
200
Bff
8 operations · methods: POST · GET
- post
/bff/ai/questionbffAsk AI a question and get a complete response
200 - post
/bff/ai/question-streambffAsk AI a question with SSE streaming response
200 - get
/bff/ai/testbffTest AI connectivity with a sample question
200 - get
/bff/newsletter/job-contact-listbff200 - get
/bff/test/connect-import-feedbff200 - get
/bff/test/pdfbff200 - get
/bff/test/pingbff200 - get
/bff/test/product-import-feedbff200
Newsletter
8 operations · methods: POST · GET
- post
/api/v1/newsletter/register-contactRegister newsletter contact
200 - post
/bff/newsletter/bulk-importbffBulk import newsletter subscribers
200 - get
/bff/newsletter/job-listbffList newsletter jobs
200 - get
/bff/newsletter/job-previewbffPreview newsletter job email
200 - post
/bff/newsletter/job-run-actionbffRun action on newsletter job
200 - get
/bff/newsletter/job-statisticsbffGet job sending statistics
200 - post
/bff/newsletter/job-update-contentbffEdit newsletter job content
200 - get
/bff/newsletter/listbffList newsletter subscribers
200
Newsroom
8 operations · methods: GET · POST
- get
/bff/newsroom/draft/{draftId}bffGet draft detail
200 - post
/bff/newsroom/draft/{draftId}/publish-as-postbffPublish draft as Post
200 - post
/bff/newsroom/enrichbffEnrich pending RSS articles
200 - post
/bff/newsroom/rebuild-shortlistbffRebuild newsroom shortlist
200 - post
/bff/newsroom/run-pipelinebffRun newsroom daily pipeline
200 - get
/bff/newsroom/shortlistbffList newsroom shortlist
200 - post
/bff/newsroom/shortlist/{shortlistId}/dismissbffDismiss shortlist item
200 - post
/bff/newsroom/shortlist/{shortlistId}/generate-draftbffGenerate article draft
200
Post Category
8 operations · methods: POST · GET
- post
/bff/post-category/createbffCreate new post category
200 - post
/bff/post-category/deletebffDelete post category
200 - get
/bff/post-category/detailbffGet category detail
200 - get
/bff/post-category/listbffList all post categories
200 - get
/bff/post-category/list-selectorbffList categories for selector
200 - post
/bff/post-category/savebffEdit post category
200 - post
/bff/post-category/toggle-activebffToggle category active status
200 - get
/bff/post-category/treebffGet category tree
200
Address
7 operations · methods: POST · GET
- post
/api/v1/address/createCreate new address
200 - get
/api/v1/address/listList customer addresses
200 - get
/api/v1/address/load-address-by-company-registration-numberLoad address from business registry
200 - post
/api/v1/address/updateUpdate existing address
200 - post
/bff/address/createbffCreate a new address
200 - get
/bff/address/detailbffGet address detail
200 - post
/bff/address/updatebffUpdate an existing address
200
Api Key
7 operations · methods: GET · POST
- get
/bff/api-key/detailbffGet API key detail with usage statistics
200 - post
/bff/api-key/generate-keybffGenerate new API key
200 - post
/bff/api-key/invalidate-keybffInvalidate API key
200 - get
/bff/api-key/listbffList API keys
200 - get
/bff/api-key/scope/detailbffGet scopes assigned to an API key
200 - get
/bff/api-key/scope/listbffList available API key scopes
200 - post
/bff/api-key/scope/setbffSet API key scopes
200
Cms
7 operations · methods: POST · GET · PUT
- post
/bff/cms/create-organisation-checkbffCheck organisation name availability
200 - get
/bff/cms/menubffGet navigation menu
200 - get
/bff/cms/menu/pinsbffList pinned menu items
200 - put
/bff/cms/menu/pinsbffReplace pinned menu items
200 - post
/bff/cms/organisation-createbffCreate new organisation
200 - post
/bff/cms/switch-localebffSwitch user locale
200 - post
/bff/cms/switch-organisationbffSwitch organisation context
200
Post Tags
7 operations · methods: POST · DELETE · GET
- post
/bff/post-tag/createbffCreate new tag
200 - delete
/bff/post-tag/deletebffDeactivate tag
200 - get
/bff/post-tag/detailbffTag detail
200 - get
/bff/post-tag/listbffList all organisation tags
200 - get
/bff/post-tag/post-tagsbffList post tags
200 - post
/bff/post-tag/syncbffSync post tags
200 - post
/bff/post-tag/updatebffUpdate tag
200
Routing
7 operations · methods: GET · POST
- get
/api/v1/routing/routeResolve URL route
200 - post
/bff/routing/addbffCreate route
200 - post
/bff/routing/deletebffDelete route
200 - get
/bff/routing/listbffList routes
200 - post
/bff/routing/set-canonicalbffSet canonical route
200 - get
/bff/routing/type-listbffList route types
200 - post
/bff/routing/updatebffUpdate route
200
Rss Feed
7 operations · methods: GET · POST
- get
/bff/rss-feed/{feedId}/newsroom-shortlistbffList Newsroom shortlist items for a feed
200 - post
/bff/rss-feed/addbffAdd RSS feed
200 - get
/bff/rss-feed/detailbffGet RSS feed detail
200 - get
/bff/rss-feed/listbffList RSS feeds
200 - get
/bff/rss-feed/post-listbffList RSS feed posts
200 - post
/bff/rss-feed/set-activebffSet RSS feed active flag
200 - post
/bff/rss-feed/syncbffSync RSS feeds
200
Time Tracker
7 operations · methods: PATCH · DELETE · GET · POST
- patch
/bff/time-tracker/{id}bffUpdate a time entry
200 - delete
/bff/time-tracker/{id}bffDelete a time entry (only when not invoiced).
200 - get
/bff/time-tracker/listbffList time entries
200 - get
/bff/time-tracker/runningbffCurrently running stopwatch entry
200 - post
/bff/time-tracker/startbffStart a stopwatch measurement
200 - post
/bff/time-tracker/stopbffStop a stopwatch measurement
200 - post
/bff/time-tracker/writebffCreate a manual time entry
200
Branch Cost
6 operations · methods: POST · GET
- post
/bff/branch-cost/createbffCreate a recurring branch cost
200 - post
/bff/branch-cost/deletebffSoft-delete a branch cost
200 - post
/bff/branch-cost/editbffEdit an existing branch cost
200 - post
/bff/branch-cost/entry-upsertbffSet the monthly value for a variable cost (idempotent upsert)
200 - get
/bff/branch-cost/listbffList recurring branch cost definitions
200 - get
/bff/branch-cost/monthly-breakdownbffPer-month × per-cost matrix for the Costs tab
200
Drive
6 operations · methods: POST · GET
- post
/bff/drive/create-directorybffCreate a new directory
200 - get
/bff/drive/detailbffGet file detail
200 - get
/bff/drive/download-directorybffDownload directory as ZIP
200 - get
/bff/drive/listbffList directory contents
200 - post
/bff/drive/renamebffRename a file
200 - get
/bff/drive/viewerbffView/stream file content
200
Permission
6 operations · methods: POST · GET
- post
/bff/permission/entity-share-addbffGrant a member direct access to an entity
200 - get
/bff/permission/entity-share-listbffList members with access to an entity
200 - post
/bff/permission/entity-share-removebffRevoke a member’s direct access to an entity
200 - get
/bff/permission/member-entity-pickerbffList entities of a type with per-row "isShared" flag for one member
200 - get
/bff/permission/member-entity-summarybffSummarise per-entity-type access for one member
200 - get
/bff/permission/shareable-entitiesbffList entity types that support per-entity sharing
200
Purchase Invoice
6 operations · methods: POST · GET
- post
/bff/purchase-invoice/createbffCreate a new purchase invoice (draft) with items
200 - post
/bff/purchase-invoice/deletebffForce-delete a purchase invoice (irreversible)
200 - get
/bff/purchase-invoice/detailbffPurchase invoice detail (header + items + log)
200 - get
/bff/purchase-invoice/listbffList purchase (received) invoices
200 - get
/bff/purchase-invoice/statsbffKPI breakdown — counts/sums per status + overdue + YTD.
200 - post
/bff/purchase-invoice/statusbffTransition status (draft → received → booked → paid)
200
Settings
6 operations · methods: POST · GET
- post
/bff/settings/env-change-variable-valuebffChange environment variable
200 - get
/bff/settings/env-variable-valuebffGet environment variable value
200 - get
/bff/settings/env-variablesbffList environment variables
200 - post
/bff/settings/ip-ban-addbffBan an IP address
200 - get
/bff/settings/ip-ban-listbffList banned IP addresses
200 - post
/bff/settings/ip-ban-removebffRemove IP ban
200
Tariff
6 operations · methods: POST · GET
- post
/bff/tariff/assignbffAssign tariff to organisation
200 - get
/bff/tariff/currentbffGet current tariff, usage, and history
200 - get
/bff/tariff/listbffList available tariffs
200 - post
/bff/tariff/seed-plansbffSeed standard tariff plans
200 - post
/bff/tariff/set-billingbffSet per-organisation billing (custom price + paid-until)
200 - post
/bff/tariff/set-discountbffSet tariff discount (legacy — prefer /tariff/set-billing)
200
Accounting Entity
5 operations · methods: POST · GET
- post
/bff/accounting-entity/createbffCreate accounting entity
200 - post
/bff/accounting-entity/deletebffSoft-delete accounting entity
200 - get
/bff/accounting-entity/listbffList accounting entities of the organisation
200 - post
/bff/accounting-entity/set-defaultbffPromote accounting entity to default
200 - post
/bff/accounting-entity/updatebffUpdate accounting entity
200
Bank Account
5 operations · methods: GET · POST · DELETE
- get
/bff/bank-account/bffList organisation bank accounts
200 - post
/bff/bank-account/bffAdd or re-activate an organisation bank account
200 - delete
/bff/bank-account/{externalId}bffSoft-delete a bank account
200 - post
/bff/bank-account/{externalId}/updatebffUpdate editable bank account fields
200 - post
/bff/bank-account/sync-mfcrbffSync MFCR-published bank accounts
200
Docs
5 operations · methods: GET
Log
5 operations · methods: GET · POST
Tax
5 operations · methods: POST · GET
- post
/bff/tax/epo/generatebffBuild + archive an EPO XML; runs XSD validation, persists to core__tax_submission.
200 - get
/bff/tax/epo/listbffList archived tax submissions.
200 - post
/bff/tax/epo/previewbffBuild an EPO XML preview without archiving (used for the "Preview" tab in /tax/epo).
200 - get
/bff/tax/vat-book/pdfbffDownload the VAT book as a landscape A4 PDF.
200 - get
/bff/tax/vat-book/rowsbffVAT book rows for the admin browser.
200
Transaction
5 operations · methods: POST · GET
- post
/bff/transaction/add-api-tokenbffConnect a bank account
200 - get
/bff/transaction/category-listbffTransaction categories with totals
200 - post
/bff/transaction/import-gpcbffImport a GPC/ABO bank statement
200 - get
/bff/transaction/listbffList bank transactions
200 - get
/bff/transaction/sync-allbffSync all bank transactions
200
Currency
4 operations · methods: POST · GET
Domain
4 operations · methods: POST · GET
Lead
4 operations · methods: POST · GET
Project
4 operations · methods: GET · DELETE · POST
Project Rate
4 operations · methods: DELETE · POST · GET
Activity
3 operations · methods: GET
Blob
3 operations · methods: POST · GET
Disk
3 operations · methods: POST
Firewall
3 operations · methods: GET
Import
3 operations · methods: POST · GET
Notification
3 operations · methods: GET · POST
Ping
3 operations · methods: GET
Vat Classification
3 operations · methods: GET · POST
Vendor
3 operations · methods: GET · POST
Admin Observability
2 operations · methods: GET
Analytics
2 operations · methods: GET
Crm
2 operations · methods: POST · GET
Documentation
2 operations · methods: GET
Ecommerce
2 operations · methods: GET
Order Payment
2 operations · methods: GET · POST
Payment
2 operations · methods: GET
Post Feedback
2 operations · methods: POST · GET
Search
2 operations · methods: GET
Security
2 operations · methods: GET
Subscription
2 operations · methods: GET · POST
Tracking
2 operations · methods: GET · POST
Vat Rate
2 operations · methods: GET
Webpage
2 operations · methods: GET
Bank
1 operation · methods: GET
Dev
1 operation · methods: GET
Ip Info
1 operation · methods: GET
Link Shorten
1 operation · methods: POST
Locale
1 operation · methods: GET
Packeta
1 operation · methods: GET
Person
1 operation · methods: GET
Presence
1 operation · methods: POST
Rate Limit Status
1 operation · methods: GET
Referral
1 operation · methods: GET
Service Status
1 operation · methods: GET
Support
1 operation · methods: POST
Translate
1 operation · methods: POST
Usage
1 operation · methods: GET