Gestiono

API Reference (non-admin endpoints)

Full route reference generated from backend files, grouped by route file, with a live tester.

This section documents every non-admin endpoint currently mounted in the backend server. Endpoints are grouped in the menu using the same route-file structure found in backend/src/routes.

  • 62 route-file groups
  • 477 total endpoints
  • 425 authenticated endpoints / 52 public endpoints

Test endpoints directly from docs

Set auth mode, edit path/query/body payloads, and send requests in place. This makes it easy to validate real responses while reading each endpoint description.

1. Configure authentication for testing

You can test endpoints with signed API keys, a raw Authorization token, or browser cookies. Select one mode and fill in the required fields.

2. Select endpoint

GET/v1/billingPublic endpoint

Group: Billing

GET /v1/billing • described through route-level inference

  • This endpoint can be called without an authenticated session.
0

3. Prepare request payload

4. Server response

Run a request to inspect the real-time response for your environment.

Groups and endpoints

Each group below corresponds to a backend route file. You can open endpoint pages for group-specific intros, details, and an endpoint-focused tester.

Billing

GET/v1/billingPublic endpoint

Get Billing

GET /v1/billing • described through route-level inference

GET/v1/billing/checkoutPublic endpoint

Get Billing checkout

GET /v1/billing/checkout • typed through route generics

GET/v1/billing/portalAuth required

Get Billing portal

GET /v1/billing/portal • typed through route generics

GET/v1/billing/subscriptionAuth required

Get Billing subscription

GET /v1/billing/subscription • described through route-level inference

GET/v1/billing/payment-historyAuth required

Get Billing payment history

GET /v1/billing/payment-history • described through route-level inference

POST/v1/billing/webhookPublic endpoint

Create Billing webhook

POST /v1/billing/webhook • described through route-level inference

Pay / Payment

POST/v1/payment/webhookPublic endpoint

Create Payment webhook

POST /v1/payment/webhook • described through route-level inference

POST/v1/payment/change-payouts-intervarPublic endpoint

Create Payment change payouts intervar

POST /v1/payment/change-payouts-intervar • described through route-level inference

POST/v1/payment/request-payoutAuth required

Create Payment request payout

POST /v1/payment/request-payout • described through route-level inference

User

POST/v1/user/loginPublic endpoint

Create User login

POST /v1/user/login • typed through route generics

GET/v1/user/login/pinRequestPublic endpoint

Get User login pinrequest

GET /v1/user/login/pinRequest • typed through route generics

POST/v1/user/login/verifyPinPublic endpoint

Create User login verifypin

POST /v1/user/login/verifyPin • typed through route generics

POST/v1/user/login/controllerAuth required

Create User login controller

POST /v1/user/login/controller • typed through route generics

DELETE/v1/user/logoutAuth required

Delete User logout

DELETE /v1/user/logout • described through route-level inference

GET/v1/user/tokenAuth required

Get User token

GET /v1/user/token • described through route-level inference

POST/v1/user/subscribeAuth required

Create User subscribe

POST /v1/user/subscribe • described through route-level inference

DELETE/v1/userAuth required

Delete User

DELETE /v1/user • described through route-level inference

Passkey

GET/v1/passkey/checkPublic endpoint

Get Passkey check

GET /v1/passkey/check • typed through route generics

POST/v1/passkey/register/startAuth required

Create Passkey register start

POST /v1/passkey/register/start • typed through route generics

POST/v1/passkey/register/finishAuth required

Create Passkey register finish

POST /v1/passkey/register/finish • typed through route generics

POST/v1/passkey/authenticate/startPublic endpoint

Create Passkey authenticate start

POST /v1/passkey/authenticate/start • typed through route generics

POST/v1/passkey/authenticate/finishPublic endpoint

Create Passkey authenticate finish

POST /v1/passkey/authenticate/finish • typed through route generics

PATCH/v1/passkeyAuth required

Update Passkey

PATCH /v1/passkey • typed through route generics

DELETE/v1/passkeyAuth required

Delete Passkey

DELETE /v1/passkey • typed through route generics

Organization

POST/v1/organizationAuth required

Create Organization

POST /v1/organization • typed through route generics

GET/v1/organizationAuth required

Get Organization

GET /v1/organization • typed through route generics

GET/v1/organization/referralsAuth required

Get Organization referrals

GET /v1/organization/referrals • typed through route generics

PATCH/v1/organizationAuth required

Update Organization

PATCH /v1/organization • typed through route generics

POST/v1/organization/activeAuth required

Create Organization active

POST /v1/organization/active • described through route-level inference

POST/v1/organization/inviteAuth required

Create Organization invite

POST /v1/organization/invite • typed through route generics

PATCH/v1/organization/inviteAuth required

Update Organization invite

PATCH /v1/organization/invite • typed through route generics

DELETE/v1/organization/inviteAuth required

Delete Organization invite

DELETE /v1/organization/invite • described through route-level inference

POST/v1/organization/owner/transferAuth required

Create Organization owner transfer

POST /v1/organization/owner/transfer • typed through route generics

POST/v1/organization/leaveAuth required

Create Organization leave

POST /v1/organization/leave • described through route-level inference

GET/v1/organization/usersAuth required

Get Organization users

GET /v1/organization/users • typed through route generics

GET/v1/organization/webhookAuth required

Get Organization webhook

GET /v1/organization/webhook • typed through route generics

GET/v1/organization/webhook/:webhookIdAuth required

Get Organization webhook by webhookid

GET /v1/organization/webhook/:webhookId • typed through route generics

POST/v1/organization/webhookAuth required

Create Organization webhook

POST /v1/organization/webhook • validated by `postWebhook`

POST/v1/organization/webhook/results/by-payloadAuth required

Create Organization webhook results by payload

POST /v1/organization/webhook/results/by-payload • typed through route generics

PATCH/v1/organization/webhookAuth required

Update Organization webhook

PATCH /v1/organization/webhook • validated by `patchWebhook`

DELETE/v1/organization/webhookAuth required

Delete Organization webhook

DELETE /v1/organization/webhook • typed through route generics

POST/v1/organization/webhook/testAuth required

Create Organization webhook test

POST /v1/organization/webhook/test • typed through route generics

POST/v1/organization/webhook/retryAuth required

Create Organization webhook retry

POST /v1/organization/webhook/retry • typed through route generics

GET/v1/organization/settingsAuth required

Get Organization settings

GET /v1/organization/settings • typed through route generics

PATCH/v1/organization/settingsAuth required

Update Organization settings

PATCH /v1/organization/settings • validated by `organizationConfig`

PATCH/v1/organization/settings/userAuth required

Update Organization settings user

PATCH /v1/organization/settings/user • typed through route generics

PATCH/v1/organization/user/toggleAuth required

Update Organization user toggle

PATCH /v1/organization/user/toggle • typed through route generics

GET/v1/organization/user/notificationsAuth required

Get Organization user notifications

GET /v1/organization/user/notifications • typed through route generics

GET/v1/organization/eventsAuth required

Get Organization events

GET /v1/organization/events • typed through route generics

POST/v1/organization/partnerPublic endpoint

Create Organization partner

POST /v1/organization/partner • described through route-level inference

POST/v1/organization/log-errorPublic endpoint

Create Organization log error

POST /v1/organization/log-error • described through route-level inference

POST/v1/organization/commentAuth required

Create Organization comment

POST /v1/organization/comment • typed through route generics

GET/v1/organization/pay/createAuth required

Get Organization pay create

GET /v1/organization/pay/create • described through route-level inference

GET/v1/organization/pay/linkAuth required

Get Organization pay link

GET /v1/organization/pay/link • described through route-level inference

GET/v1/organization/pay/dashboardAuth required

Get Organization pay dashboard

GET /v1/organization/pay/dashboard • described through route-level inference

GET/v1/organization/activeAuth required

Get Organization active

GET /v1/organization/active • described through route-level inference

GET/v1/organization/import/historyAuth required

Get Organization import history

GET /v1/organization/import/history • typed through route generics

GET/v1/organization/stripe/payment-methodsAuth required

Get Organization stripe payment methods

GET /v1/organization/stripe/payment-methods • described through route-level inference

GET/v1/organization/customer/payment-methodsAuth required

Get Organization customer payment methods

GET /v1/organization/customer/payment-methods • described through route-level inference

DELETE/v1/organization/customer/payment-methods/:paymentMethodIdAuth required

Delete Organization customer payment methods by paymentmethodid

DELETE /v1/organization/customer/payment-methods/:paymentMethodId • described through route-level inference

POST/v1/organization/customer/setup-intentAuth required

Create Organization customer setup intent

POST /v1/organization/customer/setup-intent • described through route-level inference

GET/v1/organization/image/:organizationIdPublic endpoint

Get Organization image by organizationid

GET /v1/organization/image/:organizationId • described through route-level inference

Accounting / Pending Record

A pending record refers to documents (invoice, quote, order, loan) that can later be linked to records such as payments, credits, and accounting movements.

GET/v1/record/pending/allAuth required

Get Pending Record all

GET /v1/record/pending/all • described through route-level inference

POST/v1/record/pendingAuth required

Create Pending Record

POST /v1/record/pending • validated by `postPendingRecord`

POST/v1/record/pending/bulkAuth required

Create Pending Record bulk

POST /v1/record/pending/bulk • validated by `postPendingRecordBulk`

POST/v1/record/pending/loanAuth required

Create Pending Record loan

POST /v1/record/pending/loan • validated by `postLoan`

POST/v1/record/pending/cloneAuth required

Create Pending Record clone

POST /v1/record/pending/clone • validated by `postClonePendingRecord`

POST/v1/record/pending/create-fromAuth required

Create Pending Record create from

POST /v1/record/pending/create-from • validated by `postCreateFromPendingRecord`

PATCH/v1/record/pendingAuth required

Update Pending Record

PATCH /v1/record/pending • typed through route generics

DELETE/v1/record/pendingAuth required

Delete Pending Record

DELETE /v1/record/pending • typed through route generics

POST/v1/record/pending/elementAuth required

Create Pending Record element

POST /v1/record/pending/element • typed through route generics

PATCH/v1/record/pending/elementAuth required

Update Pending Record element

PATCH /v1/record/pending/element • typed through route generics

DELETE/v1/record/pending/elementAuth required

Delete Pending Record element

DELETE /v1/record/pending/element • typed through route generics

POST/v1/record/pending/element/taxesAuth required

Create Pending Record element taxes

POST /v1/record/pending/element/taxes • typed through route generics

DELETE/v1/record/pending/element/taxesPublic endpoint

Delete Pending Record element taxes

DELETE /v1/record/pending/element/taxes • typed through route generics

PATCH/v1/record/pending/payAuth required

Update Pending Record pay

PATCH /v1/record/pending/pay • validated by `payPendingRecord`

PATCH/v1/record/pending/pay/bulkAuth required

Update Pending Record pay bulk

PATCH /v1/record/pending/pay/bulk • validated by `payPendingRecordBulk`

GET/v1/record/pending/reportAuth required

Get Pending Record report

GET /v1/record/pending/report • described through route-level inference

GET/v1/record/pending/crm/metricsAuth required

Get Pending Record crm metrics

GET /v1/record/pending/crm/metrics • typed through route generics

GET/v1/record/pending/report/downloadAuth required

Get Pending Record report download

GET /v1/record/pending/report/download • described through route-level inference

POST/v1/record/pending/creditAuth required

Create Pending Record credit

POST /v1/record/pending/credit • validated by `postCredit`

GET/v1/record/pending/credit/resumeAuth required

Get Pending Record credit resume

GET /v1/record/pending/credit/resume • typed through route generics

GET/v1/record/pending/credit/:creditIdAuth required

Get Pending Record credit by creditid

GET /v1/record/pending/credit/:creditId • validated by `getCreditById`

POST/v1/record/pending/credit/tableAuth required

Create Pending Record credit table

POST /v1/record/pending/credit/table • typed through route generics

POST/v1/record/pending/credit/makeCreditPaymentAuth required

Create Pending Record credit makecreditpayment

POST /v1/record/pending/credit/makeCreditPayment • validated by `makeCreditPayment`

POST/v1/record/pending/credit/makeCapitalPaymentAuth required

Create Pending Record credit makecapitalpayment

POST /v1/record/pending/credit/makeCapitalPayment • validated by `makeCapitalPayment`

PATCH/v1/record/pending/linkAuth required

Update Pending Record link

PATCH /v1/record/pending/link • typed through route generics

GET/v1/record/pendingAuth required

Get Pending Record

GET /v1/record/pending • typed through route generics

GET/v1/record/pending/exportAuth required

Get Pending Record export

GET /v1/record/pending/export • typed through route generics

GET/v1/record/pending/recurrencyResumeAuth required

Get Pending Record recurrencyresume

GET /v1/record/pending/recurrencyResume • typed through route generics

POST/v1/record/pending/checkRecurrenciesAndCreateAuth required

Create Pending Record checkrecurrenciesandcreate

POST /v1/record/pending/checkRecurrenciesAndCreate • described through route-level inference

POST/v1/record/pending/givenRecurrencyAuth required

Create Pending Record givenrecurrency

POST /v1/record/pending/givenRecurrency • described through route-level inference

POST/v1/record/pending/nextRecurrencyAuth required

Create Pending Record nextrecurrency

POST /v1/record/pending/nextRecurrency • described through route-level inference

PATCH/v1/record/pending/linkCostAuth required

Update Pending Record linkcost

PATCH /v1/record/pending/linkCost • typed through route generics

PATCH/v1/record/pending/unlinkCostAuth required

Update Pending Record unlinkcost

PATCH /v1/record/pending/unlinkCost • typed through route generics

PATCH/v1/record/pending/templateAuth required

Update Pending Record template

PATCH /v1/record/pending/template • validated by `postPendingRecordTemplate`

GET/v1/record/pending/:shareId/dataPublic endpoint

Get Pending Record by shareid data

GET /v1/record/pending/:shareId/data • typed through route generics

GET/v1/record/pending/:invoiceId/voucherAuth required

Get Pending Record by invoiceid voucher

GET /v1/record/pending/:invoiceId/voucher • typed through route generics

GET/v1/record/pending/:pendingRecordId/shareAuth required

Get Pending Record by pendingrecordid share

GET /v1/record/pending/:pendingRecordId/share • described through route-level inference

POST/v1/record/pending/:pendingRecordId/share/emailAuth required

Create Pending Record by pendingrecordid share email

POST /v1/record/pending/:pendingRecordId/share/email • described through route-level inference

GET/v1/record/pending/sales/comissionsAuth required

Get Pending Record sales comissions

GET /v1/record/pending/sales/comissions • described through route-level inference

GET/v1/record/pending/:pendingRecordId/pay/:organizationIdPublic endpoint

Get Pending Record by pendingrecordid pay by organizationid

GET /v1/record/pending/:pendingRecordId/pay/:organizationId • described through route-level inference

GET/v1/record/pending/previousItems/:contactIdAuth required

Get Pending Record previousitems by contactid

GET /v1/record/pending/previousItems/:contactId • typed through route generics

GET/v1/record/pending/recommendedItemsAuth required

Get Pending Record recommendeditems

GET /v1/record/pending/recommendedItems • typed through route generics

GET/v1/record/pending/:pendingRecordIdAuth required

Get Pending Record by pendingrecordid

GET /v1/record/pending/:pendingRecordId • typed through route generics

V2 / Accounting / Pending Record

The v2 pending record endpoints focus on paginated retrieval and reporting-ready invoice lists.

GET/v2/record/pendingAuth required

Get Pending Record

GET /v2/record/pending • typed through route generics

GET/v2/record/pending/idsAuth required

Get Pending Record ids

GET /v2/record/pending/ids • typed through route generics

GET/v2/record/pending/itemsAuth required

Get Pending Record items

GET /v2/record/pending/items • typed through route generics

Accounting / Record

Record endpoints manage accounting entries already posted in your books, including listing, detail views, and updates.

POST/v1/recordAuth required

Create Record

POST /v1/record • typed through route generics

POST/v1/record/commissionAuth required

Create Record commission

POST /v1/record/commission • typed through route generics

GET/v1/record/resumeAuth required

Get Record resume

GET /v1/record/resume • typed through route generics

PATCH/v1/recordAuth required

Update Record

PATCH /v1/record • typed through route generics

DELETE/v1/recordAuth required

Delete Record

DELETE /v1/record • described through route-level inference

GET/v1/record/chartAuth required

Get Record chart

GET /v1/record/chart • described through route-level inference

GET/v1/record/reportAuth required

Get Record report

GET /v1/record/report • described through route-level inference

GET/v1/record/report/downloadAuth required

Get Record report download

GET /v1/record/report/download • described through route-level inference

GET/v1/record/:recordIdAuth required

Get Record by recordid

GET /v1/record/:recordId • typed through route generics

V2 / Accounting / Record

Accounting / Credit

Accounting / Account

POST/v1/accountAuth required

Create Account

POST /v1/account • validated by `postAccount`

PATCH/v1/accountAuth required

Update Account

PATCH /v1/account • validated by `patchAccount`

GET/v1/account/all/balance-historyAuth required

Get Account all balance history

GET /v1/account/all/balance-history • typed through route generics

GET/v1/account/:accountId/balance-historyAuth required

Get Account by accountid balance history

GET /v1/account/:accountId/balance-history • typed through route generics

POST/v1/account/transferAuth required

Create Account transfer

POST /v1/account/transfer • validated by `postAccountTransfer`

GET/v1/account/payoutsAuth required

Get Account payouts

GET /v1/account/payouts • described through route-level inference

GET/v1/account/payout-balancesAuth required

Get Account payout balances

GET /v1/account/payout-balances • described through route-level inference

POST/v1/account/payout-transferAuth required

Create Account payout transfer

POST /v1/account/payout-transfer • described through route-level inference

GET/v1/account/balanceAuth required

Get Account balance

GET /v1/account/balance • typed through route generics

GET/v1/account/:accountId/conciliation-transactionsAuth required

Get Account by accountid conciliation transactions

GET /v1/account/:accountId/conciliation-transactions • described through route-level inference

GET/v1/account/:accountId/conciliation-listAuth required

Get Account by accountid conciliation list

GET /v1/account/:accountId/conciliation-list • typed through route generics

POST/v1/account/:accountId/conciliationAuth required

Create Account by accountid conciliation

POST /v1/account/:accountId/conciliation • described through route-level inference

DELETE/v1/account/:accountId/conciliationAuth required

Delete Account by accountid conciliation

DELETE /v1/account/:accountId/conciliation • typed through route generics

Accounting / Chart Of Accounts

GET/v1/chart-of-accountsAuth required

Get Chart Of Accounts

GET /v1/chart-of-accounts • typed through route generics

POST/v1/chart-of-accountsAuth required

Create Chart Of Accounts

POST /v1/chart-of-accounts • validated by `postChartAccount`

PATCH/v1/chart-of-accountsAuth required

Update Chart Of Accounts

PATCH /v1/chart-of-accounts • validated by `patchChartAccount`

GET/v1/chart-of-accounts/:accountId/balance-with-sourcesAuth required

Get Chart Of Accounts by accountid balance with sources

GET /v1/chart-of-accounts/:accountId/balance-with-sources • validated by `getAccountBalanceWithSources`

POST/v1/chart-of-accounts/data-sourceAuth required

Create Chart Of Accounts data source

POST /v1/chart-of-accounts/data-source • validated by `postAccountDataSource`

PATCH/v1/chart-of-accounts/data-sourceAuth required

Update Chart Of Accounts data source

PATCH /v1/chart-of-accounts/data-source • validated by `patchAccountDataSource`

DELETE/v1/chart-of-accounts/data-source/:idAuth required

Delete Chart Of Accounts data source by id

DELETE /v1/chart-of-accounts/data-source/:id • validated by `deleteAccountDataSource`

Accounting / Division

POST/v1/divisionAuth required

Create Division

POST /v1/division • validated by `postDivision`

PATCH/v1/divisionAuth required

Update Division

PATCH /v1/division • validated by `patchDivision`

GET/v1/divisionAuth required

Get Division

GET /v1/division • typed through route generics

GET/v1/division/:divisionId/spent-chartAuth required

Get Division by divisionid spent chart

GET /v1/division/:divisionId/spent-chart • typed through route generics

GET/v1/division/balanceAuth required

Get Division balance

GET /v1/division/balance • typed through route generics

POST/v1/division/transferAuth required

Create Division transfer

POST /v1/division/transfer • validated by `postDivisionTransfer`

POST/v1/division/activeAuth required

Create Division active

POST /v1/division/active • described through route-level inference

GET/v1/division/:divisionIdAuth required

Get Division by divisionid

GET /v1/division/:divisionId • described through route-level inference

GET/v1/division/:divisionId/close-balanceAuth required

Get Division by divisionid close balance

GET /v1/division/:divisionId/close-balance • typed through route generics

GET/v1/division/:divisionId/close-listAuth required

Get Division by divisionid close list

GET /v1/division/:divisionId/close-list • typed through route generics

POST/v1/division/:divisionId/close-balanceAuth required

Create Division by divisionid close balance

POST /v1/division/:divisionId/close-balance • typed through route generics

DELETE/v1/division/:divisionId/close-balanceAuth required

Delete Division by divisionid close balance

DELETE /v1/division/:divisionId/close-balance • typed through route generics

Accounting / Project

POST/v1/projectAuth required

Create Project

POST /v1/project • validated by `postProject`

GET/v1/project/:projectIdAuth required

Get Project by projectid

GET /v1/project/:projectId • validated by `getProjectById`

Accounting / Beneficiary

GET/v1/beneficiary/exportAuth required

Get Beneficiary export

GET /v1/beneficiary/export • typed through route generics

POST/v1/beneficiaryAuth required

Create Beneficiary

POST /v1/beneficiary • validated by `postBeneficiary`

POST/v1/beneficiary/bulkAuth required

Create Beneficiary bulk

POST /v1/beneficiary/bulk • validated by `postBeneficiaryBulk`

PATCH/v1/beneficiaryAuth required

Update Beneficiary

PATCH /v1/beneficiary • validated by `patchBeneficiary`

PATCH/v1/beneficiary/bulk/archiveAuth required

Update Beneficiary bulk archive

PATCH /v1/beneficiary/bulk/archive • validated by `patchBeneficiaryBulkArchive`

GET/v1/beneficiaryAuth required

Get Beneficiary

GET /v1/beneficiary • typed through route generics

POST/v1/beneficiary/contactAuth required

Create Beneficiary contact

POST /v1/beneficiary/contact • validated by `postContact`

PATCH/v1/beneficiary/contactAuth required

Update Beneficiary contact

PATCH /v1/beneficiary/contact • validated by `updateContact`

GET/v1/beneficiary/contact/:contactDataIdAuth required

Get Beneficiary contact by contactdataid

GET /v1/beneficiary/contact/:contactDataId • typed through route generics

DELETE/v1/beneficiary/contact/:contactDataIdAuth required

Delete Beneficiary contact by contactdataid

DELETE /v1/beneficiary/contact/:contactDataId • typed through route generics

PATCH/v1/beneficiary/mergeAuth required

Update Beneficiary merge

PATCH /v1/beneficiary/merge • typed through route generics

GET/v1/beneficiary/:beneficiaryIdAuth required

Get Beneficiary by beneficiaryid

GET /v1/beneficiary/:beneficiaryId • typed through route generics

GET/v1/beneficiary/byId/:contactDataAuth required

Get Beneficiary byid by contactdata

GET /v1/beneficiary/byId/:contactData • typed through route generics

GET/v1/beneficiary/taxId/randomAuth required

Get Beneficiary taxid random

GET /v1/beneficiary/taxId/random • described through route-level inference

GET/v1/beneficiary/taxId/:taxIdAuth required

Get Beneficiary taxid by taxid

GET /v1/beneficiary/taxId/:taxId • described through route-level inference

GET/v1/beneficiary/tax-data/processAuth required

Get Beneficiary tax data process

GET /v1/beneficiary/tax-data/process • described through route-level inference

V2 / Accounting / Beneficiary

POST/v2/beneficiary/contactAuth required

Create Beneficiary contact

POST /v2/beneficiary/contact • validated by `postContactV2`

Accounting / Taxes

GET/v1/taxes/listAuth required

Get Taxes list

GET /v1/taxes/list • typed through route generics

GET/v1/taxes/numeralsAuth required

Get Taxes numerals

GET /v1/taxes/numerals • typed through route generics

POST/v1/taxes/numeralsAuth required

Create Taxes numerals

POST /v1/taxes/numerals • typed through route generics

PATCH/v1/taxes/numerals/:idAuth required

Update Taxes numerals by id

PATCH /v1/taxes/numerals/:id • typed through route generics

GET/v1/taxes/numerals/nextAuth required

Get Taxes numerals next

GET /v1/taxes/numerals/next • typed through route generics

GET/v1/taxes/numerals/next/allAuth required

Get Taxes numerals next all

GET /v1/taxes/numerals/next/all • described through route-level inference

GET/v1/taxes/numerals/current/allAuth required

Get Taxes numerals current all

GET /v1/taxes/numerals/current/all • described through route-level inference

GET/v1/taxes/606Auth required

Get Taxes 606

GET /v1/taxes/606 • typed through route generics

GET/v1/taxes/606/fileAuth required

Get Taxes 606 file

GET /v1/taxes/606/file • typed through route generics

GET/v1/taxes/607Auth required

Get Taxes 607

GET /v1/taxes/607 • typed through route generics

GET/v1/taxes/607/fileAuth required

Get Taxes 607 file

GET /v1/taxes/607/file • typed through route generics

Alanube

GET/v1/alanube/provider-infoAuth required

Get Alanube provider info

GET /v1/alanube/provider-info • described through route-level inference

GET/v1/alanube/companyAuth required

Get Alanube company

GET /v1/alanube/company • described through route-level inference

POST/v1/alanube/companyAuth required

Create Alanube company

POST /v1/alanube/company • described through route-level inference

POST/v1/alanube/sign-documentAuth required

Create Alanube sign document

POST /v1/alanube/sign-document • described through route-level inference

POST/v1/alanube/test-setAuth required

Create Alanube test set

POST /v1/alanube/test-set • described through route-level inference

GET/v1/alanube/test-setAuth required

Get Alanube test set

GET /v1/alanube/test-set • described through route-level inference

GET/v1/alanube/healthAuth required

Get Alanube health

GET /v1/alanube/health • described through route-level inference

GET/v1/alanube/test-set/progressAuth required

Get Alanube test set progress

GET /v1/alanube/test-set/progress • described through route-level inference

Accounting / Currency

GET/v1/currency/ratesAuth required

Get Currency rates

GET /v1/currency/rates • typed through route generics

Chats / Chat

POST/v1/chat/messageAuth required

Create Chat message

POST /v1/chat/message • typed through route generics

POST/v1/chat/whatsapp/templateAuth required

Create Chat whatsapp template

POST /v1/chat/whatsapp/template • typed through route generics

GET/v1/chat/media/:channelId/:mediaIdAuth required

Get Chat media by channelid by mediaid

GET /v1/chat/media/:channelId/:mediaId • described through route-level inference

GET/v1/chat/webhookPublic endpoint

Get Chat webhook

GET /v1/chat/webhook • described through route-level inference

POST/v1/chat/webhookPublic endpoint

Create Chat webhook

POST /v1/chat/webhook • typed through route generics

POST/v1/chat/webhook/whatsappPublic endpoint

Create Chat webhook whatsapp

POST /v1/chat/webhook/whatsapp • typed through route generics

V2 / Chats / Chat

GET/v2/chat/webhook/whatsappPublic endpoint

Get Chat webhook whatsapp

GET /v2/chat/webhook/whatsapp • described through route-level inference

POST/v2/chat/webhook/whatsappPublic endpoint

Create Chat webhook whatsapp

POST /v2/chat/webhook/whatsapp • typed through route generics

Chats / Channel

GET/v1/channel/:channelIdAuth required

Get Channel by channelid

GET /v1/channel/:channelId • typed through route generics

GET/v1/channel/:channelId/statsAuth required

Get Channel by channelid stats

GET /v1/channel/:channelId/stats • described through route-level inference

GET/v1/channel/:channelId/whatsapp/templatesAuth required

Get Channel by channelid whatsapp templates

GET /v1/channel/:channelId/whatsapp/templates • typed through route generics

POST/v1/channel/:channelId/whatsapp/templatesAuth required

Create Channel by channelid whatsapp templates

POST /v1/channel/:channelId/whatsapp/templates • typed through route generics

DELETE/v1/channel/:channelId/whatsapp/templates/:templateIdAuth required

Delete Channel by channelid whatsapp templates by templateid

DELETE /v1/channel/:channelId/whatsapp/templates/:templateId • typed through route generics

PATCH/v1/channelAuth required

Update Channel

PATCH /v1/channel • typed through route generics

PATCH/v1/channel/:channelId/toggle-stateAuth required

Update Channel by channelid toggle state

PATCH /v1/channel/:channelId/toggle-state • described through route-level inference

POST/v1/channelAuth required

Create Channel

POST /v1/channel • typed through route generics

GET/v1/channel/whatsapp/urlAuth required

Get Channel whatsapp url

GET /v1/channel/whatsapp/url • described through route-level inference

V2 / Chats / Channel

GET/v2/channel/whatsapp/accountsAuth required

Get Channel whatsapp accounts

GET /v2/channel/whatsapp/accounts • described through route-level inference

POST/v2/channel/whatsapp/subscribeAuth required

Create Channel whatsapp subscribe

POST /v2/channel/whatsapp/subscribe • described through route-level inference

GET/v2/channel/whatsapp/:phoneNumberId/pinAuth required

Get Channel whatsapp by phonenumberid pin

GET /v2/channel/whatsapp/:phoneNumberId/pin • described through route-level inference

POST/v2/channel/whatsapp/:phoneNumberId/pinAuth required

Create Channel whatsapp by phonenumberid pin

POST /v2/channel/whatsapp/:phoneNumberId/pin • described through route-level inference

POST/v2/channel/whatsapp/:phoneNumberId/linkAuth required

Create Channel whatsapp by phonenumberid link

POST /v2/channel/whatsapp/:phoneNumberId/link • typed through route generics

POST/v2/channel/whatsapp/addWabaAuth required

Create Channel whatsapp addwaba

POST /v2/channel/whatsapp/addWaba • described through route-level inference

GET/v2/channel/whatsapp/:wabaId/healthAuth required

Get Channel whatsapp by wabaid health

GET /v2/channel/whatsapp/:wabaId/health • described through route-level inference

Chats / Conversation

GET/v1/conversationAuth required

Get Conversation

GET /v1/conversation • typed through route generics

GET/v1/conversation/statsAuth required

Get Conversation stats

GET /v1/conversation/stats • typed through route generics

GET/v1/conversation/:idAuth required

Get Conversation by id

GET /v1/conversation/:id • typed through route generics

GET/v1/conversation/:channelId/:sourceIdAuth required

Get Conversation by channelid by sourceid

GET /v1/conversation/:channelId/:sourceId • typed through route generics

GET/v1/conversation/:channelId/:sourceId/metaAuth required

Get Conversation by channelid by sourceid meta

GET /v1/conversation/:channelId/:sourceId/meta • typed through route generics

GET/v1/conversation/:channelId/:sourceId/feedAuth required

Get Conversation by channelid by sourceid feed

GET /v1/conversation/:channelId/:sourceId/feed • typed through route generics

PATCH/v1/conversation/:channelId/:sourceId/seenAuth required

Update Conversation by channelid by sourceid seen

PATCH /v1/conversation/:channelId/:sourceId/seen • typed through route generics

PATCH/v1/conversationAuth required

Update Conversation

PATCH /v1/conversation • typed through route generics

POST/v1/conversationAuth required

Create Conversation

POST /v1/conversation • typed through route generics

PATCH/v1/conversation/:id/assignAuth required

Update Conversation by id assign

PATCH /v1/conversation/:id/assign • typed through route generics

POST/v1/conversation/:id/categorizeAuth required

Create Conversation by id categorize

POST /v1/conversation/:id/categorize • described through route-level inference

Chats / Conversation List

GET/v1/conversation-listAuth required

Get Conversation List

GET /v1/conversation-list • validated by `getConversationListsSchema`

GET/v1/conversation-list/:idAuth required

Get Conversation List by id

GET /v1/conversation-list/:id • validated by `getConversationListByIdSchema`

POST/v1/conversation-listAuth required

Create Conversation List

POST /v1/conversation-list • validated by `postConversationListSchema`

PATCH/v1/conversation-listAuth required

Update Conversation List

PATCH /v1/conversation-list • validated by `patchConversationListSchema`

DELETE/v1/conversation-listAuth required

Delete Conversation List

DELETE /v1/conversation-list • validated by `deleteConversationListSchema`

Chats / Diffusion

GET/v1/conversation-diffusionAuth required

Get Diffusion

GET /v1/conversation-diffusion • typed through route generics

GET/v1/conversation-diffusion/:idAuth required

Get Diffusion by id

GET /v1/conversation-diffusion/:id • validated by `getDiffusionByIdSchema`

POST/v1/conversation-diffusionAuth required

Create Diffusion

POST /v1/conversation-diffusion • validated by `postDiffusionSchema`

PATCH/v1/conversation-diffusionAuth required

Update Diffusion

PATCH /v1/conversation-diffusion • validated by `patchDiffusionSchema`

DELETE/v1/conversation-diffusionAuth required

Delete Diffusion

DELETE /v1/conversation-diffusion • validated by `deleteDiffusionSchema`

POST/v1/conversation-diffusion/:id/startAuth required

Create Diffusion by id start

POST /v1/conversation-diffusion/:id/start • validated by `startDiffusionSchema`

GET/v1/conversation-diffusion/:id/logsAuth required

Get Diffusion by id logs

GET /v1/conversation-diffusion/:id/logs • validated by `getDiffusionLogsSchema`

GET/v1/conversation-diffusion/:id/previewAuth required

Get Diffusion by id preview

GET /v1/conversation-diffusion/:id/preview • validated by `getDiffusionPreviewSchema`

V2 / Chats / Conversation

GET/v2/conversationAuth required

Get Conversation

GET /v2/conversation • typed through route generics

Chats / Bot

POST/v1/bot/trainingAuth required

Create Bot training

POST /v1/bot/training • validated by `postBotTraining`

PATCH/v1/bot/trainingAuth required

Update Bot training

PATCH /v1/bot/training • validated by `patchBotTraining`

GET/v1/bot/training/:botIdAuth required

Get Bot training by botid

GET /v1/bot/training/:botId • typed through route generics

DELETE/v1/bot/training/:botId/:idAuth required

Delete Bot training by botid by id

DELETE /v1/bot/training/:botId/:id • described through route-level inference

POST/v1/bot/answerAuth required

Create Bot answer

POST /v1/bot/answer • typed through route generics

POST/v1/bot/contextAuth required

Create Bot context

POST /v1/bot/context • typed through route generics

GET/v1/bot/:botId/context-requestsAuth required

Get Bot by botid context requests

GET /v1/bot/:botId/context-requests • described through route-level inference

GET/v1/bot/:botIdAuth required

Get Bot by botid

GET /v1/bot/:botId • typed through route generics

PATCH/v1/bot/:botIdAuth required

Update Bot by botid

PATCH /v1/bot/:botId • typed through route generics

Chats / Custom Tools

GET/v1/custom-toolsAuth required

Get Custom Tools

GET /v1/custom-tools • typed through route generics

GET/v1/custom-tools/:idAuth required

Get Custom Tools by id

GET /v1/custom-tools/:id • typed through route generics

POST/v1/custom-toolsAuth required

Create Custom Tools

POST /v1/custom-tools • typed through route generics

PUT/v1/custom-tools/:idAuth required

Replace Custom Tools by id

PUT /v1/custom-tools/:id • typed through route generics

DELETE/v1/custom-tools/:idAuth required

Delete Custom Tools by id

DELETE /v1/custom-tools/:id • typed through route generics

Resources / Record

POST/v1/resource/recordAuth required

Create Record

POST /v1/resource/record • validated by `postResourceRecord`

POST/v1/resource/record/bulkAuth required

Create Record bulk

POST /v1/resource/record/bulk • validated by `postBulkResourceRecord`

POST/v1/resource/record/bulk-stockAuth required

Create Record bulk stock

POST /v1/resource/record/bulk-stock • validated by `postBulkStockUpdate`

PATCH/v1/resource/recordAuth required

Update Record

PATCH /v1/resource/record • validated by `patchResourceRecord`

GET/v1/resource/recordAuth required

Get Record

GET /v1/resource/record • typed through route generics

Resources / Delivery

POST/v1/resource/deliveryAuth required

Create Delivery

POST /v1/resource/delivery • validated by `postDelivery`

PATCH/v1/resource/deliveryAuth required

Update Delivery

PATCH /v1/resource/delivery • validated by `patchDelivery`

GET/v1/resource/deliveryAuth required

Get Delivery

GET /v1/resource/delivery • typed through route generics

GET/v1/resource/delivery/mismatchesAuth required

Get Delivery mismatches

GET /v1/resource/delivery/mismatches • typed through route generics

POST/v1/resource/delivery/mismatches/fixAuth required

Create Delivery mismatches fix

POST /v1/resource/delivery/mismatches/fix • typed through route generics

GET/v1/resource/delivery/:deliveryIdAuth required

Get Delivery by deliveryid

GET /v1/resource/delivery/:deliveryId • described through route-level inference

Resources / Return

POST/v1/resource/returnAuth required

Create Return

POST /v1/resource/return • validated by `postReturn`

GET/v1/resource/returnAuth required

Get Return

GET /v1/resource/return • typed through route generics

PATCH/v1/resource/returnAuth required

Update Return

PATCH /v1/resource/return • typed through route generics

GET/v1/resource/return/:returnIdAuth required

Get Return by returnid

GET /v1/resource/return/:returnId • typed through route generics

V2 / Resources / Return

GET/v2/resource/returnAuth required

Get Return

GET /v2/resource/return • typed through route generics

Resources / Resource List

POST/v1/resource/resource-listAuth required

Create Resource List

POST /v1/resource/resource-list • typed through route generics

GET/v1/resource/resource-listAuth required

Get Resource List

GET /v1/resource/resource-list • typed through route generics

GET/v1/resource/resource-list/:listIdAuth required

Get Resource List by listid

GET /v1/resource/resource-list/:listId • typed through route generics

GET/v1/resource/resource-list/:listId/resourcesAuth required

Get Resource List by listid resources

GET /v1/resource/resource-list/:listId/resources • typed through route generics

PATCH/v1/resource/resource-listAuth required

Update Resource List

PATCH /v1/resource/resource-list • typed through route generics

DELETE/v1/resource/resource-listAuth required

Delete Resource List

DELETE /v1/resource/resource-list • typed through route generics

POST/v1/resource/resource-list/clear-cacheAuth required

Create Resource List clear cache

POST /v1/resource/resource-list/clear-cache • described through route-level inference

Resources / Discount Recommendation

GET/v1/resource/discount-recommendationAuth required

Get Discount Recommendation

GET /v1/resource/discount-recommendation • typed through route generics

POST/v1/resource/discount-recommendationAuth required

Create Discount Recommendation

POST /v1/resource/discount-recommendation • validated by `postDiscountRecommendation`

PATCH/v1/resource/discount-recommendationAuth required

Update Discount Recommendation

PATCH /v1/resource/discount-recommendation • validated by `patchDiscountRecommendation`

DELETE/v1/resource/discount-recommendationAuth required

Delete Discount Recommendation

DELETE /v1/resource/discount-recommendation • typed through route generics

Resources / Serial Numbers

GET/v1/resource/serial-numbersAuth required

Get Serial Numbers

GET /v1/resource/serial-numbers • typed through route generics

POST/v1/resource/serial-numbers/exportAuth required

Create Serial Numbers export

POST /v1/resource/serial-numbers/export • typed through route generics

GET/v1/resource/serial-numbers/export/historyAuth required

Get Serial Numbers export history

GET /v1/resource/serial-numbers/export/history • typed through route generics

GET/v1/resource/serial-numbers/export/download/:fileNameAuth required

Get Serial Numbers export download by filename

GET /v1/resource/serial-numbers/export/download/:fileName • described through route-level inference

GET/v1/resource/serial-numbers/:resourceId/:serialNumberAuth required

Get Serial Numbers by resourceid by serialnumber

GET /v1/resource/serial-numbers/:resourceId/:serialNumber • typed through route generics

PATCH/v1/resource/serial-numbers/:resourceId/:serialNumberAuth required

Update Serial Numbers by resourceid by serialnumber

PATCH /v1/resource/serial-numbers/:resourceId/:serialNumber • typed through route generics

GET/v1/resource/serial-numbers/:resourceIdAuth required

Get Serial Numbers by resourceid

GET /v1/resource/serial-numbers/:resourceId • typed through route generics

Resources / Position

GET/v1/resource/positionAuth required

Get Position

GET /v1/resource/position • typed through route generics

GET/v1/resource/position/:resourceId/:divisionIdAuth required

Get Position by resourceid by divisionid

GET /v1/resource/position/:resourceId/:divisionId • typed through route generics

POST/v1/resource/positionAuth required

Create Position

POST /v1/resource/position • validated by `postResourcePosition`

PATCH/v1/resource/positionAuth required

Update Position

PATCH /v1/resource/position • validated by `patchResourcePosition`

DELETE/v1/resource/positionAuth required

Delete Position

DELETE /v1/resource/position • validated by `deleteResourcePosition`

POST/v1/resource/position/bulkAuth required

Create Position bulk

POST /v1/resource/position/bulk • validated by `postBulkResourcePosition`

Resources / Resource

Resource endpoints let you create and maintain catalog items used across sales, purchasing, and inventory workflows.

GET/v1/resourceAuth required

Get Resource

GET /v1/resource • typed through route generics

GET/v1/resource/listAuth required

Get Resource list

GET /v1/resource/list • typed through route generics

POST/v1/resourceAuth required

Create Resource

POST /v1/resource • validated by `postResource`

PATCH/v1/resourceAuth required

Update Resource

PATCH /v1/resource • typed through route generics

PATCH/v1/resource/bulk/archiveAuth required

Update Resource bulk archive

PATCH /v1/resource/bulk/archive • validated by `patchResourceBulkArchive`

PATCH/v1/resource/priceAuth required

Update Resource price

PATCH /v1/resource/price • validated by `patchPriceTier`

POST/v1/resource/priceAuth required

Create Resource price

POST /v1/resource/price • validated by `postPriceTier`

DELETE/v1/resource/priceAuth required

Delete Resource price

DELETE /v1/resource/price • typed through route generics

DELETE/v1/resource/price/bulkAuth required

Delete Resource price bulk

DELETE /v1/resource/price/bulk • typed through route generics

GET/v1/resource/price/labelsAuth required

Get Resource price labels

GET /v1/resource/price/labels • typed through route generics

POST/v1/resource/bulkAuth required

Create Resource bulk

POST /v1/resource/bulk • validated by `postBulkResource`

GET/v1/resource/bulk/historyAuth required

Get Resource bulk history

GET /v1/resource/bulk/history • typed through route generics

GET/v1/resource/statsAuth required

Get Resource stats

GET /v1/resource/stats • typed through route generics

POST/v1/resource/productionAuth required

Create Resource production

POST /v1/resource/production • typed through route generics

POST/v1/resource/barcode/generateAuth required

Create Resource barcode generate

POST /v1/resource/barcode/generate • typed through route generics

GET/v1/resource/total-valueAuth required

Get Resource total value

GET /v1/resource/total-value • typed through route generics

GET/v1/resource/productionAuth required

Get Resource production

GET /v1/resource/production • typed through route generics

GET/v1/resource/production/:productionId/recipeAuth required

Get Resource production by productionid recipe

GET /v1/resource/production/:productionId/recipe • typed through route generics

GET/v1/resource/production/:resourceId/recipe/latestAuth required

Get Resource production by resourceid recipe latest

GET /v1/resource/production/:resourceId/recipe/latest • typed through route generics

POST/v1/resource/production/:productionId/applyAuth required

Create Resource production by productionid apply

POST /v1/resource/production/:productionId/apply • typed through route generics

PATCH/v1/resource/production/:productionIdAuth required

Update Resource production by productionid

PATCH /v1/resource/production/:productionId • typed through route generics

POST/v1/resource/exportAuth required

Create Resource export

POST /v1/resource/export • typed through route generics

GET/v1/resource/export/historyAuth required

Get Resource export history

GET /v1/resource/export/history • typed through route generics

GET/v1/resource/export/download/:fileNameAuth required

Get Resource export download by filename

GET /v1/resource/export/download/:fileName • described through route-level inference

POST/v1/resource/taxAuth required

Create Resource tax

POST /v1/resource/tax • typed through route generics

DELETE/v1/resource/taxAuth required

Delete Resource tax

DELETE /v1/resource/tax • typed through route generics

GET/v1/resource/tax/:resourceIdAuth required

Get Resource tax by resourceid

GET /v1/resource/tax/:resourceId • described through route-level inference

PATCH/v1/resource/tax/bulkAuth required

Update Resource tax bulk

PATCH /v1/resource/tax/bulk • typed through route generics

PATCH/v1/resource/:resourceId/request-marketplace-reviewAuth required

Update Resource by resourceid request marketplace review

PATCH /v1/resource/:resourceId/request-marketplace-review • described through route-level inference

GET/v1/resource/:resourceIdAuth required

Get Resource by resourceid

GET /v1/resource/:resourceId • typed through route generics

GET/v1/resource/:resourceId/storageAuth required

Get Resource by resourceid storage

GET /v1/resource/:resourceId/storage • typed through route generics

GET/v1/resource/production/:productionIdAuth required

Get Resource production by productionid

GET /v1/resource/production/:productionId • typed through route generics

POST/v1/resource/price/bulkAuth required

Create Resource price bulk

POST /v1/resource/price/bulk • validated by `postBulkPriceTier`

POST/v1/resource/cost/bulkAuth required

Create Resource cost bulk

POST /v1/resource/cost/bulk • validated by `postBulkCost`

V2 / Resources / Resource

GET/v2/resourceAuth required

Get Resource

GET /v2/resource • typed through route generics

GET/v2/resource/idsAuth required

Get Resource ids

GET /v2/resource/ids • typed through route generics

PATCH/v2/resource/bulkAuth required

Update Resource bulk

PATCH /v2/resource/bulk • typed through route generics

Files / Files

GET/v1/files/record/:idAuth required

Get Files record by id

GET /v1/files/record/:id • described through route-level inference

POST/v1/filesAuth required

Create Files

POST /v1/files • described through route-level inference

POST/v1/files/base64Auth required

Create Files base64

POST /v1/files/base64 • typed through route generics

PATCH/v1/filesAuth required

Update Files

PATCH /v1/files • described through route-level inference

DELETE/v1/filesAuth required

Delete Files

DELETE /v1/files • described through route-level inference

POST/v1/files/folderAuth required

Create Files folder

POST /v1/files/folder • described through route-level inference

POST/v1/files/documentAuth required

Create Files document

POST /v1/files/document • described through route-level inference

PATCH/v1/files/documentAuth required

Update Files document

PATCH /v1/files/document • described through route-level inference

GET/v1/files/documentAuth required

Get Files document

GET /v1/files/document • typed through route generics

GET/v1/files/document/:idAuth required

Get Files document by id

GET /v1/files/document/:id • described through route-level inference

GET/v1/files/document/:id/publicPublic endpoint

Get Files document by id public

GET /v1/files/document/:id/public • described through route-level inference

GET/v1/files/documentsAuth required

Get Files documents

GET /v1/files/documents • typed through route generics

GET/v1/files/objectAuth required

Get Files object

GET /v1/files/object • described through route-level inference

GET/v1/files/object/publicPublic endpoint

Get Files object public

GET /v1/files/object/public • described through route-level inference

GET/v1/files/usageAuth required

Get Files usage

GET /v1/files/usage • described through route-level inference

Tasks / Board

POST/v1/tasks/boardAuth required

Create Board

POST /v1/tasks/board • validated by `postBoard`

PATCH/v1/tasks/boardAuth required

Update Board

PATCH /v1/tasks/board • validated by `patchBoard`

GET/v1/tasks/boardAuth required

Get Board

GET /v1/tasks/board • typed through route generics

GET/v1/tasks/board/allAuth required

Get Board all

GET /v1/tasks/board/all • typed through route generics

GET/v1/tasks/board/:boardIdAuth required

Get Board by boardid

GET /v1/tasks/board/:boardId • typed through route generics

GET/v1/tasks/board/shared/:shareId/dataPublic endpoint

Get Board shared by shareid data

GET /v1/tasks/board/shared/:shareId/data • typed through route generics

DELETE/v1/tasks/board/:boardIdAuth required

Delete Board by boardid

DELETE /v1/tasks/board/:boardId • typed through route generics

Tasks / Board Column

POST/v1/tasks/board-columnAuth required

Create Board Column

POST /v1/tasks/board-column • validated by `postBoardColumn`

GET/v1/tasks/board-columnAuth required

Get Board Column

GET /v1/tasks/board-column • typed through route generics

GET/v1/tasks/board-column/:columnIdAuth required

Get Board Column by columnid

GET /v1/tasks/board-column/:columnId • typed through route generics

PATCH/v1/tasks/board-columnAuth required

Update Board Column

PATCH /v1/tasks/board-column • typed through route generics

DELETE/v1/tasks/board-column/:columnIdAuth required

Delete Board Column by columnid

DELETE /v1/tasks/board-column/:columnId • typed through route generics

PATCH/v1/tasks/board-column/moveAuth required

Update Board Column move

PATCH /v1/tasks/board-column/move • typed through route generics

Tasks / Board Task

Board task endpoints are used to create, update, and organize tasks across boards and columns.

POST/v1/tasks/board-taskAuth required

Create Board Task

POST /v1/tasks/board-task • validated by `postBoardTask`

GET/v1/tasks/board-taskAuth required

Get Board Task

GET /v1/tasks/board-task • typed through route generics

PATCH/v1/tasks/board-taskAuth required

Update Board Task

PATCH /v1/tasks/board-task • typed through route generics

PATCH/v1/tasks/board-task/moveAuth required

Update Board Task move

PATCH /v1/tasks/board-task/move • typed through route generics

GET/v1/tasks/board-task/userAuth required

Get Board Task user

GET /v1/tasks/board-task/user • typed through route generics

GET/v1/tasks/board-task/:taskIdAuth required

Get Board Task by taskid

GET /v1/tasks/board-task/:taskId • typed through route generics

DELETE/v1/tasks/board-task/:taskIdAuth required

Delete Board Task by taskid

DELETE /v1/tasks/board-task/:taskId • described through route-level inference

GET/v1/tasks/board-task/:taskId/recurrence/nextAuth required

Get Board Task by taskid recurrence next

GET /v1/tasks/board-task/:taskId/recurrence/next • validated by `getNextRecurrenceInfo`

POST/v1/tasks/board-task/:taskId/recurrence/force-createAuth required

Create Board Task by taskid recurrence force create

POST /v1/tasks/board-task/:taskId/recurrence/force-create • validated by `postForceCreateRecurrence`

Tasks / Schedule

POST/v1/tasks/scheduleAuth required

Create Schedule

POST /v1/tasks/schedule • validated by `postTaskSchedule`

GET/v1/tasks/scheduleAuth required

Get Schedule

GET /v1/tasks/schedule • validated by `listTaskSchedules`

GET/v1/tasks/schedule/:scheduleIdAuth required

Get Schedule by scheduleid

GET /v1/tasks/schedule/:scheduleId • validated by `getTaskScheduleById`

PATCH/v1/tasks/schedule/:scheduleIdAuth required

Update Schedule by scheduleid

PATCH /v1/tasks/schedule/:scheduleId • validated by `patchTaskSchedule`

DELETE/v1/tasks/schedule/:scheduleIdAuth required

Delete Schedule by scheduleid

DELETE /v1/tasks/schedule/:scheduleId • validated by `deleteTaskSchedule`

GET/v1/tasks/schedule/:scheduleId/icsPublic endpoint

Get Schedule by scheduleid ics

GET /v1/tasks/schedule/:scheduleId/ics • validated by `getTaskScheduleById`

POST/v1/tasks/schedule/linkAuth required

Create Schedule link

POST /v1/tasks/schedule/link • validated by `postTaskScheduleLink`

POST/v1/tasks/schedule/link/submitPublic endpoint

Create Schedule link submit

POST /v1/tasks/schedule/link/submit • validated by `postTaskScheduleLinkSubmit`

POST/v1/tasks/schedule/:scheduleId/registerAuth required

Create Schedule by scheduleid register

POST /v1/tasks/schedule/:scheduleId/register • validated by `postTaskScheduleRegistration`

GET/v1/tasks/schedule/:scheduleId/registrationsAuth required

Get Schedule by scheduleid registrations

GET /v1/tasks/schedule/:scheduleId/registrations • validated by `getTaskScheduleRegistrations`

PATCH/v1/tasks/schedule/:scheduleId/registrations/:registrationIdAuth required

Update Schedule by scheduleid registrations by registrationid

PATCH /v1/tasks/schedule/:scheduleId/registrations/:registrationId • validated by `patchTaskScheduleRegistration`

DELETE/v1/tasks/schedule/:scheduleId/registrations/:registrationIdAuth required

Delete Schedule by scheduleid registrations by registrationid

DELETE /v1/tasks/schedule/:scheduleId/registrations/:registrationId • validated by `deleteTaskScheduleRegistration`

Apps / App

POST/v1/apps/releaseAuth required

Create App release

POST /v1/apps/release • typed through route generics

GET/v1/apps/releaseAuth required

Get App release

GET /v1/apps/release • typed through route generics

POST/v1/apps/dataAuth required

Create App data

POST /v1/apps/data • typed through route generics

GET/v1/apps/dataAuth required

Get App data

GET /v1/apps/data • typed through route generics

GET/v1/apps/data/singleAuth required

Get App data single

GET /v1/apps/data/single • typed through route generics

PATCH/v1/apps/dataAuth required

Update App data

PATCH /v1/apps/data • typed through route generics

DELETE/v1/apps/dataAuth required

Delete App data

DELETE /v1/apps/data • typed through route generics

POST/v1/apps/data/importAuth required

Create App data import

POST /v1/apps/data/import • typed through route generics

GET/v1/apps/available-appsAuth required

Get App available apps

GET /v1/apps/available-apps • typed through route generics

GET/v1/apps/:appIdAuth required

Get App by appid

GET /v1/apps/:appId • typed through route generics

PATCH/v1/apps/:appIdAuth required

Update App by appid

PATCH /v1/apps/:appId • typed through route generics

GET/v1/apps/data-types/:appIdAuth required

Get App data types by appid

GET /v1/apps/data-types/:appId • typed through route generics

GET/v1/apps/data/explorer/:appIdAuth required

Get App data explorer by appid

GET /v1/apps/data/explorer/:appId • typed through route generics

POST/v1/apps/search-configAuth required

Create App search config

POST /v1/apps/search-config • typed through route generics

GET/v1/apps/search-config/:appIdAuth required

Get App search config by appid

GET /v1/apps/search-config/:appId • typed through route generics

PATCH/v1/apps/search-config/:configIdAuth required

Update App search config by configid

PATCH /v1/apps/search-config/:configId • typed through route generics

DELETE/v1/apps/search-config/:configIdAuth required

Delete App search config by configid

DELETE /v1/apps/search-config/:configId • typed through route generics

Apps / Shopify / Auth

GET/v1/apps/shopify/authAuth required

Get Auth

GET /v1/apps/shopify/auth • typed through route generics

GET/v1/apps/shopify/auth/callbackAuth required

Get Auth callback

GET /v1/apps/shopify/auth/callback • described through route-level inference

Apps / Shopify / Webhook

POST/v1/apps/shopify/webhook/:shopPublic endpoint

Create Webhook by shop

POST /v1/apps/shopify/webhook/:shop • described through route-level inference

Apps / Woocommerce / Webhook

POST/v1/apps/woocommerce/webhook/:appDataIdPublic endpoint

Create Webhook by appdataid

POST /v1/apps/woocommerce/webhook/:appDataId • described through route-level inference

Usage

GET/v1/usageAuth required

Get Usage

GET /v1/usage • described through route-level inference

GET/v1/usage/statsAuth required

Get Usage stats

GET /v1/usage/stats • described through route-level inference

Label

DELETE/v1/label/:labelIdAuth required

Delete Label by labelid

DELETE /v1/label/:labelId • typed through route generics

Automations / Api

GET/v1/automation/apiAuth required

Get Api

GET /v1/automation/api • typed through route generics

POST/v1/automation/apiAuth required

Create Api

POST /v1/automation/api • typed through route generics

Automations / Schedule

GET/v1/automation/scheduleAuth required

Get Schedule

GET /v1/automation/schedule • typed through route generics

POST/v1/automation/scheduleAuth required

Create Schedule

POST /v1/automation/schedule • typed through route generics

POST/v1/automation/schedule/by-payloadAuth required

Create Schedule by payload

POST /v1/automation/schedule/by-payload • typed through route generics

Automations / Webhook

POST/v1/automation/webhook/:automationIdPublic endpoint

Create Webhook by automationid

POST /v1/automation/webhook/:automationId • typed through route generics

GET/v1/automation/webhook/:automationId/infoPublic endpoint

Get Webhook by automationid info

GET /v1/automation/webhook/:automationId/info • described through route-level inference

Automatizaciones

Crea y administra automatizaciones de flujo de trabajo.

GET/v1/automationAuth required

Listar automatizaciones

GET /v1/automation • typed through route generics

POST/v1/automationAuth required

Create Automation

POST /v1/automation • typed through route generics

POST/v1/automation/assistantAuth required

Create Automation assistant

POST /v1/automation/assistant • described through route-level inference

GET/v1/automation/assistant-conversationsAuth required

Get Automation assistant conversations

GET /v1/automation/assistant-conversations • typed through route generics

GET/v1/automation/assistant-conversations/:idAuth required

Get Automation assistant conversations by id

GET /v1/automation/assistant-conversations/:id • described through route-level inference

POST/v1/automation/assistant-conversationsAuth required

Create Automation assistant conversations

POST /v1/automation/assistant-conversations • typed through route generics

POST/v1/automation/invoice-assistantAuth required

Create Automation invoice assistant

POST /v1/automation/invoice-assistant • described through route-level inference

POST/v1/automation/payment-assistantAuth required

Create Automation payment assistant

POST /v1/automation/payment-assistant • described through route-level inference

PUT/v1/automation/:id/disableAuth required

Replace Automation by id disable

PUT /v1/automation/:id/disable • described through route-level inference

PUT/v1/automation/:id/enableAuth required

Replace Automation by id enable

PUT /v1/automation/:id/enable • described through route-level inference

GET/v1/automation/:idAuth required

Get Automation by id

GET /v1/automation/:id • described through route-level inference

PUT/v1/automation/:idAuth required

Replace Automation by id

PUT /v1/automation/:id • typed through route generics

POST/v1/automation/:id/testAuth required

Create Automation by id test

POST /v1/automation/:id/test • typed through route generics

GET/v1/automation/:id/threadsAuth required

Get Automation by id threads

GET /v1/automation/:id/threads • described through route-level inference

GET/v1/automation/:id/threads/detailedAuth required

Get Automation by id threads detailed

GET /v1/automation/:id/threads/detailed • typed through route generics

GET/v1/automation/thread/:threadId/eventsAuth required

Get Automation thread by threadid events

GET /v1/automation/thread/:threadId/events • described through route-level inference

Blog

GET/v1/blogPublic endpoint

Get Blog

GET /v1/blog • described through route-level inference

Data

GET/v1/data/invoicedPublic endpoint

Get Data invoiced

GET /v1/data/invoiced • described through route-level inference

Marketplace / Cart

POST/v1/marketplace/cartPublic endpoint

Create Cart

POST /v1/marketplace/cart • described through route-level inference

PATCH/v1/marketplace/cart/:cartId/itemsPublic endpoint

Update Cart by cartid items

PATCH /v1/marketplace/cart/:cartId/items • described through route-level inference

POST/v1/marketplace/cart/:cartId/itemsPublic endpoint

Create Cart by cartid items

POST /v1/marketplace/cart/:cartId/items • described through route-level inference

GET/v1/marketplace/cart/:cartIdPublic endpoint

Get Cart by cartid

GET /v1/marketplace/cart/:cartId • described through route-level inference

PATCH/v1/marketplace/cart/:cartIdPublic endpoint

Update Cart by cartid

PATCH /v1/marketplace/cart/:cartId • described through route-level inference

DELETE/v1/marketplace/cart/:cartIdPublic endpoint

Delete Cart by cartid

DELETE /v1/marketplace/cart/:cartId • described through route-level inference

Marketplace / Collection

GET/v1/marketplace/collectionPublic endpoint

Get Collection

GET /v1/marketplace/collection • described through route-level inference

GET/v1/marketplace/collection/:collectionIdPublic endpoint

Get Collection by collectionid

GET /v1/marketplace/collection/:collectionId • described through route-level inference

GET/v1/marketplace/collection/:collectionId/productsPublic endpoint

Get Collection by collectionid products

GET /v1/marketplace/collection/:collectionId/products • described through route-level inference

Forms / Form

GET/v1/forms/:formIdPublic endpoint

Get Form by formid

GET /v1/forms/:formId • typed through route generics

GET/v1/forms/:formId/submissionsAuth required

Get Form by formid submissions

GET /v1/forms/:formId/submissions • typed through route generics

POST/v1/forms/:formId/submitPublic endpoint

Create Form by formid submit

POST /v1/forms/:formId/submit • typed through route generics

PATCH/v1/forms/:formIdAuth required

Update Form by formid

PATCH /v1/forms/:formId • typed through route generics

DELETE/v1/forms/:formId/submissions/:submissionIdAuth required

Delete Form by formid submissions by submissionid

DELETE /v1/forms/:formId/submissions/:submissionId • typed through route generics

POST/v1/forms/:formId/ai-analysisAuth required

Create Form by formid ai analysis

POST /v1/forms/:formId/ai-analysis • typed through route generics

GET/v1/forms/:formId/exportAuth required

Get Form by formid export

GET /v1/forms/:formId/export • described through route-level inference

Shared / Shared

POST/v1/sharedAuth required

Create Shared

POST /v1/shared • typed through route generics

GET/v1/shared/previewAuth required

Get Shared preview

GET /v1/shared/preview • typed through route generics

GET/v1/shared/:id/payment-dataPublic endpoint

Get Shared by id payment data

GET /v1/shared/:id/payment-data • typed through route generics

POST/v1/shared/:id/create-intentPublic endpoint

Create Shared by id create intent

POST /v1/shared/:id/create-intent • typed through route generics

POST/v1/shared/:id/create-setup-intentPublic endpoint

Create Shared by id create setup intent

POST /v1/shared/:id/create-setup-intent • typed through route generics

POST/v1/shared/:id/enable-auto-chargePublic endpoint

Create Shared by id enable auto charge

POST /v1/shared/:id/enable-auto-charge • typed through route generics

POST/v1/shared/:id/pay-with-savedPublic endpoint

Create Shared by id pay with saved

POST /v1/shared/:id/pay-with-saved • typed through route generics

GET/v1/shared/:idPublic endpoint

Get Shared by id

GET /v1/shared/:id • typed through route generics

Websites

GET/v1/websites/contentAuth required

Get Websites content

GET /v1/websites/content • described through route-level inference

POST/v1/websites/domainsAuth required

Create Websites domains

POST /v1/websites/domains • described through route-level inference

DELETE/v1/websites/domains/:domainAuth required

Delete Websites domains by domain

DELETE /v1/websites/domains/:domain • described through route-level inference

GET/v1/websites/domainsAuth required

Get Websites domains

GET /v1/websites/domains • described through route-level inference

POST/v1/websites/domains/:domain/verifyPublic endpoint

Create Websites domains by domain verify

POST /v1/websites/domains/:domain/verify • described through route-level inference

GET/v1/websites/preview/:pageIdPublic endpoint

Get Websites preview by pageid

GET /v1/websites/preview/:pageId • described through route-level inference