डेवलपर

API संदर्भ

VentionDesk API के सभी सार्वजनिक एंडपॉइंट। यह सूची सर्वर के रजिस्टर्ड रूट से बनती है; हर एंडपॉइंट का एक्सेस नियम रूट पर होने वाली जाँचों से आता है, और तालिकाएँ उन Zod कॉन्ट्रैक्ट से, जिनसे VentionDesk अनुरोध जाँचता है और जवाब बनाता है। इसलिए यहाँ जो लिखा है, वही सर्वर सच में करता है।

URL https://api.ventiondesk.com से शुरू होते हैं। साइन इन, स्कोप, त्रुटि फ़ॉर्मेट और रेट लिमिट API की बुनियादी बातें में समझाए गए हैं। ज़रूरी फ़ील्ड * से चिह्नित हैं; बिना तालिका वाला एंडपॉइंट अपनी बॉडी को ऐसे कॉन्ट्रैक्ट से जाँचता है जो प्रकाशित नहीं है, या उसका कोई कॉन्ट्रैक्ट नहीं है।

एक्सेस को ऐसे पढ़ें: “मालिक” और “मालिक और स्टाफ़ सदस्य” का मतलब है वेब इंटरफ़ेस में साइन इन किया हुआ व्यक्ति; API कुंजी के साथ ऐसे एंडपॉइंट 403 से जवाब देते हैं। स्कोप वाले एंडपॉइंट तक वे एजेंट कुंजियाँ भी पहुँच सकती हैं जिनमें यह स्कोप हो।

टास्क

GET`/v1/tasks`

टास्क पढ़ें, प्रोजेक्ट, स्थिति, ज़िम्मेदार व्यक्ति या खोज टेक्स्ट के हिसाब से फ़िल्टर करके।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप tasks:read वाली एजेंट कुंजियाँ

क्वेरी पैरामीटर

फ़ील्ड	प्रकार	टिप्पणी
project	UUID
projectSlug	टेक्स्ट
status	"hold" \| "todo" \| "in_progress" \| "question" \| "review" \| "done"
assignee	"owner" \| "staff" \| "claude" \| "external"
claimable	"true" \| "false"
maxAttempts	पूर्णांक	≥ 1 \| ≤ 20 \| डिफ़ॉल्ट: 3
limit	पूर्णांक	≥ 1 \| ≤ 100 \| डिफ़ॉल्ट: 20
q	टेक्स्ट	कम से कम 1 अक्षर

जवाब

फ़ील्ड	प्रकार	टिप्पणी
tasks	ऑब्जेक्ट की सूची

POST`/v1/tasks`

टास्क बनाएँ; बहुत मिलते-जुलते खुले टास्क डुप्लिकेट के रूप में पहचाने जाते हैं।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप tasks:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
projectId	UUID
projectSlug	टेक्स्ट
title *	टेक्स्ट	कम से कम 25 अक्षर
descriptionMd	टेक्स्ट	कम से कम 1 अक्षर
area	"frontend" \| "backend" \| "design" \| "infra" \| "support"
dueDate	तारीख़ (YYYY-MM-DD)
estimateMinutes	पूर्णांक	> 0
triggerCondition	टेक्स्ट	कम से कम 1 अक्षर
evidence	टेक्स्ट	कम से कम 1 अक्षर

GET`/v1/tasks/:id`

विवरण, नतीजों और अटैचमेंट के साथ एक टास्क।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप tasks:read वाली एजेंट कुंजियाँ

जवाब

फ़ील्ड	प्रकार	टिप्पणी
task	ऑब्जेक्ट
results	ऑब्जेक्ट की सूची
attachments	ऑब्जेक्ट की सूची

PATCH`/v1/tasks/:id`

टास्क के फ़ील्ड बदलें।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप tasks:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
title	टेक्स्ट	कम से कम 1 अक्षर
descriptionMd	टेक्स्ट या null
status	"hold" \| "todo" \| "in_progress" \| "question" \| "review" \| "done"
assignee	"owner" \| "staff" \| "claude" \| "external" या null
area	"frontend" \| "backend" \| "design" \| "infra" \| "support" या null
dueDate	तारीख़ (YYYY-MM-DD) या null
estimateMinutes	पूर्णांक या null	> 0
position	टेक्स्ट	कम से कम 1 अक्षर
triggerCondition	टेक्स्ट या null

POST`/v1/tasks/:id/claim`

टास्क को एक साथ (एटॉमिक रूप से) लें — दो रन को कभी एक ही टास्क नहीं मिलता।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप tasks:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
maxAttempts	पूर्णांक	≥ 1 \| ≤ 20 \| डिफ़ॉल्ट: 3
runId	UUID

POST`/v1/tasks/:id/decision`

किसी नतीजे पर इंसान की मंज़ूरी या अस्वीकृति; अस्वीकृति के लिए टिप्पणी ज़रूरी है।

एक्सेस मालिक और स्टाफ़ सदस्य

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
decision *	"approved" \| "rejected"
commentMd	टेक्स्ट	कम से कम 1 अक्षर \| अधिकतम 20000 अक्षर
attachmentIds	UUID की सूची	डिफ़ॉल्ट: []

जवाब

फ़ील्ड	प्रकार	टिप्पणी
task	ऑब्जेक्ट
result	ऑब्जेक्ट

POST`/v1/tasks/:id/handoff`

टास्क Claude को सौंपें।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप tasks:write वाली एजेंट कुंजियाँ

POST`/v1/tasks/:id/result`

टास्क की स्थिति रिपोर्ट करें (arbeitet, kontrolle, frage, master, blockiert, erledigt)।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप tasks:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
state *	"arbeitet" \| "kontrolle" \| "frage" \| "master" \| "blockiert" \| "erledigt"
summaryMd	टेक्स्ट	कम से कम 1 अक्षर
detailsMd	टेक्स्ट	कम से कम 1 अक्षर
prUrl	URL
evidence	टेक्स्ट	कम से कम 1 अक्षर
runId	UUID

एजेंट रन

POST`/v1/agent/runs`

किसी एजेंट का रन शुरू करें।

एक्सेस केवल एजेंट कुंजियाँ, स्कोप agent:run के साथ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
projectId	UUID
projectSlug	टेक्स्ट
meta	ऑब्जेक्ट (मुक्त रूप)	डिफ़ॉल्ट: {}

जवाब

फ़ील्ड	प्रकार	टिप्पणी
run	ऑब्जेक्ट

POST`/v1/agent/runs/:id/finish`

एजेंट रन समाप्त करें, सारांश या त्रुटि स्थिति के साथ।

एक्सेस केवल एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
status *	"succeeded" \| "failed"
summary	टेक्स्ट	कम से कम 1 अक्षर

जवाब

फ़ील्ड	प्रकार	टिप्पणी
run	ऑब्जेक्ट

POST`/v1/agent/runs/:id/heartbeat`

चल रहे एजेंट रन का जीवन-संकेत।

एक्सेस केवल एजेंट कुंजियाँ

जवाब

फ़ील्ड	प्रकार	टिप्पणी
run	ऑब्जेक्ट

प्रोजेक्ट

POST`/v1/errors/:id/resolve`

किसी खुली त्रुटि को हल के रूप में चिह्नित करें — पहले एरर ट्रैकर (Sentry, Bugsnag, Rollbar) पर एरर स्रोत के एक्सेस से, और सफल होने पर ही VentionDesk में। अगर प्रोवाइडर विफल हो (एक्सेस केवल पढ़ने का है, त्रुटि अज्ञात है, कोई जवाब नहीं), तो त्रुटि खुली रहती है: कारण के साथ 409 या 502। मालिक, स्टाफ़ सदस्यों और errors:write वाले एजेंट के लिए। छिपाना और हटाना यहाँ उपलब्ध नहीं है।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप errors:write वाली एजेंट कुंजियाँ

जवाब

फ़ील्ड	प्रकार	टिप्पणी
issue	ऑब्जेक्ट
changed	true \| false

POST`/v1/errors/:id/task`

किसी त्रुटि से टास्क बनाएँ।

एक्सेस मालिक और स्टाफ़ सदस्य

GET`/v1/errors/summary`

ओवरव्यू के लिए सभी प्रोजेक्ट की त्रुटियों की संख्या।

एक्सेस मालिक और स्टाफ़ सदस्य

जवाब

फ़ील्ड	प्रकार	टिप्पणी
projects	ऑब्जेक्ट की सूची

POST`/v1/monitors/probe`

बनाने से पहले मॉनिटर URL की जाँच करें और अंतिम टारगेट समेत रीडायरेक्ट बताएँ।

एक्सेस मालिक और स्टाफ़ सदस्य

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
url *	URL	अधिकतम 2048 अक्षर

GET`/v1/projects`

प्रोजेक्ट जिन्हें खाता या कुंजी देख सकती है।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप projects:read वाली एजेंट कुंजियाँ

क्वेरी पैरामीटर

फ़ील्ड	प्रकार	टिप्पणी
status	"active" \| "blocked" \| "review" \| "paused"
includeArchived	"true" \| "false"
q	टेक्स्ट	कम से कम 1 अक्षर

जवाब

फ़ील्ड	प्रकार	टिप्पणी
projects	ऑब्जेक्ट की सूची

GET`/v1/projects/:id`

ID के हिसाब से एक प्रोजेक्ट।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप projects:read वाली एजेंट कुंजियाँ

PATCH`/v1/projects/:id/customer`

प्रोजेक्ट को दूसरे ग्राहक को सौंपें; टिकट, ड्राफ़्ट और दस्तावेज़ साथ चले जाते हैं।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
customerId *	UUID

जवाब

फ़ील्ड	प्रकार	टिप्पणी
project	ऑब्जेक्ट
changed	true \| false
moved	ऑब्जेक्ट

GET`/v1/projects/:id/deploy`

कौन-से डिप्लॉय टारगेट हैं और हर एक में क्या कमी है।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
targets	ऑब्जेक्ट की सूची

POST`/v1/projects/:id/deploy`

डिप्लॉय शुरू करें (202: शुरू हुआ, सफल नहीं)।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
target *	"production" \| "staging" \| "preview"
provider	"vercel" \| "render"

जवाब

फ़ील्ड	प्रकार	टिप्पणी
provider	"vercel" \| "render"
target	"production" \| "staging" \| "preview"
externalId	टेक्स्ट या null
started	पूर्णांक	> 0

POST`/v1/projects/:id/error-sources`

एरर ट्रैकर के किसी प्रोजेक्ट को इस प्रोजेक्ट से जोड़ें।

एक्सेस मालिक और स्टाफ़ सदस्य

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
provider *	"sentry" \| "bugsnag" \| "rollbar"
externalId *	टेक्स्ट	कम से कम 1 अक्षर \| अधिकतम 200 अक्षर

DELETE`/v1/projects/:id/error-sources/:sourceId`

त्रुटि स्रोत को प्रोजेक्ट से अलग करें।

एक्सेस मालिक और स्टाफ़ सदस्य

GET`/v1/projects/:id/errors`

इस प्रोजेक्ट के लिए Sentry, Bugsnag या Rollbar की त्रुटियाँ। errors:read वाले एजेंट को उसके प्रोजेक्ट की त्रुटियाँ मिलती हैं, स्रोतों और कनेक्शन के बिना।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप errors:read वाली एजेंट कुंजियाँ

जवाब

फ़ील्ड	प्रकार	टिप्पणी
issues	ऑब्जेक्ट की सूची
stats	ऑब्जेक्ट
sources	ऑब्जेक्ट की सूची
providers	"sentry" \| "bugsnag" \| "rollbar" की सूची

GET`/v1/projects/:id/hosting`

प्रोजेक्ट के होस्टिंग असाइनमेंट।

एक्सेस मालिक और स्टाफ़ सदस्य

जवाब

फ़ील्ड	प्रकार	टिप्पणी
mappings	ऑब्जेक्ट की सूची
providers	"netlify" \| "cloudflare_pages" \| "aws_amplify" \| "railway" \| "flyio" \| "digitalocean_app_platform" की सूची

POST`/v1/projects/:id/hosting`

होस्टिंग प्रोवाइडर पर कोई साइट, ऐप या सेवा असाइन करें।

एक्सेस मालिक और स्टाफ़ सदस्य

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
provider *	"netlify" \| "cloudflare_pages" \| "aws_amplify" \| "railway" \| "flyio" \| "digitalocean_app_platform"
externalId *	टेक्स्ट	कम से कम 1 अक्षर \| अधिकतम 200 अक्षर

DELETE`/v1/projects/:id/hosting/:mappingId`

होस्टिंग असाइनमेंट हटाएँ।

एक्सेस मालिक और स्टाफ़ सदस्य

DELETE`/v1/projects/:id/render-services/:serviceId`

पुरानी Render सर्विस ID को प्रोजेक्ट से अलग करें।

एक्सेस मालिक

GET`/v1/projects/:id/report`

रिपोर्ट के लिए प्रोजेक्ट की स्थिति: प्रगति, हर स्थिति में टास्क, खुले और अतिदेय टिकट, रोडमैप, मॉनिटर, डिप्लॉयमेंट और खुले पुल रिक्वेस्ट। पैसा नहीं — न राजस्व, न बजट, न लागत।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप stats:read वाली एजेंट कुंजियाँ

GET`/v1/projects/:id/roadmap`

किसी प्रोजेक्ट के रोडमैप चरण, योजना के क्रम में।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप roadmap:write वाली एजेंट कुंजियाँ

जवाब

फ़ील्ड	प्रकार	टिप्पणी
phases	ऑब्जेक्ट की सूची

POST`/v1/projects/:id/roadmap`

रोडमैप चरण बनाएँ। sort के बिना यह अंत में जाता है; अगला खुला चरण कॉकपिट में माइलस्टोन होता है।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप roadmap:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
title *	टेक्स्ट	कम से कम 1 अक्षर \| अधिकतम 200 अक्षर
startsOn *	टेक्स्ट	निश्चित पैटर्न
endsOn *	टेक्स्ट	निश्चित पैटर्न
sort	पूर्णांक	≥ 0

PATCH`/v1/projects/:id/roadmap/:phaseId`

चरण बदलें — शीर्षक, अवधि, पूरा या क्रम, केवल भेजे गए फ़ील्ड। API हटाता नहीं है।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप roadmap:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
title	टेक्स्ट	कम से कम 1 अक्षर \| अधिकतम 200 अक्षर
startsOn	टेक्स्ट	निश्चित पैटर्न
endsOn	टेक्स्ट	निश्चित पैटर्न
done	true \| false
sort	पूर्णांक	≥ 0

POST`/v1/projects/:id/sync`

प्रोजेक्ट का GitHub डेटा रात के बजाय अभी सिंक करें।

एक्सेस मालिक और स्टाफ़ सदस्य

GET`/v1/projects/:id/time`

किसी प्रोजेक्ट की टाइम एंट्री: दिन, अवधि, विवरण, टास्क, बिल योग्य और बिल हुआ हाँ/नहीं, व्यक्ति का नाम — घंटे की दर, राशि और इनवॉइस ID के बिना।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप time:read वाली एजेंट कुंजियाँ

क्वेरी पैरामीटर

फ़ील्ड	प्रकार	टिप्पणी
from	टेक्स्ट	निश्चित पैटर्न
to	टेक्स्ट	निश्चित पैटर्न
limit	पूर्णांक	≥ 1 \| ≤ 500 \| डिफ़ॉल्ट: 200

जवाब

फ़ील्ड	प्रकार	टिप्पणी
entries	ऑब्जेक्ट की सूची
totalSeconds	पूर्णांक	≥ 0

GET`/v1/projects/by-slug/:slug`

स्लग के हिसाब से एक प्रोजेक्ट।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप projects:read वाली एजेंट कुंजियाँ

टिकट

GET`/v1/tickets`

टिकट पढ़ें, स्थिति, चैनल, प्राथमिकता, प्रोजेक्ट या ग्राहक के हिसाब से फ़िल्टर करके।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप tickets:read वाली एजेंट कुंजियाँ

क्वेरी पैरामीटर

फ़ील्ड	प्रकार	टिप्पणी
status	"open" \| "in_progress" \| "waiting" \| "resolved"
source	"contact_form" \| "app" \| "email" \| "monitor" \| "portal" \| "phone" \| "on_site" \| "stripe" \| "api"
priority	"low" \| "normal" \| "high" \| "critical"
project	UUID
projectSlug	टेक्स्ट
customer	UUID
withSla	"true" \| "false"
q	टेक्स्ट	कम से कम 1 अक्षर
limit	पूर्णांक	≥ 1 \| ≤ 100 \| डिफ़ॉल्ट: 50

जवाब

फ़ील्ड	प्रकार	टिप्पणी
tickets	ऑब्जेक्ट की सूची

POST`/v1/tickets`

टिकट बनाएँ, उदाहरण के लिए फ़ोन कॉल के बाद।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप tickets:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
subject *	टेक्स्ट	कम से कम 3 अक्षर
bodyMd *	टेक्स्ट	कम से कम 1 अक्षर
source *	"contact_form" \| "app" \| "email" \| "monitor" \| "portal" \| "phone" \| "on_site" \| "stripe" \| "api"
customerId	UUID या null
projectId	UUID या null
priority	"low" \| "normal" \| "high" \| "critical"	डिफ़ॉल्ट: "normal"
requesterName	टेक्स्ट
requesterEmail	ईमेल
requesterMeta	ऑब्जेक्ट (मुक्त रूप)

DELETE`/v1/tickets/:id`

टिकट हटाएँ।

एक्सेस मालिक और स्टाफ़ सदस्य

GET`/v1/tickets/:id`

इतिहास समेत एक टिकट।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप tickets:read वाली एजेंट कुंजियाँ

जवाब

फ़ील्ड	प्रकार	टिप्पणी
ticket	ऑब्जेक्ट
messages	ऑब्जेक्ट की सूची

PATCH`/v1/tickets/:id`

टिकट का विषय, स्थिति, प्राथमिकता, चैनल, ग्राहक, प्रोजेक्ट, ज़िम्मेदार व्यक्ति या पोर्टल दृश्यता बदलें।

एक्सेस मालिक और स्टाफ़ सदस्य

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
subject	टेक्स्ट	कम से कम 3 अक्षर
status	"open" \| "in_progress" \| "waiting" \| "resolved"
priority	"low" \| "normal" \| "high" \| "critical"
source	"contact_form" \| "app" \| "email" \| "monitor" \| "portal" \| "phone" \| "on_site" \| "stripe" \| "api"
customerId	UUID या null
projectId	UUID या null
assignedTo	UUID या null
portalVisible	true \| false

POST`/v1/tickets/:id/messages`

इतिहास में एंट्री लिखें: आंतरिक नोट या ड्राफ़्ट। कोई ईमेल नहीं जाता।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप tickets:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
bodyMd *	टेक्स्ट	कम से कम 1 अक्षर
isInternalNote	true \| false	डिफ़ॉल्ट: false
isDraft	true \| false	डिफ़ॉल्ट: false

POST`/v1/tickets/:id/reply`

ग्राहक को जवाब दें — यही एकमात्र तरीका है जिससे ईमेल जाता है। टिकट को “प्रतीक्षा में” पर सेट करता है। एजेंट के जवाब में हमेशा यह सूचना होती है कि इसे AI असिस्टेंट ने लिखा है, और यह प्रति की प्रति घंटे 20 और प्रति टिकट प्रति दिन 3 तक सीमित है (इससे ऊपर 429)।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप tickets:reply वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
bodyMd *	टेक्स्ट	कम से कम 1 अक्षर
isInternalNote	true \| false	डिफ़ॉल्ट: false
isDraft	true \| false	डिफ़ॉल्ट: false
draftId	UUID

POST`/v1/tickets/:id/to-task`

टिकट से टास्क बनाएँ — विषय शीर्षक के रूप में, पूरा इतिहास विवरण के रूप में।

एक्सेस मालिक और स्टाफ़ सदस्य

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
projectId *	UUID
title	टेक्स्ट	कम से कम 10 अक्षर
assignee	"owner" \| "staff" \| "claude" \| "external" या null

GET`/v1/tickets/attachments/:id/url`

टिकट के अटैचमेंट के लिए कम समय वाला URL — एजेंट को यह केवल उसके प्रोजेक्ट के टिकट के लिए मिलता है।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप tickets:read वाली एजेंट कुंजियाँ

जवाब

फ़ील्ड	प्रकार	टिप्पणी
url	URL
expiresInSeconds	पूर्णांक	> 0

नोट्स

POST`/v1/notes`

प्रोजेक्ट पर नोट बनाएँ (प्रोजेक्ट ID या स्लग)।

एक्सेस मालिक, स्टाफ़ सदस्य या स्कोप notes:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
projectId	UUID
projectSlug	टेक्स्ट
bodyMd *	टेक्स्ट	कम से कम 1 अक्षर
kind	"idea" \| "decision" \| "risk"	डिफ़ॉल्ट: "idea"

जवाब

फ़ील्ड	प्रकार	टिप्पणी
note	ऑब्जेक्ट

POST`/v1/notes/:id/to-task`

नोट से टास्क बनाएँ।

एक्सेस मालिक और स्टाफ़ सदस्य

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
title	टेक्स्ट	कम से कम 25 अक्षर
assignee	"owner" \| "staff" \| "claude" \| "external" या null

जवाब

फ़ील्ड	प्रकार	टिप्पणी
ok	false
error	टेक्स्ट
code	"note_already_converted"
task	ऑब्जेक्ट

आइडिया

POST`/v1/ideas`

आइडिया बनाएँ — हमेशा “खुला”। एजेंट केवल बनाता है: वह कोई आइडिया पढ़ता, बदलता या हटाता नहीं; प्रोजेक्ट के बिना केवल सभी प्रोजेक्ट वाली कुंजी से।

एक्सेस मालिक या स्कोप ideas:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
title *	टेक्स्ट	कम से कम 1 अक्षर \| अधिकतम 200 अक्षर
bodyMd	टेक्स्ट	अधिकतम 20000 अक्षर
tags	टेक्स्ट की सूची	डिफ़ॉल्ट: []
potential	"low" \| "medium" \| "high"
priority	"low" \| "high"
projectId	UUID या null

जवाब

फ़ील्ड	प्रकार	टिप्पणी
idea	ऑब्जेक्ट

समय

GET`/v1/time/entries`

टाइम एंट्री पढ़ें।

एक्सेस मालिक और स्टाफ़ सदस्य

क्वेरी पैरामीटर

फ़ील्ड	प्रकार	टिप्पणी
from	टेक्स्ट
to	टेक्स्ट
project	UUID
user	UUID
unbilled	"true" \| "false"
limit	पूर्णांक	≥ 1 \| ≤ 500 \| डिफ़ॉल्ट: 200

जवाब

फ़ील्ड	प्रकार	टिप्पणी
entries	ऑब्जेक्ट की सूची

POST`/v1/time/entries`

बाद में समय जोड़ें।

एक्सेस मालिक और स्टाफ़ सदस्य

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
label *	टेक्स्ट	कम से कम 1 अक्षर
startedAt *	टाइमस्टैम्प (ISO 8601)
endedAt *	टाइमस्टैम्प (ISO 8601)
seconds	पूर्णांक	> 0
projectId	UUID या null
ticketId	UUID या null
taskId	UUID या null
billable	true \| false	डिफ़ॉल्ट: true

DELETE`/v1/time/entries/:id`

टाइम एंट्री हटाएँ।

एक्सेस मालिक और स्टाफ़ सदस्य

PATCH`/v1/time/entries/:id`

टाइम एंट्री बदलें।

एक्सेस मालिक और स्टाफ़ सदस्य

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
label	टेक्स्ट	कम से कम 1 अक्षर
seconds	पूर्णांक	> 0
billable	true \| false
projectId	UUID या null
ticketId	UUID या null

GET`/v1/time/timer`

खाते का चल रहा टाइमर।

एक्सेस मालिक और स्टाफ़ सदस्य

जवाब

फ़ील्ड	प्रकार	टिप्पणी
timer	ऑब्जेक्ट या null

POST`/v1/time/timer/start`

टाइमर शुरू करें।

एक्सेस मालिक और स्टाफ़ सदस्य

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
label	टेक्स्ट	डिफ़ॉल्ट: ""
projectId	UUID या null
ticketId	UUID या null
taskId	UUID या null

POST`/v1/time/timer/stop`

टाइमर रोकें और समय को एंट्री के रूप में दर्ज करें।

एक्सेस मालिक और स्टाफ़ सदस्य

GET`/v1/time/unbilled`

बिल योग्य घंटे जिनका अभी इनवॉइस नहीं बना, प्रति प्रोजेक्ट, राशि समेत।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
projects	ऑब्जेक्ट की सूची
totals	ऑब्जेक्ट

ग्राहक

DELETE`/v1/customers/:id`

फ़ाइलों समेत ग्राहक हटाएँ।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
customerId	UUID
shortName	टेक्स्ट
impact	ऑब्जेक्ट
files	ऑब्जेक्ट
portalAccounts	ऑब्जेक्ट

GET`/v1/customers/:id/deletion`

प्रीव्यू कि ग्राहक के साथ क्या-क्या हटेगा।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
customerId	UUID
shortName	टेक्स्ट
deletable	true \| false
reason	टेक्स्ट या null
blockers	ऑब्जेक्ट
impact	ऑब्जेक्ट

POST`/v1/customers/:id/portal-access`

किसी संपर्क व्यक्ति को ग्राहक पोर्टल का एक्सेस दें।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
email *	ईमेल
displayName	टेक्स्ट	कम से कम 1 अक्षर

जवाब

फ़ील्ड	प्रकार	टिप्पणी
access	ऑब्जेक्ट
mail	ऑब्जेक्ट

DELETE`/v1/customers/:id/portal-access/:userId`

किसी खाते का पोर्टल एक्सेस वापस लें। पहले से जारी टोकन नवीनीकरण तक मान्य रहता है।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
revoked	ऑब्जेक्ट

POST`/v1/customers/:id/portal-access/:userId/invite`

ग्राहक पोर्टल का आमंत्रण फिर से भेजें।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
mail	ऑब्जेक्ट

दस्तावेज़

GET`/v1/documents`

दस्तावेज़ पढ़ें, ग्राहक, प्रोजेक्ट या प्रकार के हिसाब से फ़िल्टर करके।

एक्सेस कोई भी साइन-इन किया हुआ खाता; उसकी भूमिका तय करती है कि वह क्या देखता है

क्वेरी पैरामीटर

फ़ील्ड	प्रकार	टिप्पणी
customer	UUID
project	UUID
type	"pdf" \| "image" \| "sheet" \| "contract" \| "other"
q	टेक्स्ट	कम से कम 1 अक्षर \| अधिकतम 120 अक्षर
limit	पूर्णांक	≥ 1 \| ≤ 200 \| डिफ़ॉल्ट: 50

जवाब

फ़ील्ड	प्रकार	टिप्पणी
documents	ऑब्जेक्ट की सूची

PATCH`/v1/documents/:id`

किसी दस्तावेज़ का असाइनमेंट, प्रकार, टैग या पोर्टल दृश्यता बदलें।

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
name	टेक्स्ट	कम से कम 1 अक्षर \| अधिकतम 200 अक्षर
type	"pdf" \| "image" \| "sheet" \| "contract" \| "other"
projectId	UUID या null
sharedWithPortal	true \| false
tags	टेक्स्ट की सूची

GET`/v1/documents/:id/url`

दस्तावेज़ डाउनलोड करने के लिए कम समय वाला URL।

जवाब

फ़ील्ड	प्रकार	टिप्पणी
url	URL
expiresInSeconds	पूर्णांक	> 0

फ़ाइनेंस

GET`/v1/finance/export`

टैक्स सलाहकार के लिए वार्षिक एक्सपोर्ट: हर टेबल के लिए एक CSV और सेव किए गए दस्तावेज़ों वाली ZIP।

एक्सेस मालिक

GET`/v1/invoices`

इनवॉइस पढ़ें, स्थिति, ग्राहक या “अतिदेय” के हिसाब से फ़िल्टर करके। एजेंट केवल अपने प्रोजेक्ट के ड्राफ़्ट देखता है।

एक्सेस मालिक या स्कोप invoices:write वाली एजेंट कुंजियाँ

क्वेरी पैरामीटर

फ़ील्ड	प्रकार	टिप्पणी
status	"draft" \| "open" \| "overdue" \| "paid" \| "cancelled"
customer	UUID
overdue	"true" \| "false"
limit	पूर्णांक	≥ 1 \| ≤ 200 \| डिफ़ॉल्ट: 50

जवाब

फ़ील्ड	प्रकार	टिप्पणी
invoices	ऑब्जेक्ट की सूची

POST`/v1/invoices`

इनवॉइस ड्राफ़्ट बनाएँ — अभी बिना इनवॉइस नंबर के। customerId के बिना प्रोजेक्ट का ग्राहक लागू होता है; एजेंट केवल अपने किसी प्रोजेक्ट में ड्राफ़्ट बनाता है। फ़ाइनल करना, भेजना और भुगतान मालिक के पास रहते हैं।

एक्सेस मालिक या स्कोप invoices:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
customerId	UUID
projectId	UUID या null
paymentTermsDays	पूर्णांक	≥ 1 \| ≤ 90
vatRate	पूर्णांक
vatScheme	"standard" \| "reverse_charge"
serviceFrom	टेक्स्ट	निश्चित पैटर्न
serviceTo	टेक्स्ट	निश्चित पैटर्न
serviceDateEqualsInvoiceDate	true \| false	डिफ़ॉल्ट: false
positions	ऑब्जेक्ट की सूची	डिफ़ॉल्ट: []

GET`/v1/invoices/:id`

लाइन आइटम, कुल राशि और भुगतान के साथ एक इनवॉइस।

एक्सेस मालिक या स्कोप invoices:write वाली एजेंट कुंजियाँ

जवाब

फ़ील्ड	प्रकार	टिप्पणी
invoice	ऑब्जेक्ट
positions	ऑब्जेक्ट की सूची

POST`/v1/invoices/:id/cancel`

फ़ाइनल इनवॉइस रद्द करें; एक रद्दीकरण इनवॉइस बनता है।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
reason *	टेक्स्ट	कम से कम 3 अक्षर \| अधिकतम 500 अक्षर
serviceRendered *	true \| false

जवाब

फ़ील्ड	प्रकार	टिप्पणी
invoice	ऑब्जेक्ट
releasedEntries	पूर्णांक	≥ 0
entries	"released" \| "failed"
correction	"stored" \| "skipped" \| "failed"
taxOfficeConsent	true \| false

GET`/v1/invoices/:id/cancellation/pdf`

PDF के रूप में रद्दीकरण इनवॉइस।

एक्सेस मालिक

POST`/v1/invoices/:id/cancellation/send`

रद्दीकरण इनवॉइस ईमेल से भेजें।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
mail	"sent" \| "skipped"
reason	टेक्स्ट	न भी हो सकता है
invoice	ऑब्जेक्ट

POST`/v1/invoices/:id/dunning/send`

देय रिमाइंडर स्तर भेजें।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
mail	"sent" \| "skipped"
reason	टेक्स्ट	न भी हो सकता है
invoice	ऑब्जेक्ट
level	पूर्णांक या null	≥ 1 \| ≤ 4

POST`/v1/invoices/:id/finalize`

ड्राफ़्ट फ़ाइनल करें: क्रमिक नंबर देता है, इनवॉइस लॉक करता है और PDF सेव करता है।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
settle	ऑब्जेक्ट

जवाब

फ़ील्ड	प्रकार	टिप्पणी
invoice	ऑब्जेक्ट
pdf	"stored" \| "skipped" \| "failed"
payment	"none" \| "booked" \| "failed"
paymentError	टेक्स्ट	न भी हो सकता है

POST`/v1/invoices/:id/payments`

भुगतान या वापसी भुगतान दर्ज करें।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
amountCents *	पूर्णांक
paidOn	टेक्स्ट	निश्चित पैटर्न
method	"transfer" \| "stripe" \| "cash" \| "other"	डिफ़ॉल्ट: "transfer"
note	टेक्स्ट	अधिकतम 500 अक्षर

GET`/v1/invoices/:id/pdf`

PDF के रूप में इनवॉइस — फ़ाइनल करते समय सेव किया गया दस्तावेज़।

एक्सेस मालिक

POST`/v1/invoices/:id/positions`

ड्राफ़्ट में लाइन आइटम जोड़ें।

एक्सेस मालिक या स्कोप invoices:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
description *	टेक्स्ट	कम से कम 1 अक्षर
quantity *	संख्या	> 0
unit	"hour" \| "flat"	डिफ़ॉल्ट: "hour"
unitPriceCents *	पूर्णांक	≥ 0
sort	पूर्णांक

DELETE`/v1/invoices/:id/positions/:positionId`

ड्राफ़्ट से लाइन आइटम हटाएँ।

एक्सेस मालिक या स्कोप invoices:write वाली एजेंट कुंजियाँ

PATCH`/v1/invoices/:id/positions/:positionId`

ड्राफ़्ट का लाइन आइटम बदलें — केवल भेजे गए फ़ील्ड। फ़ाइनल इनवॉइस 409 के साथ जवाब देता है।

एक्सेस मालिक या स्कोप invoices:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
description	टेक्स्ट	कम से कम 1 अक्षर
quantity	संख्या	> 0
unit	"hour" \| "flat"	डिफ़ॉल्ट: "hour"
unitPriceCents	पूर्णांक	≥ 0
sort	पूर्णांक

POST`/v1/invoices/:id/remind`

भुगतान रिमाइंडर भेजें।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
mail	"sent" \| "skipped"
reason	टेक्स्ट	न भी हो सकता है
invoice	ऑब्जेक्ट

POST`/v1/invoices/:id/send`

फ़ाइनल इनवॉइस ईमेल से भेजें।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
mail	"sent" \| "skipped"
reason	टेक्स्ट	न भी हो सकता है
invoice	ऑब्जेक्ट

GET`/v1/invoices/:id/stripe-refund`

Stripe भुगतान का रिफ़ंड हो सकता है या नहीं, और कितना।

एक्सेस मालिक

POST`/v1/invoices/:id/stripe-refund`

Stripe से भुगतान किए गए इनवॉइस का रिफ़ंड Stripe के ज़रिए करें; यह वेबहुक से दर्ज होता है।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
amountCents	पूर्णांक	> 0

GET`/v1/invoices/:id/test-pay-link`

आज़माने के लिए Stripe टेस्ट मोड में भुगतान लिंक।

एक्सेस मालिक

POST`/v1/invoices/from-unbilled`

किसी प्रोजेक्ट के खुले बिल योग्य घंटों को इनवॉइस ड्राफ़्ट में बदलें — हर टाइम एंट्री के लिए एक लाइन आइटम।

एक्सेस मालिक या स्कोप invoices:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
projectId *	UUID
untilDate	टेक्स्ट
paymentTermsDays	पूर्णांक	≥ 1 \| ≤ 90
vatRate	पूर्णांक
vatScheme	"standard" \| "reverse_charge"

जवाब

फ़ील्ड	प्रकार	टिप्पणी
invoice	ऑब्जेक्ट
entries	पूर्णांक	≥ 0
hours	संख्या	≥ 0

GET`/v1/quotes`

कोटेशन पढ़ें। एजेंट केवल अपने प्रोजेक्ट के ड्राफ़्ट देखता है।

एक्सेस मालिक या स्कोप quotes:write वाली एजेंट कुंजियाँ

जवाब

फ़ील्ड	प्रकार	टिप्पणी
quotes	ऑब्जेक्ट की सूची

POST`/v1/quotes`

कोटेशन ड्राफ़्ट बनाएँ — अभी बिना नंबर के। customerId के बिना प्रोजेक्ट का ग्राहक लागू होता है; एजेंट केवल अपने किसी प्रोजेक्ट में ड्राफ़्ट बनाता है और कभी किसी संभावित ग्राहक के लिए नहीं।

एक्सेस मालिक या स्कोप quotes:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
title *	टेक्स्ट	कम से कम 3 अक्षर
customerId	UUID या null
prospectName	टेक्स्ट
prospectEmail	ईमेल
projectId	UUID या null
validUntil	टेक्स्ट
vatRate	पूर्णांक
vatScheme	"standard" \| "reverse_charge"
positions	ऑब्जेक्ट की सूची	डिफ़ॉल्ट: []

DELETE`/v1/quotes/:id`

कोटेशन ड्राफ़्ट हटाएँ — उसका अभी कोई नंबर नहीं है।

एक्सेस मालिक या स्कोप quotes:write वाली एजेंट कुंजियाँ

GET`/v1/quotes/:id`

लाइन आइटम के साथ एक कोटेशन।

एक्सेस मालिक या स्कोप quotes:write वाली एजेंट कुंजियाँ

जवाब

फ़ील्ड	प्रकार	टिप्पणी
quote	ऑब्जेक्ट
positions	ऑब्जेक्ट की सूची

PATCH`/v1/quotes/:id`

ड्राफ़्ट का शीर्षक और वैधता बदलें। भेजा गया कोटेशन 409 के साथ जवाब देता है।

एक्सेस मालिक या स्कोप quotes:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
title	टेक्स्ट	कम से कम 3 अक्षर
validUntil	टेक्स्ट या null	निश्चित पैटर्न

GET`/v1/quotes/:id/pdf`

PDF के रूप में कोटेशन।

एक्सेस मालिक

POST`/v1/quotes/:id/positions`

कोटेशन ड्राफ़्ट में लाइन आइटम जोड़ें।

एक्सेस मालिक या स्कोप quotes:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
description *	टेक्स्ट	कम से कम 1 अक्षर
quantity *	संख्या	> 0
unit	"hour" \| "flat"	डिफ़ॉल्ट: "hour"
unitPriceCents *	पूर्णांक	≥ 0
sort	पूर्णांक

DELETE`/v1/quotes/:id/positions/:positionId`

कोटेशन ड्राफ़्ट से लाइन आइटम हटाएँ।

एक्सेस मालिक या स्कोप quotes:write वाली एजेंट कुंजियाँ

PATCH`/v1/quotes/:id/positions/:positionId`

कोटेशन ड्राफ़्ट का लाइन आइटम बदलें — केवल भेजे गए फ़ील्ड।

एक्सेस मालिक या स्कोप quotes:write वाली एजेंट कुंजियाँ

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
description	टेक्स्ट	कम से कम 1 अक्षर
quantity	संख्या	> 0
unit	"hour" \| "flat"	डिफ़ॉल्ट: "hour"
unitPriceCents	पूर्णांक	≥ 0
sort	पूर्णांक

POST`/v1/quotes/:id/send`

कोटेशन ईमेल से भेजें।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
mail	"sent" \| "skipped"
reason	टेक्स्ट	न भी हो सकता है
quote	ऑब्जेक्ट

कनेक्शन

GET`/v1/integrations`

वर्कस्पेस के कनेक्टेड स्रोत, सीक्रेट के बिना।

एक्सेस मालिक और स्टाफ़ सदस्य

जवाब

फ़ील्ड	प्रकार	टिप्पणी
integrations	ऑब्जेक्ट की सूची
plattform	true \| false
githubInstallierbar	true \| false

POST`/v1/integrations`

स्रोत कनेक्ट करें। सेव करने से पहले प्रोवाइडर के साथ एक्सेस की जाँच होती है।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
provider *	"vercel" \| "render" \| "netlify" \| "cloudflare_pages" \| "aws_amplify" \| "railway" \| "flyio" \| "digitalocean_app_platform" \| "postmark" \| "mailgun" \| "amazon_ses" \| "resend" \| "sentry" \| "bugsnag" \| "rollbar" \| "stripe"
fields *	ऑब्जेक्ट (मुक्त रूप)

DELETE`/v1/integrations/:id`

कनेक्शन हटाएँ।

एक्सेस मालिक

PATCH`/v1/integrations/:id`

कनेक्शन संपादित करें; ख़ाली सीक्रेट अपरिवर्तित रहता है।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
fields *	ऑब्जेक्ट (मुक्त रूप)

GET`/v1/integrations/:id/webhook`

किसी कनेक्शन (Stripe, Sentry, Bugsnag, Rollbar) का वेबहुक पता, प्रोवाइडर पर डालने के लिए।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
url	URL
signiert	true \| false
bereit	true \| false

GET`/v1/integrations/:provider/error-projects`

प्रोजेक्ट जिन्हें एक्सेस एरर ट्रैकर में देख सकता है।

एक्सेस मालिक और स्टाफ़ सदस्य

जवाब

फ़ील्ड	प्रकार	टिप्पणी
resources	ऑब्जेक्ट की सूची

GET`/v1/integrations/:provider/resources`

साइटें, ऐप या सेवाएँ जिन्हें होस्टिंग एक्सेस प्रोवाइडर पर देख सकता है।

एक्सेस मालिक और स्टाफ़ सदस्य

जवाब

फ़ील्ड	प्रकार	टिप्पणी
resources	ऑब्जेक्ट की सूची

GET`/v1/integrations/github/callback`

इंस्टॉलेशन के बाद GitHub से वापसी का रास्ता; इंस्टॉलेशन को वर्कस्पेस से जोड़ता है।

एक्सेस हस्ताक्षरित state और GitHub साइन-इन

क्वेरी पैरामीटर

फ़ील्ड	प्रकार	टिप्पणी
installation_id	टेक्स्ट	निश्चित पैटर्न
setup_action	टेक्स्ट	अधिकतम 20 अक्षर
code	टेक्स्ट	अधिकतम 200 अक्षर
state	टेक्स्ट	अधिकतम 2000 अक्षर

POST`/v1/integrations/github/install-url`

GitHub पर VentionDesk ऐप इंस्टॉल करने का URL।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
url	URL

खाता, सेटिंग्स और प्रशासन

GET`/v1/admin/api-keys`

वर्कस्पेस की API कुंजियाँ, सादे टेक्स्ट के बिना।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
keys	ऑब्जेक्ट की सूची

POST`/v1/admin/api-keys`

एजेंट या इनटेक कुंजी बनाएँ। सादा टेक्स्ट केवल इसी एक जवाब में दिखता है।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
name *	टेक्स्ट	कम से कम 3 अक्षर
kind	"agent" \| "intake"	डिफ़ॉल्ट: "agent"
scopes *	"projects:read" \| "tasks:read" \| "tasks:write" \| "tickets:read" \| "tickets:write" \| "tickets:reply" \| "notes:write" \| "deployments:read" \| "agent:run" \| "intake:write" \| "access-log:write" \| "invoices:write" \| "errors:read" \| "errors:write" \| "time:read" \| "stats:read" \| "quotes:write" \| "roadmap:write" \| "ideas:write" की सूची
projectIds *	UUID की सूची या null
expiresAt	टाइमस्टैम्प (ISO 8601)

जवाब

फ़ील्ड	प्रकार	टिप्पणी
key	ऑब्जेक्ट
plaintext	टेक्स्ट

DELETE`/v1/admin/api-keys/:id`

कुंजी वापस लें — तुरंत लागू होता है।

एक्सेस मालिक

PATCH`/v1/admin/api-keys/:id`

किसी कुंजी की अनुमतियाँ और प्रोजेक्ट बदलें — कुंजी वही रहती है।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
scopes *	"projects:read" \| "tasks:read" \| "tasks:write" \| "tickets:read" \| "tickets:write" \| "tickets:reply" \| "notes:write" \| "deployments:read" \| "agent:run" \| "intake:write" \| "access-log:write" \| "invoices:write" \| "errors:read" \| "errors:write" \| "time:read" \| "stats:read" \| "quotes:write" \| "roadmap:write" \| "ideas:write" की सूची
projectIds *	UUID की सूची या null

जवाब

फ़ील्ड	प्रकार	टिप्पणी
key	ऑब्जेक्ट

DELETE`/v1/admin/api-keys/:id/endgueltig`

वापस ली गई कुंजी को हमेशा के लिए हटाएँ।

एक्सेस मालिक

GET`/v1/admin/members`

वर्कस्पेस के सदस्य उनकी भूमिका के साथ।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
members	ऑब्जेक्ट की सूची

PATCH`/v1/admin/members/:id`

किसी सदस्य की भूमिका बदलें।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
role *	"owner" \| "staff"

जवाब

फ़ील्ड	प्रकार	टिप्पणी
member	ऑब्जेक्ट
activeHere	true \| false

DELETE`/v1/admin/users/:id`

पोर्टल खाता हटाएँ; इतिहास में नाम और पता पहले छद्मनाम में बदले जाते हैं।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
removed	ऑब्जेक्ट
account	"kept" \| "deleted" \| "locked"

POST`/v1/admin/users/invite`

ईमेल से स्टाफ़ सदस्य को आमंत्रित करें।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
email *	ईमेल
role *	"owner" \| "staff"
displayName	टेक्स्ट	कम से कम 1 अक्षर

जवाब

फ़ील्ड	प्रकार	टिप्पणी
user	ऑब्जेक्ट
existingAccount	true \| false	न भी हो सकता है \| डिफ़ॉल्ट: false

GET`/v1/ki-apps`

कनेक्टेड AI ऐप: सभी वर्कस्पेस में आपके अपने, और मालिक के लिए वर्कस्पेस के सभी।

एक्सेस मालिक और स्टाफ़ सदस्य

जवाब

फ़ील्ड	प्रकार	टिप्पणी
apps	ऑब्जेक्ट की सूची
alleImBetrieb	true \| false

POST`/v1/ki-apps`

किसी AI ऐप के लिए सहमति सेव करें (वर्कस्पेस, अनुमतियाँ, प्रोजेक्ट) — साइन-इन पर मंज़ूरी से पहले। Supabase Auth ऐप का नाम बताता है, कॉल करने वाले का नहीं।

एक्सेस मालिक और स्टाफ़ सदस्य

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
authorizationId *	टेक्स्ट	कम से कम 1 अक्षर \| अधिकतम 200 अक्षर
orgId *	UUID
scopes *	"projects:read" \| "tasks:read" \| "tasks:write" \| "tickets:read" \| "tickets:write" \| "tickets:reply" \| "notes:write" \| "deployments:read" \| "agent:run" \| "intake:write" \| "access-log:write" \| "invoices:write" \| "errors:read" \| "errors:write" \| "time:read" \| "stats:read" \| "quotes:write" \| "roadmap:write" \| "ideas:write" की सूची
projectIds *	UUID की सूची या null

जवाब

फ़ील्ड	प्रकार	टिप्पणी
app	ऑब्जेक्ट

DELETE`/v1/ki-apps/:id`

AI ऐप डिस्कनेक्ट करें — तुरंत लागू होता है; आपके अपने ऐप के लिए साइन-इन पर दी गई मंज़ूरी भी वापस ली जाती है।

एक्सेस मालिक और स्टाफ़ सदस्य

GET`/v1/ki-apps/rahmen`

सहमति पेज क्या दिखाता है: व्यक्ति के वर्कस्पेस, अनुमत अनुमतियाँ और प्रोजेक्ट।

एक्सेस मालिक और स्टाफ़ सदस्य

जवाब

फ़ील्ड	प्रकार	टिप्पणी
betriebe	ऑब्जेक्ट की सूची
betrieb	UUID
rolle	"owner" \| "staff"
erlaubt	"projects:read" \| "tasks:read" \| "tasks:write" \| "tickets:read" \| "tickets:write" \| "tickets:reply" \| "notes:write" \| "deployments:read" \| "agent:run" \| "intake:write" \| "access-log:write" \| "invoices:write" \| "errors:read" \| "errors:write" \| "time:read" \| "stats:read" \| "quotes:write" \| "roadmap:write" \| "ideas:write" की सूची
projekte	ऑब्जेक्ट की सूची

GET`/v1/ki-apps/vorgabe`

स्टाफ़ सदस्य किसी AI ऐप को कौन-सी अनुमतियाँ दे सकते हैं।

एक्सेस मालिक और स्टाफ़ सदस्य

जवाब

फ़ील्ड	प्रकार	टिप्पणी
scopes	"projects:read" \| "tasks:read" \| "tasks:write" \| "tickets:read" \| "tickets:write" \| "tickets:reply" \| "notes:write" \| "deployments:read" \| "agent:run" \| "intake:write" \| "access-log:write" \| "invoices:write" \| "errors:read" \| "errors:write" \| "time:read" \| "stats:read" \| "quotes:write" \| "roadmap:write" \| "ideas:write" की सूची
abWerk	"projects:read" \| "tasks:read" \| "tasks:write" \| "tickets:read" \| "tickets:write" \| "tickets:reply" \| "notes:write" \| "deployments:read" \| "agent:run" \| "intake:write" \| "access-log:write" \| "invoices:write" \| "errors:read" \| "errors:write" \| "time:read" \| "stats:read" \| "quotes:write" \| "roadmap:write" \| "ideas:write" की सूची
waehlbar	"projects:read" \| "tasks:read" \| "tasks:write" \| "tickets:read" \| "tickets:write" \| "tickets:reply" \| "notes:write" \| "deployments:read" \| "agent:run" \| "intake:write" \| "access-log:write" \| "invoices:write" \| "errors:read" \| "errors:write" \| "time:read" \| "stats:read" \| "quotes:write" \| "roadmap:write" \| "ideas:write" की सूची

PUT`/v1/ki-apps/vorgabe`

यह डिफ़ॉल्ट बदलें।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
scopes *	"projects:read" \| "tasks:read" \| "tasks:write" \| "tickets:read" \| "tickets:write" \| "tickets:reply" \| "notes:write" \| "deployments:read" \| "agent:run" \| "intake:write" \| "access-log:write" \| "invoices:write" \| "errors:read" \| "errors:write" \| "time:read" \| "stats:read" \| "quotes:write" \| "roadmap:write" \| "ideas:write" की सूची

जवाब

फ़ील्ड	प्रकार	टिप्पणी
scopes	"projects:read" \| "tasks:read" \| "tasks:write" \| "tickets:read" \| "tickets:write" \| "tickets:reply" \| "notes:write" \| "deployments:read" \| "agent:run" \| "intake:write" \| "access-log:write" \| "invoices:write" \| "errors:read" \| "errors:write" \| "time:read" \| "stats:read" \| "quotes:write" \| "roadmap:write" \| "ideas:write" की सूची
abWerk	"projects:read" \| "tasks:read" \| "tasks:write" \| "tickets:read" \| "tickets:write" \| "tickets:reply" \| "notes:write" \| "deployments:read" \| "agent:run" \| "intake:write" \| "access-log:write" \| "invoices:write" \| "errors:read" \| "errors:write" \| "time:read" \| "stats:read" \| "quotes:write" \| "roadmap:write" \| "ideas:write" की सूची
waehlbar	"projects:read" \| "tasks:read" \| "tasks:write" \| "tickets:read" \| "tickets:write" \| "tickets:reply" \| "notes:write" \| "deployments:read" \| "agent:run" \| "intake:write" \| "access-log:write" \| "invoices:write" \| "errors:read" \| "errors:write" \| "time:read" \| "stats:read" \| "quotes:write" \| "roadmap:write" \| "ideas:write" की सूची

GET`/v1/me`

आपका अपना खाता: भूमिका, वर्कस्पेस, चुनने के लिए वर्कस्पेस और सेवा पते।

जवाब

फ़ील्ड	प्रकार	टिप्पणी
id	UUID
role	"owner" \| "staff" \| "customer" \| "agent"
customerId	UUID या null
displayName	टेक्स्ट	कम से कम 1 अक्षर
email	ईमेल
mfaRequired	true \| false
intake	ऑब्जेक्ट
organization	ऑब्जेक्ट या null	न भी हो सकता है \| डिफ़ॉल्ट: null
memberships	ऑब्जेक्ट की सूची	न भी हो सकता है \| डिफ़ॉल्ट: []
support	ऑब्जेक्ट या null	न भी हो सकता है
locale	"de" \| "en" \| "zh" \| "es" \| "hi" \| "tr" या null	न भी हो सकता है

PATCH`/v1/me/locale`

अपनी इंटरफ़ेस भाषा खाते में सेव करें।

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
locale *	"de" \| "en" \| "zh" \| "es" \| "hi" \| "tr"

POST`/v1/me/organization`

अगर खाता कई वर्कस्पेस से जुड़ा है, तो सक्रिय वर्कस्पेस बदलें।

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
orgId *	UUID

जवाब

फ़ील्ड	प्रकार	टिप्पणी
organization	ऑब्जेक्ट
role	"owner" \| "staff"

GET`/v1/settings`

वर्कस्पेस की सेटिंग्स, दस्तावेज़ों के लेटरहेड समेत।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
company	ऑब्जेक्ट

PATCH`/v1/settings`

सेटिंग्स और लेटरहेड बदलें।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
company *	ऑब्जेक्ट

जवाब

फ़ील्ड	प्रकार	टिप्पणी
company	ऑब्जेक्ट

GET`/v1/settings/agreements`

नियम और शर्तों तथा डेटा प्रोसेसिंग अनुबंध पर सहमति की स्थिति।

एक्सेस मालिक

POST`/v1/settings/agreements`

नियम और शर्तों या डेटा प्रोसेसिंग अनुबंध का नया संस्करण स्वीकार या अस्वीकार करें।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
document *	"agb" \| "avv"
version *	टेक्स्ट	कम से कम 1 अक्षर \| अधिकतम 40 अक्षर
decision *	"accepted" \| "declined"

GET`/v1/settings/benachrichtigungen`

नए टिकट पर ईमेल: चालू या बंद, प्राप्तकर्ता, चैनल और न्यूनतम प्राथमिकता।

एक्सेस मालिक

PATCH`/v1/settings/benachrichtigungen`

नए टिकट पर ईमेल कॉन्फ़िगर करें (केवल मालिक)।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
aktiv *	true \| false
wiederoeffnen	true \| false
empfaenger *	ईमेल की सूची या null
kanaele *	"contact_form" \| "app" \| "email" \| "monitor" \| "portal" \| "phone" \| "on_site" \| "stripe" \| "api" की सूची या null
mindestPrioritaet *	"low" \| "normal" \| "high" \| "critical"

GET`/v1/settings/mail`

ग्राहकों को ईमेल का प्रेषक और आपके अपने प्रेषक डोमेन की स्थिति।

एक्सेस मालिक

PATCH`/v1/settings/mail`

प्रेषक का नाम और प्रेषक का पता बदलें।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
absenderName	टेक्स्ट या null	अधिकतम 60 अक्षर
postfachname	टेक्स्ट	अधिकतम 40 अक्षर

GET`/v1/settings/mail-templates`

वर्कस्पेस के ईमेल टेम्पलेट, डिफ़ॉल्ट टेक्स्ट समेत।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
vorlagen	ऑब्जेक्ट की सूची

DELETE`/v1/settings/mail-templates/:kind`

ईमेल टेम्पलेट को डिफ़ॉल्ट टेक्स्ट पर रीसेट करें।

एक्सेस मालिक

PUT`/v1/settings/mail-templates/:kind`

ईमेल टेम्पलेट सेव करें।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
subject *	टेक्स्ट	कम से कम 1 अक्षर \| अधिकतम 200 अक्षर
html *	टेक्स्ट	कम से कम 1 अक्षर \| अधिकतम 102400 अक्षर

जवाब

फ़ील्ड	प्रकार	टिप्पणी
kind	"invoice_send" \| "invoice_reminder" \| "dunning" \| "invoice_cancellation" \| "quote_send" \| "ticket_reply" \| "ticket_receipt" \| "ticket_internal" \| "ticket_reopened" \| "member_invite" \| "portal_invite" \| "deletion_reminder"
angepasst	true \| false
subject	टेक्स्ट या null
html	टेक्स्ट या null
aktualisiertAm	टेक्स्ट या null
bereinigt	true \| false

DELETE`/v1/settings/mail/domain`

अपना प्रेषक डोमेन हटाएँ।

एक्सेस मालिक

POST`/v1/settings/mail/domain`

अपना प्रेषक डोमेन बनाएँ; जवाब में DNS रिकॉर्ड की सूची होती है।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
adresse *	टेक्स्ट	कम से कम 3 अक्षर \| अधिकतम 254 अक्षर

POST`/v1/settings/mail/domain/verify`

प्रेषक डोमेन के DNS रिकॉर्ड की जाँच करवाएँ।

एक्सेस मालिक

VentionDesk सब्सक्रिप्शन

GET`/v1/abo`

वर्कस्पेस के VentionDesk सब्सक्रिप्शन की स्थिति: प्लान, ट्रायल, निलंबन।

एक्सेस मालिक और स्टाफ़ सदस्य

जवाब

फ़ील्ड	प्रकार	टिप्पणी
betrieb	टेक्स्ट
tarif	"solo" \| "team" \| "enterprise"
abrechnung	"jaehrlich" \| "monatlich"
status	"trial" \| "active" \| "past_due" \| "canceled"
testphaseBis	टेक्स्ट या null
laufzeitBis	टेक्स्ट या null
kuendigtZum	टेक्स्ट या null	न भी हो सकता है \| डिफ़ॉल्ट: null
loeschungAm	टेक्स्ट या null	न भी हो सकता है \| डिफ़ॉल्ट: null
gesperrt	true \| false	न भी हो सकता है \| डिफ़ॉल्ट: false
sperrGrund	"beendet" \| "testphase" \| "zahlungsverzug" \| "anbieter" या null	न भी हो सकता है \| डिफ़ॉल्ट: null
sperreAb	टेक्स्ट या null	न भी हो सकता है \| डिफ़ॉल्ट: null
plaetze	पूर्णांक या null
mitglieder	पूर्णांक
stripeKunde	true \| false
stripeAbo	true \| false	न भी हो सकता है \| डिफ़ॉल्ट: false
befreit	true \| false
stripeBereit	true \| false

POST`/v1/abo/cancel`

अवधि के अंत में VentionDesk सब्सक्रिप्शन रद्द करें।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
nonce *	टेक्स्ट	निश्चित पैटर्न
grund	"too_expensive" \| "missing_features" \| "switched_service" \| "unused" \| "too_complex" \| "low_quality" \| "customer_service" \| "other"
kommentar	टेक्स्ट	अधिकतम 500 अक्षर

जवाब

फ़ील्ड	प्रकार	टिप्पणी
angenommen	true
ausstehend	true \| false	न भी हो सकता है
hinweis	टेक्स्ट	न भी हो सकता है

POST`/v1/abo/change`

VentionDesk सब्सक्रिप्शन का प्लान या बिलिंग अंतराल बदलें।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
tarif *	"solo" \| "team" \| "enterprise"
abrechnung *	"jaehrlich" \| "monatlich"
plaetze *	पूर्णांक	≥ 1 \| ≤ 10000
nonce *	टेक्स्ट	निश्चित पैटर्न

POST`/v1/abo/checkout`

VentionDesk सब्सक्रिप्शन लें (Stripe Checkout पर रीडायरेक्ट करता है)।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
tarif *	"solo" \| "team" \| "enterprise"
abrechnung *	"jaehrlich" \| "monatlich"

जवाब

फ़ील्ड	प्रकार	टिप्पणी
url	URL

GET`/v1/abo/export`

पूरे वर्कस्पेस का डेटा एक्सपोर्ट ZIP के रूप में (संरचना: डेटा एक्सपोर्ट देखें)।

एक्सेस मालिक

POST`/v1/abo/preview`

प्लान बदलने का प्रीव्यू, आनुपातिक राशि के साथ।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
tarif *	"solo" \| "team" \| "enterprise"
abrechnung *	"jaehrlich" \| "monatlich"
plaetze *	पूर्णांक	≥ 1 \| ≤ 10000

जवाब

फ़ील्ड	प्रकार	टिप्पणी
waehrung	टेक्स्ट
anteiligCent	पूर्णांक
rechnungCent	पूर्णांक
steuerCent	पूर्णांक
sofortCent	पूर्णांक
faelligAm	टेक्स्ट या null
imTest	true \| false

GET`/v1/abo/rechnungen`

VentionDesk की ओर से वर्कस्पेस को भेजे गए इनवॉइस।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
rechnungen	ऑब्जेक्ट की सूची

POST`/v1/abo/resume`

अवधि चलते रहने तक रद्दीकरण वापस लें।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
nonce *	टेक्स्ट	निश्चित पैटर्न

जवाब

फ़ील्ड	प्रकार	टिप्पणी
angenommen	true
ausstehend	true \| false	न भी हो सकता है
hinweis	टेक्स्ट	न भी हो सकता है

GET`/v1/abo/verlauf`

सब्सक्रिप्शन का इतिहास: साइन अप, बदलाव, रद्दीकरण।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
eintraege	ऑब्जेक्ट की सूची

POST`/v1/abo/zahlungsdaten`

Stripe पर भुगतान विवरण बदलें (Stripe पर रीडायरेक्ट करता है)।

एक्सेस मालिक

बॉडी (JSON)

फ़ील्ड	प्रकार	टिप्पणी
nonce *	टेक्स्ट	निश्चित पैटर्न

जवाब

फ़ील्ड	प्रकार	टिप्पणी
url	URL

GET`/v1/abo/zahlungsmittel`

सब्सक्रिप्शन के लिए सेव किया गया भुगतान तरीका।

एक्सेस मालिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
zahlungsmittel	ऑब्जेक्ट या null

सार्वजनिक इनटेक

POST`/f/:publicKey`

किसी दूसरी साइट पर HTML फ़ॉर्म: एक टिकट बनाता है (application/x-www-form-urlencoded)।

एक्सेस URL में सार्वजनिक प्रोजेक्ट की (vd_pub_…)

जवाब

फ़ील्ड	प्रकार	टिप्पणी
ok	true
ticket	ऑब्जेक्ट

POST`/v1/contact`

VentionDesk वेबसाइट का संपर्क फ़ॉर्म (/kontakt, इम्प्रिंट से लिंक)।

एक्सेस सार्वजनिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
ok	true

POST`/v1/intake/reports`

किसी ग्राहक ऐप के ब्राउज़र से रिपोर्ट, चाहें तो स्क्रीनशॉट के साथ — सार्वजनिक प्रोजेक्ट की से।

एक्सेस हेडर x-ventiondesk-key में सार्वजनिक प्रोजेक्ट कुंजी, अनुमत ओरिजिन

जवाब

फ़ील्ड	प्रकार	टिप्पणी
ok	true
ticket	ऑब्जेक्ट

POST`/v1/intake/tickets`

सर्वर से सर्वर टिकट भेजें, चाहें तो स्क्रीनशॉट के साथ — इनटेक कुंजी से।

एक्सेस Bearer के रूप में इनटेक कुंजी (vd_intake_…)

जवाब

फ़ील्ड	प्रकार	टिप्पणी
ok	true
ticket	ऑब्जेक्ट

POST`/v1/signup`

नए वर्कस्पेस का साइन अप, मालिक के खाते समेत।

एक्सेस सार्वजनिक

जवाब

फ़ील्ड	प्रकार	टिप्पणी
ok	true
email	ईमेल
testphaseBis	टेक्स्ट
checkoutUrl	URL या null	न भी हो सकता है \| डिफ़ॉल्ट: null

MCP

GET`/.well-known/oauth-protected-resource`

प्रोटेक्टेड रिसोर्स मेटाडेटा (RFC 9728): AI ऐप के साइन-इन के लिए MCP पता और ऑथराइज़ेशन सर्वर (Supabase Auth)।

एक्सेस सार्वजनिक

GET`/.well-known/oauth-protected-resource/mcp`

वही मेटाडेटा रिसोर्स के पाथ के तहत — उन क्लाइंट के लिए जो इसे जोड़ते हैं।

एक्सेस सार्वजनिक

ALL`/mcp`

POST के अलावा कोई भी मेथड 405 और Allow: POST के साथ जवाब देता है।

एक्सेस सार्वजनिक

POST`/mcp`

HTTP पर MCP सर्वर (स्टेटलेस): Claude के लिए टूल, एजेंट कुंजी या जुड़े हुए AI ऐप के टोकन के साथ। मान्य साइन-इन के बिना 401, WWW-Authenticate और मेटाडेटा तक के रास्ते के साथ।

एक्सेस Bearer के रूप में एजेंट कुंजी (vd_live_…) या जुड़े हुए AI ऐप का टोकन

वेबहुक

POST`/webhooks/errors/:provider/:integrationId`

हेडर में हस्ताक्षर वाले एरर ट्रैकर का वेबहुक (Sentry)।

एक्सेस प्रोवाइडर का हस्ताक्षर

POST`/webhooks/errors/:provider/:integrationId/:token`

URL में सीक्रेट वाले एरर ट्रैकर का वेबहुक (Bugsnag, Rollbar)।

एक्सेस URL में सीक्रेट

POST`/webhooks/stripe/:orgId`

वर्कस्पेस के अपने Stripe खाते का Stripe वेबहुक: इनवॉइस के भुगतान और रिफ़ंड दर्ज करता है।

एक्सेस हस्ताक्षर Stripe-Signature

संचालन और भुगतान लिंक

GET`/api/health`

सेवा का जीवन-संकेत — जब तक प्रोसेस चल रहा है, जवाब देता है।

एक्सेस सार्वजनिक

GET`/api/health/ready`

तैयारी: बताता है कि कौन-सी सेवाएँ कॉन्फ़िगर हैं; डेटाबेस के बिना “degraded”।

एक्सेस सार्वजनिक

GET`/pay/:token`

इनवॉइस का भुगतान लिंक: Stripe भुगतान पेज पर रीडायरेक्ट करता है (303)। लिंक इनवॉइस ईमेल और PDF में होता है।

एक्सेस URL में टोकन

GET`/pay/:token/abgebrochen`

Stripe पर भुगतान रद्द होने पर वापसी पेज।

एक्सेस URL में टोकन

GET`/pay/:token/danke`

Stripe पर सफल भुगतान के बाद वापसी पेज।

एक्सेस URL में टोकन

API संदर्भ

टास्क

GET/v1/tasks

POST/v1/tasks

GET/v1/tasks/:id

PATCH/v1/tasks/:id

POST/v1/tasks/:id/claim

POST/v1/tasks/:id/decision

POST/v1/tasks/:id/handoff

POST/v1/tasks/:id/result

एजेंट रन

POST/v1/agent/runs

POST/v1/agent/runs/:id/finish

POST/v1/agent/runs/:id/heartbeat

प्रोजेक्ट

POST/v1/errors/:id/resolve

POST/v1/errors/:id/task

GET/v1/errors/summary

POST/v1/monitors/probe

GET/v1/projects

GET/v1/projects/:id

PATCH/v1/projects/:id/customer

GET/v1/projects/:id/deploy

POST/v1/projects/:id/deploy

POST/v1/projects/:id/error-sources

DELETE/v1/projects/:id/error-sources/:sourceId

GET/v1/projects/:id/errors

GET/v1/projects/:id/hosting

POST/v1/projects/:id/hosting

DELETE/v1/projects/:id/hosting/:mappingId

DELETE/v1/projects/:id/render-services/:serviceId

GET/v1/projects/:id/report

GET/v1/projects/:id/roadmap

POST/v1/projects/:id/roadmap

PATCH/v1/projects/:id/roadmap/:phaseId

POST/v1/projects/:id/sync

GET/v1/projects/:id/time

GET/v1/projects/by-slug/:slug

टिकट

GET/v1/tickets

POST/v1/tickets

DELETE/v1/tickets/:id

GET/v1/tickets/:id

PATCH/v1/tickets/:id

POST/v1/tickets/:id/messages

POST/v1/tickets/:id/reply

POST/v1/tickets/:id/to-task

GET/v1/tickets/attachments/:id/url

नोट्स

POST/v1/notes

POST/v1/notes/:id/to-task

आइडिया

POST/v1/ideas

समय

GET/v1/time/entries

POST/v1/time/entries

DELETE/v1/time/entries/:id

PATCH/v1/time/entries/:id

GET/v1/time/timer

POST/v1/time/timer/start

POST/v1/time/timer/stop

GET/v1/time/unbilled

ग्राहक

DELETE/v1/customers/:id

GET/v1/customers/:id/deletion

POST/v1/customers/:id/portal-access

DELETE/v1/customers/:id/portal-access/:userId

POST/v1/customers/:id/portal-access/:userId/invite

दस्तावेज़

GET/v1/documents

PATCH/v1/documents/:id

GET/v1/documents/:id/url

फ़ाइनेंस

GET/v1/finance/export

GET/v1/invoices

POST/v1/invoices

GET/v1/invoices/:id

POST/v1/invoices/:id/cancel

GET/v1/invoices/:id/cancellation/pdf

POST/v1/invoices/:id/cancellation/send

GET`/v1/tasks`

POST`/v1/tasks`

GET`/v1/tasks/:id`

PATCH`/v1/tasks/:id`

POST`/v1/tasks/:id/claim`

POST`/v1/tasks/:id/decision`

POST`/v1/tasks/:id/handoff`

POST`/v1/tasks/:id/result`

POST`/v1/agent/runs`

POST`/v1/agent/runs/:id/finish`

POST`/v1/agent/runs/:id/heartbeat`

POST`/v1/errors/:id/resolve`

POST`/v1/errors/:id/task`

GET`/v1/errors/summary`

POST`/v1/monitors/probe`

GET`/v1/projects`

GET`/v1/projects/:id`

PATCH`/v1/projects/:id/customer`

GET`/v1/projects/:id/deploy`

POST`/v1/projects/:id/deploy`

POST`/v1/projects/:id/error-sources`

DELETE`/v1/projects/:id/error-sources/:sourceId`

GET`/v1/projects/:id/errors`

GET`/v1/projects/:id/hosting`

POST`/v1/projects/:id/hosting`

DELETE`/v1/projects/:id/hosting/:mappingId`

DELETE`/v1/projects/:id/render-services/:serviceId`

GET`/v1/projects/:id/report`

GET`/v1/projects/:id/roadmap`

POST`/v1/projects/:id/roadmap`

PATCH`/v1/projects/:id/roadmap/:phaseId`

POST`/v1/projects/:id/sync`

GET`/v1/projects/:id/time`

GET`/v1/projects/by-slug/:slug`

GET`/v1/tickets`

POST`/v1/tickets`

DELETE`/v1/tickets/:id`

GET`/v1/tickets/:id`

PATCH`/v1/tickets/:id`

POST`/v1/tickets/:id/messages`

POST`/v1/tickets/:id/reply`

POST`/v1/tickets/:id/to-task`

GET`/v1/tickets/attachments/:id/url`

POST`/v1/notes`

POST`/v1/notes/:id/to-task`

POST`/v1/ideas`

GET`/v1/time/entries`

POST`/v1/time/entries`

DELETE`/v1/time/entries/:id`

PATCH`/v1/time/entries/:id`

GET`/v1/time/timer`

POST`/v1/time/timer/start`

POST`/v1/time/timer/stop`

GET`/v1/time/unbilled`

DELETE`/v1/customers/:id`

GET`/v1/customers/:id/deletion`

POST`/v1/customers/:id/portal-access`

DELETE`/v1/customers/:id/portal-access/:userId`

POST`/v1/customers/:id/portal-access/:userId/invite`

GET`/v1/documents`

PATCH`/v1/documents/:id`

GET`/v1/documents/:id/url`

GET`/v1/finance/export`

GET`/v1/invoices`

POST`/v1/invoices`

GET`/v1/invoices/:id`

POST`/v1/invoices/:id/cancel`

GET`/v1/invoices/:id/cancellation/pdf`

POST`/v1/invoices/:id/cancellation/send`

POST`/v1/invoices/:id/dunning/send`

POST`/v1/invoices/:id/finalize`

POST`/v1/invoices/:id/payments`

GET`/v1/invoices/:id/pdf`

POST`/v1/invoices/:id/positions`

DELETE`/v1/invoices/:id/positions/:positionId`

PATCH`/v1/invoices/:id/positions/:positionId`

POST`/v1/invoices/:id/remind`

POST`/v1/invoices/:id/send`

GET`/v1/invoices/:id/stripe-refund`

POST`/v1/invoices/:id/stripe-refund`