One workflow with its draft and draftVersion, what runs now (published), what a person must finish before publishing (publishIssues), its warnings and editorUrl.
What a person must finish before publishing, each on its step (null for the trigger or the whole flow).
Show child attributes
warnings
object[]
required
What publishing allows but the person should see.
Show child attributes
editorUrl
string<uri>
required
Opens the workflow editor in Usertick, where a person publishes the workflow, which also turns it on.
draftUpdatedAt
string<date-time> | null
required
Example:
"2026-09-30T10:00:00.000Z"
createdAt
string<date-time>
required
Example:
"2026-09-30T10:00:00.000Z"
updatedAt
string<date-time> | null
required
Example:
"2026-09-30T10:00:00.000Z"
aiGenerated
boolean
required
aiGeneratedAt
string<date-time> | null
required
When text Usertick AI wrote was first stored here; null when people wrote all of it.
Example:
"2026-09-30T10:00:00.000Z"
Last modified on November 9, 2026
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Usertick","description":"Usertick documentation. Surveys, in-product feedback and reporting in one tool.","colors":{"primary":"#FF3C00","light":"#FF6A3A","dark":"#FF3C00"},"logo":{"light":"https://mintcdn.com/usertick/3wv5SLA0VtHq5hnl/logo/light.svg?fit=max\u0026auto=format\u0026n=3wv5SLA0VtHq5hnl\u0026q=85\u0026s=9461af4bcd4a352017accf4accb120f9","dark":"https://mintcdn.com/usertick/3wv5SLA0VtHq5hnl/logo/dark.svg?fit=max\u0026auto=format\u0026n=3wv5SLA0VtHq5hnl\u0026q=85\u0026s=38efcf251321688f80e92485435ec4cc"},"favicon":"https://mintcdn.com/usertick/Viv5pff-I3XvBVsI/favicon.svg?fit=max\u0026auto=format\u0026n=Viv5pff-I3XvBVsI\u0026q=85\u0026s=22114aee3fd94be42445bda4f6eac751","api":{"openapi":"api-reference/openapi.json","playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["bash","javascript","python"]},"mdx":{"auth":{"method":"bearer"},"server":"https://app.usertick.com/api/public/v1"}},"appearance":{"default":"system"},"navbar":{"links":[{"href":"/account/support","label":"Support"}],"primary":{"type":"button","label":"Open dashboard","href":"https://app.usertick.com"}},"footer":{"socials":{"website":"https://usertick.com","linkedin":"https://www.linkedin.com/company/usertick","x":"https://x.com/Usertick_ltd"},"links":[{"header":"Product","items":[{"label":"usertick.com","href":"https://usertick.com"},{"label":"Pricing","href":"https://usertick.com/pricing"},{"label":"Security","href":"https://usertick.com/security"},{"label":"Status","href":"https://status.usertick.com"}]},{"header":"Docs","items":[{"label":"Quickstart","href":"/quickstart"},{"label":"Install Usertick","href":"/installation"},{"label":"REST API","href":"/developers/api/overview"},{"label":"llms.txt","href":"/llms.txt"}]},{"header":"Help","items":[{"label":"Support","href":"/account/support"},{"label":"Troubleshooting","href":"/installation/troubleshooting"},{"label":"Contact","href":"https://usertick.com/contact"}]},{"header":"Legal","items":[{"label":"Privacy","href":"https://usertick.com/privacy"},{"label":"Terms","href":"https://usertick.com/terms"},{"label":"Cookies","href":"https://usertick.com/cookies"},{"label":"Subprocessors","href":"https://usertick.com/subprocessors"}]}]},"search":{"prompt":"Search the documentation"},"seo":{"organization":{"name":"Usertick","legalName":"Usertick Ltd","url":"https://usertick.com","logo":"https://cdn.usertick.com/brand/Usertick-o-icon.png","sameAs":["https://www.linkedin.com/company/usertick","https://x.com/Usertick_ltd"]}},"fonts":{"heading":{"family":"Schibsted Grotesk","weight":600,"source":"fonts/SchibstedGroteskVariable.woff2","format":"woff2"},"body":{"family":"Inter","weight":400,"source":"fonts/InterVariable.woff2","format":"woff2"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":true},"errors":{"404":{"redirect":false,"title":"This page doesn't exist","description":"The page may have moved. Search the documentation, or start from [Install Usertick](/installation) or the [home page](/)."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"thumbnails":{"surface":"brand","eyebrow":{"source":"group"}},"metadata":{"timestamp":true},"markdown":{"instructions":"Usertick runs surveys on websites, by link, by QR code and by email, and collects every response in one inbox with reports, dashboards and workflows. The REST API lives at https://app.usertick.com/api/public/v1 and uses Bearer API keys or OAuth access tokens; the JavaScript SDK is the @usertick/snippet package on npm."},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"usertick","hasAudioNarration":false,"actualSubdomain":"usertick","customDomains":["docs.usertick.com"],"gitSource":{"type":"github","owner":"usertick","repo":"docs","deployBranch":"main","contentDirectory":"public","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6afcd3daa70ca500331bbe70","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Developers","count":108},{"language":"default","tag":"API reference","count":82},{"language":"default","tag":"Surveys","count":28},{"language":"default","tag":"Workflows","count":21},{"language":"default","tag":"REST API","count":19},{"language":"default","tag":"Integrations","count":19},{"language":"default","tag":"Results","count":16},{"language":"default","tag":"Settings","count":15},{"language":"default","tag":"Build surveys","count":12},{"language":"default","tag":"Guides","count":11}],"searchSettings":{"isFiltersEnabled":true,"showContentSnippets":true,"fullPageSearch":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"Inter\";src:url(\"/fonts/InterVariable.woff2\") format(\"woff2\");font-weight:100 900;font-style:normal;font-display:swap}@font-face{font-family:\"Schibsted Grotesk\";src:url(\"/fonts/SchibstedGroteskVariable.woff2\") format(\"woff2\");font-weight:400 900;font-style:normal;font-display:swap}.ut-hub{--ut-text: #171717;--ut-text-2: #404040;--ut-muted: #525252;--ut-border: #e5e5e5;--ut-band: #fafafa;--ut-surface: #ffffff;--ut-brand: #ff3c00;font-family:var(--font-family-body-custom, \"Inter\"), -apple-system, \"Segoe UI\", sans-serif;color:var(--ut-text)}html.dark .ut-hub{--ut-text: #fafafa;--ut-text-2: #d4d4d4;--ut-muted: #a3a3a3;--ut-border: rgba(255, 255, 255, 0.12);--ut-band: rgba(255, 255, 255, 0.03);--ut-surface: rgba(255, 255, 255, 0.02);--ut-brand: #ff6a3a}.ut-hub a{text-decoration:none;border-bottom:0}.ut-hub .ut-display{font-family:var(--font-family-headings-custom, \"Schibsted Grotesk\"), -apple-system, \"Segoe UI\", sans-serif;font-weight:600;letter-spacing:-0.015em;color:var(--ut-text);margin:0}.ut-hero{background:var(--ut-band);border-bottom:1px solid var(--ut-border)}.ut-hero-inner{max-width:48rem;margin:0 auto;padding:4.5rem 1rem 4rem;display:flex;flex-direction:column;align-items:center;gap:1.25rem;text-align:center}.ut-hub .ut-hero-title{font-size:3rem;line-height:1.1}.ut-hero-text{margin:0;font-size:1.125rem;line-height:1.6;color:var(--ut-muted)}.ut-search{width:100%;display:flex;align-items:center;gap:0.75rem;padding:0.875rem 1rem;border:1px solid #d4d4d4;border-radius:0.75rem;background:var(--ut-surface);color:var(--ut-muted);font:inherit;font-size:1rem;text-align:left;cursor:pointer;box-shadow:0 1px 2px rgba(10, 10, 10, 0.05)}html.dark .ut-search{border-color:rgba(255, 255, 255, 0.15);background:rgba(255, 255, 255, 0.05)}.ut-search:hover{border-color:#a3a3a3}.ut-search-label{flex:1}.ut-kbd{font-size:0.75rem;border:1px solid var(--ut-border);border-radius:0.25rem;padding:0.0625rem 0.375rem}.ut-popular{display:flex;flex-wrap:wrap;justify-content:center;gap:0.5rem 1rem;font-size:0.875rem;color:var(--ut-muted)}.ut-hub .ut-popular-link{color:var(--ut-text-2);text-decoration:underline;text-decoration-color:var(--ut-border);text-underline-offset:4px}.ut-body{max-width:80rem;margin:0 auto;padding:3.5rem 1.5rem 5rem;display:flex;flex-direction:column;gap:4rem}.ut-section{display:flex;flex-direction:column;gap:1.25rem}.ut-section-head{display:flex;flex-wrap:wrap;align-items:baseline;justify-content:space-between;gap:1rem}.ut-hub .ut-section-title{font-size:1.5rem}.ut-muted{font-size:0.875rem;color:var(--ut-muted)}.ut-start{display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));gap:1.25rem}.ut-hub .ut-card{display:flex;flex-direction:column;gap:0.75rem;padding:1.5rem;border:1px solid var(--ut-border);border-radius:0.75rem;background:var(--ut-surface)}.ut-hub .ut-card:hover{border-color:#a3a3a3}.ut-card-step{font-size:0.875rem;font-weight:600;color:var(--ut-brand)}.ut-hub .ut-card-title{font-size:1.25rem}.ut-card-text{font-size:0.9375rem;line-height:1.6;color:var(--ut-muted)}.ut-areas{display:grid;grid-template-columns:repeat(3, minmax(0, 1fr));gap:2.5rem 2rem}.ut-area{display:flex;flex-direction:column;gap:0.625rem;padding-top:1rem;border-top:1px solid var(--ut-border)}.ut-hub .ut-area-title{font-size:1.0625rem;font-weight:600;color:var(--ut-text)}.ut-area-text{font-size:0.875rem;line-height:1.5;color:var(--ut-muted)}.ut-hub .ut-area-link{font-size:0.875rem;color:var(--ut-text-2)}.ut-hub .ut-area-more{font-size:0.875rem;font-weight:500;color:var(--ut-brand)}.ut-hub .ut-area-title:hover,.ut-hub .ut-area-link:hover,.ut-hub .ut-popular-link:hover{color:var(--ut-brand)}.ut-guides{display:flex;flex-direction:column;border:1px solid var(--ut-border);border-radius:0.75rem;overflow:hidden}.ut-hub .ut-guide{display:flex;flex-wrap:wrap;align-items:center;gap:1rem;padding:1rem 1.25rem;border-bottom:1px solid var(--ut-border)}.ut-hub .ut-guide:last-child{border-bottom:0}.ut-hub .ut-guide:hover{background:var(--ut-band)}.ut-guide-title{flex:1 1 16rem;font-size:0.9375rem;font-weight:500;color:var(--ut-text)}.ut-guide-meta,.ut-guide-time{font-size:0.8125rem;color:var(--ut-muted)}.ut-guide-time{min-width:4rem;text-align:right}.ut-dev{display:flex;flex-wrap:wrap;align-items:center;gap:2rem;padding:2.5rem;border-radius:1rem;background:#0a0a0a;color:#f5f5f5}html.dark .ut-dev{border:1px solid rgba(255, 255, 255, 0.12)}.ut-dev-text{flex:1 1 22rem;display:flex;flex-direction:column;gap:0.75rem}.ut-hub .ut-dev-title{font-size:1.5rem;color:#ffffff}.ut-dev-lead{margin:0;font-size:0.9375rem;line-height:1.6;color:#d4d4d4}.ut-dev-links{display:flex;flex-wrap:wrap;gap:0.5rem 1.25rem;font-size:0.875rem}.ut-hub .ut-dev-link{color:#ffffff;text-decoration:underline;text-decoration-color:rgba(255, 255, 255, 0.4);text-underline-offset:4px}.ut-hub .ut-dev-link:hover{text-decoration-color:#ffffff}.ut-dev-code{flex:1 1 26rem;min-width:0;margin:0;padding:1.25rem;overflow-x:auto;border:1px solid #404040;border-radius:0.75rem;background:#171717;color:#e5e5e5;font-family:ui-monospace, \"Roboto Mono\", Menlo, Consolas, monospace;font-size:0.8125rem;line-height:1.7}.ut-search svg{color:var(--ut-muted);background-color:var(--ut-muted)}.ut-foot{display:flex;flex-wrap:wrap;align-items:center;justify-content:space-between;gap:1rem;padding-top:2rem;border-top:1px solid var(--ut-border);font-size:0.875rem;color:var(--ut-muted)}.ut-foot-links{display:flex;flex-wrap:wrap;gap:0.5rem 1.25rem}@media (max-width: 1024px){.ut-areas{grid-template-columns:repeat(2, minmax(0, 1fr))}}@media (max-width: 768px){.ut-hub .ut-hero-title{font-size:2.25rem}.ut-hero-inner{padding-top:3rem}.ut-start,.ut-areas{grid-template-columns:minmax(0, 1fr)}.ut-body{padding:2.5rem 1rem 4rem}.ut-dev{padding:1.5rem}.ut-kbd{display:none}}"}],"page":{"pagePath":"developers/api/reference/get-workflow","slug":"/developers/api/reference/get-workflow","pageMetadata":{"title":"Get a workflow","openapi":"api-reference/openapi.json GET /workflows/{workflowId}","description":"One workflow with its draft and draftVersion, what runs now (published), what a person must finish before publishing (publishIssues), its warnings and editorUrl.\n\nScopes: workflows:read.","href":"/developers/api/reference/get-workflow"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"One workflow with its draft and draftVersion, what runs now (published), what a person must finish before publishing (publishIssues), its warnings and editorUrl.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Scopes: workflows:read.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Get a workflow","openapi":"api-reference/openapi.json GET /workflows/{workflowId}","description":"One workflow with its draft and draftVersion, what runs now (published), what a person must finish before publishing (publishIssues), its warnings and editorUrl.\n\nScopes: workflows:read.","href":"/developers/api/reference/get-workflow"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/usertick/6ca3f62bc5ac8ede/install-platform.js"],"openApiReferenceData":{"operation":{"operationId":"getWorkflow","summary":"Get a workflow","description":"One workflow with its draft and draftVersion, what runs now (published), what a person must finish before publishing (publishIssues), its warnings and editorUrl.\n\nScopes: workflows:read.","tags":["Workflows"],"x-scopes":["workflows:read"],"parameters":["8bf3a182-c91a-446a-ba6a-d3137e85721e"],"responses":{"200":"226d3911-8989-4e03-bc99-d93881da328c","401":"883064d7-a0c0-46a9-8cfe-770cd8630e35","403":"9968ff25-7d5a-48f9-b0a9-f2d77697a0f0","404":"b534b5c3-bc3b-47c1-8611-d417e212e9f1","429":"88abfd2d-e89a-459a-9c32-a0dfeb015d81"},"method":"get","type":"path","servers":["a7da5109-6827-4042-ac09-900ca098b7bc"],"security":["e6f2970d-e0b1-4f31-89d6-ce42413df7c4","c628e213-b100-46e6-8ac3-7d3b1e7a9ebb"],"path":"/workflows/{workflowId}","baseUrlOptions":["https://app.usertick.com/api/public/v1"],"title":"Get a workflow","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8bf3a182-c91a-446a-ba6a-d3137e85721e":{"name":"workflowId","in":"path","description":"A workflow id.","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"A workflow id.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"226d3911-8989-4e03-bc99-d93881da328c":{"description":"The workflow.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"The credential's requests per minute.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"What is left of it now.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"Seconds until the credential's budget is full again (the bucket refills continuously).","schema":{"type":"integer"}},"X-RateLimit-Org-Limit":{"description":"Every credential of the organization together, per minute.","schema":{"type":"integer"}},"X-RateLimit-Org-Remaining":{"description":"What is left of the organization's budget.","schema":{"type":"integer"}},"X-RateLimit-Org-Reset":{"description":"Seconds until the organization's budget is full again.","schema":{"type":"integer"}},"X-RateLimit-Window":{"description":"The window both budgets count over: 60s, since they are requests per minute.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"status":{"type":"string","enum":["draft","active","disabled","paused"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"hasUnpublishedChanges":{"type":"boolean","description":"The draft holds changes that don't run yet.","isRequired":true,"uniqueKey":"hasUnpublishedChanges","typeLabel":"boolean"},"draftVersion":{"type":"integer","description":"Send it back as expectedDraftVersion on the next edit.","isRequired":true,"uniqueKey":"draftVersion","typeLabel":"integer"},"draft":{"type":"object","properties":{"trigger":{"type":"object","properties":{"event":{"type":"string","description":"What starts the workflow.","enum":["response.created","response.analyzed","response.urgent","metric.threshold"],"isRequired":true,"uniqueKey":"draft.trigger.event","typeLabel":"enum\u003cstring>"},"alert":{"oneOf":[{"type":"object","description":"An alarm (metric.threshold). Any member may be missing while the draft is drawn; publishIssues says what a person must finish.","required":[],"properties":{"metric":{"oneOf":[{"type":"string","description":"nps, avg_score, detractors, responses, urgent or type.","maxLength":32,"uniqueKey":"draft.trigger.alert.oneOf.0.metric.oneOf.0","typeLabel":"string"},{"type":"null","description":"nps, avg_score, detractors, responses, urgent or type.","maxLength":32,"uniqueKey":"draft.trigger.alert.oneOf.0.metric.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft.trigger.alert.oneOf.0.metric","typeLabel":"string | null"},"questionId":{"oneOf":[{"type":"string","maxLength":64,"uniqueKey":"draft.trigger.alert.oneOf.0.questionId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":64,"uniqueKey":"draft.trigger.alert.oneOf.0.questionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft.trigger.alert.oneOf.0.questionId","typeLabel":"string | null"},"feedbackType":{"oneOf":[{"type":"string","description":"bug, idea, complaint, question or praise, for the type metric.","maxLength":32,"uniqueKey":"draft.trigger.alert.oneOf.0.feedbackType.oneOf.0","typeLabel":"string"},{"type":"null","description":"bug, idea, complaint, question or praise, for the type metric.","maxLength":32,"uniqueKey":"draft.trigger.alert.oneOf.0.feedbackType.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft.trigger.alert.oneOf.0.feedbackType","typeLabel":"string | null"},"window":{"oneOf":[{"type":"string","description":"1h, 24h, 7d or 30d.","maxLength":8,"uniqueKey":"draft.trigger.alert.oneOf.0.window.oneOf.0","typeLabel":"string"},{"type":"null","description":"1h, 24h, 7d or 30d.","maxLength":8,"uniqueKey":"draft.trigger.alert.oneOf.0.window.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft.trigger.alert.oneOf.0.window","typeLabel":"string | null"},"direction":{"oneOf":[{"type":"string","description":"below or above.","maxLength":8,"uniqueKey":"draft.trigger.alert.oneOf.0.direction.oneOf.0","typeLabel":"string"},{"type":"null","description":"below or above.","maxLength":8,"uniqueKey":"draft.trigger.alert.oneOf.0.direction.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft.trigger.alert.oneOf.0.direction","typeLabel":"string | null"},"value":{"oneOf":[{"type":"number","description":"The line.","uniqueKey":"draft.trigger.alert.oneOf.0.value.oneOf.0","typeLabel":"number"},{"type":"null","description":"The line.","uniqueKey":"draft.trigger.alert.oneOf.0.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft.trigger.alert.oneOf.0.value","typeLabel":"number | null"},"cooldown":{"oneOf":[{"type":"string","description":"1h, 6h, 24h or 7d.","maxLength":8,"uniqueKey":"draft.trigger.alert.oneOf.0.cooldown.oneOf.0","typeLabel":"string"},{"type":"null","description":"1h, 6h, 24h or 7d.","maxLength":8,"uniqueKey":"draft.trigger.alert.oneOf.0.cooldown.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft.trigger.alert.oneOf.0.cooldown","typeLabel":"string | null"},"notifyRecovery":{"type":"boolean","description":"Start once more when the number is back on the right side.","uniqueKey":"draft.trigger.alert.oneOf.0.notifyRecovery","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"draft.trigger.alert.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"draft.trigger.alert.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft.trigger.alert","typeLabel":"object | null"},"surveyIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"draft.trigger.surveyIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"The one survey the workflow belongs to, as a list of one; empty while none is chosen. A survey the credential can't read is 404 APK-006-005.","maxItems":1,"uniqueKey":"draft.trigger.surveyIds","typeLabel":"string\u003cuuid>[]"},"match":{"type":"string","enum":["all","any"],"uniqueKey":"draft.trigger.match","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"A condition field (GET /workflows/capabilities lists them).","maxLength":200,"isRequired":true,"uniqueKey":"draft.trigger.conditions.items.[INDEX].field","typeLabel":"string"},"op":{"type":"string","maxLength":32,"isRequired":true,"uniqueKey":"draft.trigger.conditions.items.[INDEX].op","typeLabel":"string"},"value":{"description":"A string, a number, a list of strings, or null for answered and not_answered.","uniqueKey":"draft.trigger.conditions.items.[INDEX].value","typeLabel":"any"}},"required":["field","op"],"additionalProperties":false,"uniqueKey":"draft.trigger.conditions.items.[INDEX]","typeLabel":"object"},"maxItems":50,"uniqueKey":"draft.trigger.conditions","typeLabel":"object[]"},"x":{"type":"number","uniqueKey":"draft.trigger.x","typeLabel":"number"},"y":{"type":"number","uniqueKey":"draft.trigger.y","typeLabel":"number"}},"required":["event"],"additionalProperties":false,"isRequired":true,"uniqueKey":"draft.trigger","typeLabel":"object"},"steps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique in the draft; \"trigger\" is the trigger's.","maxLength":64,"isRequired":true,"uniqueKey":"draft.steps.items.[INDEX].id","typeLabel":"string"},"kind":{"type":"string","enum":["action","branch","wait"],"isRequired":true,"uniqueKey":"draft.steps.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"x":{"type":"number","description":"Its place on the canvas. When no step and not the trigger names one, Usertick arranges the flow as the editor's Tidy up does.","uniqueKey":"draft.steps.items.[INDEX].x","typeLabel":"number"},"y":{"type":"number","uniqueKey":"draft.steps.items.[INDEX].y","typeLabel":"number"},"action":{"oneOf":[{"type":"string","description":"An action key (GET /workflows/capabilities); an unknown one is 400 PUB-001-004, one the plan lacks 403 PLN-002-001.","maxLength":100,"uniqueKey":"draft.steps.items.[INDEX].action.oneOf.0","typeLabel":"string"},{"type":"null","description":"An action key (GET /workflows/capabilities); an unknown one is 400 PUB-001-004, one the plan lacks 403 PLN-002-001.","maxLength":100,"uniqueKey":"draft.steps.items.[INDEX].action.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft.steps.items.[INDEX].action","typeLabel":"string | null"},"connectionId":{"oneOf":[{"type":"string","description":"A connection of the action's tool; one the organization can't send with is 400 PUB-016-002. Left out, a person picks it.","maxLength":64,"uniqueKey":"draft.steps.items.[INDEX].connectionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"A connection of the action's tool; one the organization can't send with is 400 PUB-016-002. Left out, a person picks it.","maxLength":64,"uniqueKey":"draft.steps.items.[INDEX].connectionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft.steps.items.[INDEX].connectionId","typeLabel":"string | null"},"params":{"type":"object","description":"The action's inputs, each a string or a boolean, at most 32 KB in all.","uniqueKey":"draft.steps.items.[INDEX].params","typeLabel":"object"},"match":{"type":"string","enum":["all","any"],"uniqueKey":"draft.steps.items.[INDEX].match","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"A condition field (GET /workflows/capabilities lists them).","maxLength":200,"isRequired":true,"uniqueKey":"draft.steps.items.[INDEX].conditions.items.[INDEX].field","typeLabel":"string"},"op":{"type":"string","maxLength":32,"isRequired":true,"uniqueKey":"draft.steps.items.[INDEX].conditions.items.[INDEX].op","typeLabel":"string"},"value":{"description":"A string, a number, a list of strings, or null for answered and not_answered.","uniqueKey":"draft.steps.items.[INDEX].conditions.items.[INDEX].value","typeLabel":"any"}},"required":["field","op"],"additionalProperties":false,"uniqueKey":"draft.steps.items.[INDEX].conditions.items.[INDEX]","typeLabel":"object"},"description":"A branch's conditions.","maxItems":50,"uniqueKey":"draft.steps.items.[INDEX].conditions","typeLabel":"object[]"},"waitSeconds":{"oneOf":[{"type":"integer","description":"A wait's seconds, 60 to 2,592,000 to publish.","uniqueKey":"draft.steps.items.[INDEX].waitSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","description":"A wait's seconds, 60 to 2,592,000 to publish.","uniqueKey":"draft.steps.items.[INDEX].waitSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft.steps.items.[INDEX].waitSeconds","typeLabel":"integer | null"},"aiGenerated":{"oneOf":[{"type":"boolean","description":"Output only: Usertick AI drafted the step. The API never marks a step it writes.","uniqueKey":"draft.steps.items.[INDEX].aiGenerated.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Output only: Usertick AI drafted the step. The API never marks a step it writes.","uniqueKey":"draft.steps.items.[INDEX].aiGenerated.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft.steps.items.[INDEX].aiGenerated","typeLabel":"boolean | null"},"aiGeneratedAt":{"oneOf":[{"type":"string","description":"When text Usertick AI wrote was first stored here; null when people wrote all of it.","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"uniqueKey":"draft.steps.items.[INDEX].aiGeneratedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When text Usertick AI wrote was first stored here; null when people wrote all of it.","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"uniqueKey":"draft.steps.items.[INDEX].aiGeneratedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"draft.steps.items.[INDEX].aiGeneratedAt","typeLabel":"string\u003cdate-time> | null"}},"required":["id","kind"],"additionalProperties":false,"uniqueKey":"draft.steps.items.[INDEX]","typeLabel":"object"},"maxItems":200,"uniqueKey":"draft.steps","typeLabel":"object[]"},"wires":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"A step id, or \"trigger\".","maxLength":64,"isRequired":true,"uniqueKey":"draft.wires.items.[INDEX].from","typeLabel":"string"},"port":{"type":"string","description":"out, or yes and no from a branch.","maxLength":32,"isRequired":true,"uniqueKey":"draft.wires.items.[INDEX].port","typeLabel":"string"},"to":{"type":"string","maxLength":64,"isRequired":true,"uniqueKey":"draft.wires.items.[INDEX].to","typeLabel":"string"}},"required":["from","port","to"],"additionalProperties":false,"uniqueKey":"draft.wires.items.[INDEX]","typeLabel":"object"},"maxItems":600,"uniqueKey":"draft.wires","typeLabel":"object[]"}},"required":["trigger"],"description":"The workflow as its editor holds it, at most 512 KB stored.","additionalProperties":false,"examples":[{"trigger":{"event":"response.analyzed","surveyIds":["11111111-1111-4111-8111-111111111111"],"match":"all","conditions":[{"field":"ai.type","op":"in","value":["bug"]}]},"steps":[{"id":"s1","kind":"action","action":"slack.post_message","params":{"text":"New bug report: {{response.text}}"}}],"wires":[{"from":"trigger","port":"out","to":"s1"}]}],"isRequired":true,"uniqueKey":"draft","typeLabel":"object"},"published":{"oneOf":[{"type":"object","description":"What runs now; null while the workflow was never published.","required":["trigger"],"example":{"trigger":{"event":"response.analyzed","surveyIds":["11111111-1111-4111-8111-111111111111"],"match":"all","conditions":[{"field":"ai.type","op":"in","value":["bug"]}]},"steps":[{"id":"s1","kind":"action","action":"slack.post_message","params":{"text":"New bug report: {{response.text}}"}}],"wires":[{"from":"trigger","port":"out","to":"s1"}]},"properties":{"trigger":{"type":"object","properties":{"event":{"type":"string","description":"What starts the workflow.","enum":["response.created","response.analyzed","response.urgent","metric.threshold"],"isRequired":true,"uniqueKey":"published.oneOf.0.trigger.event","typeLabel":"enum\u003cstring>"},"alert":{"oneOf":[{"type":"object","description":"An alarm (metric.threshold). Any member may be missing while the draft is drawn; publishIssues says what a person must finish.","required":[],"properties":{"metric":{"oneOf":[{"type":"string","description":"nps, avg_score, detractors, responses, urgent or type.","maxLength":32,"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.metric.oneOf.0","typeLabel":"string"},{"type":"null","description":"nps, avg_score, detractors, responses, urgent or type.","maxLength":32,"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.metric.oneOf.1","typeLabel":"null"}],"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.metric","typeLabel":"string | null"},"questionId":{"oneOf":[{"type":"string","maxLength":64,"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.questionId.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":64,"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.questionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.questionId","typeLabel":"string | null"},"feedbackType":{"oneOf":[{"type":"string","description":"bug, idea, complaint, question or praise, for the type metric.","maxLength":32,"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.feedbackType.oneOf.0","typeLabel":"string"},{"type":"null","description":"bug, idea, complaint, question or praise, for the type metric.","maxLength":32,"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.feedbackType.oneOf.1","typeLabel":"null"}],"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.feedbackType","typeLabel":"string | null"},"window":{"oneOf":[{"type":"string","description":"1h, 24h, 7d or 30d.","maxLength":8,"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.window.oneOf.0","typeLabel":"string"},{"type":"null","description":"1h, 24h, 7d or 30d.","maxLength":8,"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.window.oneOf.1","typeLabel":"null"}],"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.window","typeLabel":"string | null"},"direction":{"oneOf":[{"type":"string","description":"below or above.","maxLength":8,"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.direction.oneOf.0","typeLabel":"string"},{"type":"null","description":"below or above.","maxLength":8,"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.direction.oneOf.1","typeLabel":"null"}],"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.direction","typeLabel":"string | null"},"value":{"oneOf":[{"type":"number","description":"The line.","uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.value.oneOf.0","typeLabel":"number"},{"type":"null","description":"The line.","uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.value","typeLabel":"number | null"},"cooldown":{"oneOf":[{"type":"string","description":"1h, 6h, 24h or 7d.","maxLength":8,"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.cooldown.oneOf.0","typeLabel":"string"},{"type":"null","description":"1h, 6h, 24h or 7d.","maxLength":8,"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.cooldown.oneOf.1","typeLabel":"null"}],"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.cooldown","typeLabel":"string | null"},"notifyRecovery":{"type":"boolean","description":"Start once more when the number is back on the right side.","uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0.notifyRecovery","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"published.oneOf.0.trigger.alert.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"published.oneOf.0.trigger.alert.oneOf.1","typeLabel":"null"}],"uniqueKey":"published.oneOf.0.trigger.alert","typeLabel":"object | null"},"surveyIds":{"type":"array","items":{"type":"string","format":"uuid","uniqueKey":"published.oneOf.0.trigger.surveyIds.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"The one survey the workflow belongs to, as a list of one; empty while none is chosen. A survey the credential can't read is 404 APK-006-005.","maxItems":1,"uniqueKey":"published.oneOf.0.trigger.surveyIds","typeLabel":"string\u003cuuid>[]"},"match":{"type":"string","enum":["all","any"],"uniqueKey":"published.oneOf.0.trigger.match","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"A condition field (GET /workflows/capabilities lists them).","maxLength":200,"isRequired":true,"uniqueKey":"published.oneOf.0.trigger.conditions.items.[INDEX].field","typeLabel":"string"},"op":{"type":"string","maxLength":32,"isRequired":true,"uniqueKey":"published.oneOf.0.trigger.conditions.items.[INDEX].op","typeLabel":"string"},"value":{"description":"A string, a number, a list of strings, or null for answered and not_answered.","uniqueKey":"published.oneOf.0.trigger.conditions.items.[INDEX].value","typeLabel":"any"}},"required":["field","op"],"additionalProperties":false,"uniqueKey":"published.oneOf.0.trigger.conditions.items.[INDEX]","typeLabel":"object"},"maxItems":50,"uniqueKey":"published.oneOf.0.trigger.conditions","typeLabel":"object[]"},"x":{"type":"number","uniqueKey":"published.oneOf.0.trigger.x","typeLabel":"number"},"y":{"type":"number","uniqueKey":"published.oneOf.0.trigger.y","typeLabel":"number"}},"required":["event"],"additionalProperties":false,"isRequired":true,"uniqueKey":"published.oneOf.0.trigger","typeLabel":"object"},"steps":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Unique in the draft; \"trigger\" is the trigger's.","maxLength":64,"isRequired":true,"uniqueKey":"published.oneOf.0.steps.items.[INDEX].id","typeLabel":"string"},"kind":{"type":"string","enum":["action","branch","wait"],"isRequired":true,"uniqueKey":"published.oneOf.0.steps.items.[INDEX].kind","typeLabel":"enum\u003cstring>"},"x":{"type":"number","description":"Its place on the canvas. When no step and not the trigger names one, Usertick arranges the flow as the editor's Tidy up does.","uniqueKey":"published.oneOf.0.steps.items.[INDEX].x","typeLabel":"number"},"y":{"type":"number","uniqueKey":"published.oneOf.0.steps.items.[INDEX].y","typeLabel":"number"},"action":{"oneOf":[{"type":"string","description":"An action key (GET /workflows/capabilities); an unknown one is 400 PUB-001-004, one the plan lacks 403 PLN-002-001.","maxLength":100,"uniqueKey":"published.oneOf.0.steps.items.[INDEX].action.oneOf.0","typeLabel":"string"},{"type":"null","description":"An action key (GET /workflows/capabilities); an unknown one is 400 PUB-001-004, one the plan lacks 403 PLN-002-001.","maxLength":100,"uniqueKey":"published.oneOf.0.steps.items.[INDEX].action.oneOf.1","typeLabel":"null"}],"uniqueKey":"published.oneOf.0.steps.items.[INDEX].action","typeLabel":"string | null"},"connectionId":{"oneOf":[{"type":"string","description":"A connection of the action's tool; one the organization can't send with is 400 PUB-016-002. Left out, a person picks it.","maxLength":64,"uniqueKey":"published.oneOf.0.steps.items.[INDEX].connectionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"A connection of the action's tool; one the organization can't send with is 400 PUB-016-002. Left out, a person picks it.","maxLength":64,"uniqueKey":"published.oneOf.0.steps.items.[INDEX].connectionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"published.oneOf.0.steps.items.[INDEX].connectionId","typeLabel":"string | null"},"params":{"type":"object","description":"The action's inputs, each a string or a boolean, at most 32 KB in all.","uniqueKey":"published.oneOf.0.steps.items.[INDEX].params","typeLabel":"object"},"match":{"type":"string","enum":["all","any"],"uniqueKey":"published.oneOf.0.steps.items.[INDEX].match","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"A condition field (GET /workflows/capabilities lists them).","maxLength":200,"isRequired":true,"uniqueKey":"published.oneOf.0.steps.items.[INDEX].conditions.items.[INDEX].field","typeLabel":"string"},"op":{"type":"string","maxLength":32,"isRequired":true,"uniqueKey":"published.oneOf.0.steps.items.[INDEX].conditions.items.[INDEX].op","typeLabel":"string"},"value":{"description":"A string, a number, a list of strings, or null for answered and not_answered.","uniqueKey":"published.oneOf.0.steps.items.[INDEX].conditions.items.[INDEX].value","typeLabel":"any"}},"required":["field","op"],"additionalProperties":false,"uniqueKey":"published.oneOf.0.steps.items.[INDEX].conditions.items.[INDEX]","typeLabel":"object"},"description":"A branch's conditions.","maxItems":50,"uniqueKey":"published.oneOf.0.steps.items.[INDEX].conditions","typeLabel":"object[]"},"waitSeconds":{"oneOf":[{"type":"integer","description":"A wait's seconds, 60 to 2,592,000 to publish.","uniqueKey":"published.oneOf.0.steps.items.[INDEX].waitSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","description":"A wait's seconds, 60 to 2,592,000 to publish.","uniqueKey":"published.oneOf.0.steps.items.[INDEX].waitSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"published.oneOf.0.steps.items.[INDEX].waitSeconds","typeLabel":"integer | null"},"aiGenerated":{"oneOf":[{"type":"boolean","description":"Output only: Usertick AI drafted the step. The API never marks a step it writes.","uniqueKey":"published.oneOf.0.steps.items.[INDEX].aiGenerated.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Output only: Usertick AI drafted the step. The API never marks a step it writes.","uniqueKey":"published.oneOf.0.steps.items.[INDEX].aiGenerated.oneOf.1","typeLabel":"null"}],"uniqueKey":"published.oneOf.0.steps.items.[INDEX].aiGenerated","typeLabel":"boolean | null"},"aiGeneratedAt":{"oneOf":[{"type":"string","description":"When text Usertick AI wrote was first stored here; null when people wrote all of it.","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"uniqueKey":"published.oneOf.0.steps.items.[INDEX].aiGeneratedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When text Usertick AI wrote was first stored here; null when people wrote all of it.","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"uniqueKey":"published.oneOf.0.steps.items.[INDEX].aiGeneratedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"published.oneOf.0.steps.items.[INDEX].aiGeneratedAt","typeLabel":"string\u003cdate-time> | null"}},"required":["id","kind"],"additionalProperties":false,"uniqueKey":"published.oneOf.0.steps.items.[INDEX]","typeLabel":"object"},"maxItems":200,"uniqueKey":"published.oneOf.0.steps","typeLabel":"object[]"},"wires":{"type":"array","items":{"type":"object","properties":{"from":{"type":"string","description":"A step id, or \"trigger\".","maxLength":64,"isRequired":true,"uniqueKey":"published.oneOf.0.wires.items.[INDEX].from","typeLabel":"string"},"port":{"type":"string","description":"out, or yes and no from a branch.","maxLength":32,"isRequired":true,"uniqueKey":"published.oneOf.0.wires.items.[INDEX].port","typeLabel":"string"},"to":{"type":"string","maxLength":64,"isRequired":true,"uniqueKey":"published.oneOf.0.wires.items.[INDEX].to","typeLabel":"string"}},"required":["from","port","to"],"additionalProperties":false,"uniqueKey":"published.oneOf.0.wires.items.[INDEX]","typeLabel":"object"},"maxItems":600,"uniqueKey":"published.oneOf.0.wires","typeLabel":"object[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"published.oneOf.0","typeLabel":"object"},{"type":"null","description":"What runs now; null while the workflow was never published.","isRequired":true,"uniqueKey":"published.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"published","typeLabel":"object | null"},"pausedReason":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"pausedReason.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"pausedReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"pausedReason","typeLabel":"string | null"},"pausedAt":{"oneOf":[{"type":"string","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"pausedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"pausedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"pausedAt","typeLabel":"string\u003cdate-time> | null"},"publishIssues":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"publishIssues.items.[INDEX].code","typeLabel":"string"},"stepId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"publishIssues.items.[INDEX].stepId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"publishIssues.items.[INDEX].stepId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"publishIssues.items.[INDEX].stepId","typeLabel":"string | null"},"field":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"publishIssues.items.[INDEX].field.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"publishIssues.items.[INDEX].field.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"publishIssues.items.[INDEX].field","typeLabel":"string | null"}},"required":["code","stepId","field"],"additionalProperties":false,"uniqueKey":"publishIssues.items.[INDEX]","typeLabel":"object"},"description":"What a person must finish before publishing, each on its step (null for the trigger or the whole flow).","isRequired":true,"uniqueKey":"publishIssues","typeLabel":"object[]"},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"warnings.items.[INDEX].code","typeLabel":"string"},"stepId":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"warnings.items.[INDEX].stepId.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"warnings.items.[INDEX].stepId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"warnings.items.[INDEX].stepId","typeLabel":"string | null"},"values":{"type":"array","items":{"type":"string","uniqueKey":"warnings.items.[INDEX].values.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"warnings.items.[INDEX].values","typeLabel":"string[]"}},"required":["code","stepId","values"],"additionalProperties":false,"uniqueKey":"warnings.items.[INDEX]","typeLabel":"object"},"description":"What publishing allows but the person should see.","isRequired":true,"uniqueKey":"warnings","typeLabel":"object[]"},"editorUrl":{"type":"string","description":"Opens the workflow editor in Usertick, where a person publishes the workflow, which also turns it on.","format":"uri","isRequired":true,"uniqueKey":"editorUrl","typeLabel":"string\u003curi>"},"draftUpdatedAt":{"oneOf":[{"type":"string","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"draftUpdatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"draftUpdatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"draftUpdatedAt","typeLabel":"string\u003cdate-time> | null"},"createdAt":{"type":"string","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"updatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"updatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time> | null"},"aiGenerated":{"type":"boolean","isRequired":true,"uniqueKey":"aiGenerated","typeLabel":"boolean"},"aiGeneratedAt":{"oneOf":[{"type":"string","description":"When text Usertick AI wrote was first stored here; null when people wrote all of it.","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"aiGeneratedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"When text Usertick AI wrote was first stored here; null when people wrote all of it.","format":"date-time","examples":["2026-09-30T10:00:00.000Z"],"isRequired":true,"uniqueKey":"aiGeneratedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"aiGeneratedAt","typeLabel":"string\u003cdate-time> | null"}},"required":["id","name","status","hasUnpublishedChanges","draftVersion","draft","published","pausedReason","pausedAt","publishIssues","warnings","editorUrl","draftUpdatedAt","createdAt","updatedAt","aiGenerated","aiGeneratedAt"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","status":"draft","hasUnpublishedChanges":true,"draftVersion":123,"draft":{"trigger":{"event":"response.analyzed","surveyIds":["11111111-1111-4111-8111-111111111111"],"match":"all","conditions":[{"field":"ai.type","op":"in","value":["bug"]}]},"steps":[{"id":"s1","kind":"action","action":"slack.post_message","params":{"text":"New bug report: {{response.text}}"}}],"wires":[{"from":"trigger","port":"out","to":"s1"}]},"published":{"trigger":{"event":"response.analyzed","surveyIds":["11111111-1111-4111-8111-111111111111"],"match":"all","conditions":[{"field":"ai.type","op":"in","value":["bug"]}]},"steps":[{"id":"s1","kind":"action","action":"slack.post_message","params":{"text":"New bug report: {{response.text}}"}}],"wires":[{"from":"trigger","port":"out","to":"s1"}]},"pausedReason":"\u003cstring>","pausedAt":"2026-09-30T10:00:00.000Z","publishIssues":[{"code":"\u003cstring>","stepId":"\u003cstring>","field":"\u003cstring>"}],"warnings":[{"code":"\u003cstring>","stepId":"\u003cstring>","values":["\u003cstring>"]}],"editorUrl":"\u003cstring>","draftUpdatedAt":"2026-09-30T10:00:00.000Z","createdAt":"2026-09-30T10:00:00.000Z","updatedAt":"2026-09-30T10:00:00.000Z","aiGenerated":true,"aiGeneratedAt":"2026-09-30T10:00:00.000Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"883064d7-a0c0-46a9-8cfe-770cd8630e35":{"description":"No credential, one that is invalid, expired or revoked, or a token an AI assistant got for the MCP server. Codes: APK-004-001, APK-004-002, APK-004-007.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"APK-004-001":{"title":"APK-004-001","summary":"Send an API key or an access token in the Authorization header.","value":{"statusCode":401,"success":false,"code":"APK-004-001","message":"Send an API key or an access token in the Authorization header.","data":null}},"APK-004-002":{"title":"APK-004-002","summary":"The API key or access token is invalid, expired or revoked. Connect again with a valid one.","value":{"statusCode":401,"success":false,"code":"APK-004-002","message":"The API key or access token is invalid, expired or revoked. Connect again with a valid one.","data":null}},"APK-004-007":{"title":"APK-004-007","summary":"This credential is for another server. The MCP server takes only the access tokens an assistant gets when it signs in, and the REST API takes API keys and app tokens.","value":{"statusCode":401,"success":false,"code":"APK-004-007","message":"This credential is for another server. The MCP server takes only the access tokens an assistant gets when it signs in, and the REST API takes API keys and app tokens.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"9968ff25-7d5a-48f9-b0a9-f2d77697a0f0":{"description":"The request was refused. Codes: APK-004-004, APK-004-005, APK-004-008, APK-004-009, AUTHZ-001-002.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"APK-004-004":{"title":"APK-004-004","summary":"This API key or app doesn't have permission for this request. Grant it the required scope.","value":{"statusCode":403,"success":false,"code":"APK-004-004","message":"This API key or app doesn't have permission for this request. Grant it the required scope.","data":null}},"APK-004-005":{"title":"APK-004-005","summary":"Your plan doesn't include API keys. To use them, upgrade to Pro or higher.","value":{"statusCode":403,"success":false,"code":"APK-004-005","message":"Your plan doesn't include API keys. To use them, upgrade to Pro or higher.","data":null}},"APK-004-008":{"title":"APK-004-008","summary":"This organization's plan doesn't include apps that use the API, such as Zapier. To use them, contact Usertick sales to change the plan.","value":{"statusCode":403,"success":false,"code":"APK-004-008","message":"This organization's plan doesn't include apps that use the API, such as Zapier. To use them, contact Usertick sales to change the plan.","data":null}},"APK-004-009":{"title":"APK-004-009","summary":"This organization's plan doesn't include the MCP server. To use an AI assistant with Usertick, upgrade to Starter or higher.","value":{"statusCode":403,"success":false,"code":"APK-004-009","message":"This organization's plan doesn't include the MCP server. To use an AI assistant with Usertick, upgrade to Starter or higher.","data":null}},"AUTHZ-001-002":{"title":"AUTHZ-001-002","summary":"Your role doesn't have the required permission.","value":{"statusCode":403,"success":false,"code":"AUTHZ-001-002","message":"Your role doesn't have the required permission.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"b534b5c3-bc3b-47c1-8611-d417e212e9f1":{"description":"The resource couldn't be found. Codes: PUB-016-001.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"PUB-016-001":{"title":"PUB-016-001","summary":"The workflow couldn't be found.","value":{"statusCode":404,"success":false,"code":"PUB-016-001","message":"The workflow couldn't be found.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"},"88abfd2d-e89a-459a-9c32-a0dfeb015d81":{"description":"Over the credential's or the organization's budget, or over the per-address limit that is checked before the credential (GEN-429-001, without X-RateLimit headers). Codes: APK-004-003, APK-004-006, GEN-429-001.","headers":{"X-Request-Id":{"description":"This answer's id (req_ and 32 hex characters), also in the logs. Quote it to support.","schema":{"type":"string"}},"Retry-After":{"description":"Seconds to wait before trying again. On a 429 over a budget, the time the bucket takes to refill one request (1 second at 120 or 300 a minute); X-RateLimit-Reset says when the whole budget is back.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","description":"The HTTP status, again.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"success":{"type":"boolean","description":"Always false.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"code":{"type":"string","description":"What went wrong, stable across versions (see x-error-codes). For invalid fields, the first field's code.","examples":["PUB-001-001"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.0","typeLabel":"string"},{"type":"null","description":"The code's message in English (US); null for a code without one.","isRequired":true,"uniqueKey":"message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"message","typeLabel":"string | null"},"data":{"description":"Extra context for some errors; null otherwise.","isRequired":true,"uniqueKey":"data","typeLabel":"any"},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","description":"The query parameter, or the body property (camelCase, dotted when nested).","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"errors.items.[INDEX].message.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string | null"}},"required":["field","code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Every invalid field, in the order of the request's parameters. Only on a 400 about fields.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["statusCode","success","code","message","data"],"description":"Every error answer. Success answers are the plain resource or list instead.","additionalProperties":false,"examples":[{"statusCode":400,"success":false,"code":"PUB-001-001","message":"The limit must be between 1 and 100.","data":null,"errors":[{"field":"limit","code":"PUB-001-001","message":"The limit must be between 1 and 100."},{"field":"sort","code":"PUB-001-005","message":"The sort order must be asc or desc."}]}],"uniqueKey":"","typeLabel":"object"},"examples":{"APK-004-003":{"title":"APK-004-003","summary":"This API key or app sent too many requests. Wait a minute and try again.","value":{"statusCode":429,"success":false,"code":"APK-004-003","message":"This API key or app sent too many requests. Wait a minute and try again.","data":null}},"APK-004-006":{"title":"APK-004-006","summary":"Your organization sent too many API requests. Wait a minute and try again.","value":{"statusCode":429,"success":false,"code":"APK-004-006","message":"Your organization sent too many API requests. Wait a minute and try again.","data":null}},"GEN-429-001":{"title":"GEN-429-001","summary":"Too many requests were sent. Wait a minute and try again.","value":{"statusCode":429,"success":false,"code":"GEN-429-001","message":"Too many requests were sent. Wait a minute and try again.","data":null}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"e6f2970d-e0b1-4f31-89d6-ce42413df7c4":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key (utk_live_...) or an app's OAuth access token (uto_...).","scopes":[],"schemeName":"bearerAuth"}},"c628e213-b100-46e6-8ac3-7d3b1e7a9ebb":{"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"The API key, for clients that cannot send Authorization.","scopes":[],"schemeName":"apiKeyHeader"}}},"servers":{"a7da5109-6827-4042-ac09-900ca098b7bc":{"url":"https://app.usertick.com/api/public/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key (utk_live_...) or an app's OAuth access token (uto_...).","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key (utk_live_...) or an app's OAuth access token (uto_...).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"The API key, for clients that cannot send Authorization.","scopes":[],"schemeName":"apiKeyHeader"},"schema":{"title":"X-Api-Key","type":"string","description":"The API key, for clients that cannot send Authorization.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyHeader","name":"X-Api-Key"}],"title":"apiKeyHeader"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"usertick","siteName":"Usertick","title":"Get a workflow - Usertick","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T19:17:28.275Z","gitLastModified":"2026-11-09T19:17:06.000Z","originalFileLocation":"developers/api/reference/get-workflow.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"One workflow with its draft and draftVersion, what runs now (published), what a person must finish before publishing (publishIssues), its warnings and editorUrl. Scopes: workflows:read.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Usertick\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/usertick/_hUnJX6C5n_2F4gu/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/usertick/_hUnJX6C5n_2F4gu/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/usertick/_hUnJX6C5n_2F4gu/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/usertick/_hUnJX6C5n_2F4gu/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/usertick/_hUnJX6C5n_2F4gu/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/usertick/_hUnJX6C5n_2F4gu/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/usertick/_hUnJX6C5n_2F4gu/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/usertick/_hUnJX6C5n_2F4gu/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/usertick/_hUnJX6C5n_2F4gu/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a workflow - Usertick\">\u003cmeta data-mint-head property=\"og:description\" content=\"One workflow with its draft and draftVersion, what runs now (published), what a person must finish before publishing (publishIssues), its warnings and editorUrl. Scopes: workflows:read.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Usertick\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.usertick.com/developers/api/reference/get-workflow\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://usertick.mintlify.site/_mintlify/api/og/v2?division=Workflows\u0026amp;title=Get+a+workflow\u0026amp;description=One+workflow+with+its+draft+and+draftVersion%2C+what+runs+now+%28published%29%2C+what+a+person+must+finish+before+publishing+%28publishIssues%29%2C+its+warnings+and+editorUrl\u0026amp;theme=5e4c20761a162105c03832f0\u0026amp;signature=d81c49696155e997d3eb54f5355c22ee000217ea81fe4b23919aa009a3fa733a\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a workflow - Usertick\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"One workflow with its draft and draftVersion, what runs now (published), what a person must finish before publishing (publishIssues), its warnings and editorUrl. Scopes: workflows:read.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://usertick.mintlify.site/_mintlify/api/og/v2?division=Workflows\u0026amp;title=Get+a+workflow\u0026amp;description=One+workflow+with+its+draft+and+draftVersion%2C+what+runs+now+%28published%29%2C+what+a+person+must+finish+before+publishing+%28publishIssues%29%2C+its+warnings+and+editorUrl\u0026amp;theme=5e4c20761a162105c03832f0\u0026amp;signature=d81c49696155e997d3eb54f5355c22ee000217ea81fe4b23919aa009a3fa733a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/usertick/_hUnJX6C5n_2F4gu/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Usertick\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF3C00\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.usertick.com/developers/api/reference/get-workflow\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/api/reference/get-workflow.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://usertick.com/#organization\",\"name\":\"Usertick\",\"legalName\":\"Usertick Ltd\",\"url\":\"https://usertick.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://cdn.usertick.com/brand/Usertick-o-icon.png\"},\"sameAs\":[\"https://www.linkedin.com/company/usertick\",\"https://x.com/Usertick_ltd\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.usertick.com#website\",\"name\":\"Usertick\",\"url\":\"https://docs.usertick.com\",\"publisher\":{\"@id\":\"https://usertick.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.usertick.com/developers/api/reference/get-workflow#webpage\",\"url\":\"https://docs.usertick.com/developers/api/reference/get-workflow\",\"name\":\"Get a workflow\",\"description\":\"One workflow with its draft and draftVersion, what runs now (published), what a person must finish before publishing (publishIssues), its warnings and editorUrl. Scopes: workflows:read.\",\"dateModified\":\"2026-11-09T19:17:06.000Z\",\"isPartOf\":{\"@id\":\"https://docs.usertick.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usertick.com/developers/api/reference/get-workflow#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usertick.com/developers/api/reference/get-workflow#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.usertick.com/developers/api/reference/get-me\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Workflows\",\"item\":\"https://docs.usertick.com/developers/api/reference/get-workflow-capabilities\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a workflow\",\"item\":\"https://docs.usertick.com/developers/api/reference/get-workflow\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.usertick.com/developers/api/reference/get-workflow#apireference\",\"headline\":\"Get a workflow\",\"name\":\"Get a workflow\",\"description\":\"One workflow with its draft and draftVersion, what runs now (published), what a person must finish before publishing (publishIssues), its warnings and editorUrl. Scopes: workflows:read.\",\"url\":\"https://docs.usertick.com/developers/api/reference/get-workflow\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usertick.com/developers/api/reference/get-workflow#webpage\"},\"dateModified\":\"2026-11-09T19:17:06.000Z\",\"publisher\":{\"@id\":\"https://usertick.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.usertick.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Usertick\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Usertick\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/developers/api/reference/get-workflow.md","siteName":"Usertick","nav":{"global":null,"tabs":[{"tab":"Get started","icon":"rocket","pages":[{"title":"Get started","href":""}]},{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/guides"}]},{"tab":"Install","icon":"code","pages":[{"title":"Install","href":"/installation"}]},{"tab":"Surveys","icon":"square-pen","pages":[{"title":"Surveys","href":"/surveys"}]},{"tab":"Email","icon":"mail","pages":[{"title":"Email","href":"/email"}]},{"tab":"Results","icon":"chart-column","pages":[{"title":"Results","href":"/results"}]},{"tab":"Workflows","icon":"workflow","pages":[{"title":"Workflows","href":"/workflows/overview"}]},{"tab":"Integrations","icon":"blocks","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Settings","icon":"settings","pages":[{"title":"Settings","href":"/account"}]},{"tab":"Developers","icon":"terminal","groups":[{"group":"JavaScript SDK","icon":"braces","root":{"title":"JavaScript SDK","sidebarTitle":"Overview","href":"/developers/sdk/overview"},"directory":"card","pages":[{"title":"SDK reference","href":"/developers/sdk/reference"},{"title":"SDK events","href":"/developers/sdk/events"}]},{"group":"REST API","icon":"server","root":{"title":"REST API","sidebarTitle":"Overview","href":"/developers/api/overview"},"directory":"card","pages":[{"title":"Authentication","href":"/developers/api/authentication"},{"title":"OAuth for apps","href":"/developers/api/oauth"},{"title":"Errors","href":"/developers/api/errors"},{"title":"Rate limits","href":"/developers/api/rate-limits"},{"title":"Pagination","href":"/developers/api/pagination"},{"title":"Idempotency","href":"/developers/api/idempotency"},{"title":"Versioning","href":"/developers/api/versioning"},{"title":"The Response resource","sidebarTitle":"The Response resource","href":"/developers/api/response-object"},{"title":"Share, archive and copy surveys","sidebarTitle":"Share, archive and copy","href":"/developers/api/surveys"},{"title":"Results per question","href":"/developers/api/results"},{"title":"Metrics","href":"/developers/api/metrics"},{"title":"Download files","href":"/developers/api/attachments"},{"title":"Contacts and lists","sidebarTitle":"Contacts and lists","href":"/developers/api/contacts"},{"title":"Email sends","sidebarTitle":"Email sends","href":"/developers/api/email-sends"},{"title":"Dashboard drafts","sidebarTitle":"Dashboard drafts","href":"/developers/api/dashboard-drafts"},{"title":"Workflow drafts","sidebarTitle":"Workflow drafts","href":"/developers/api/workflow-drafts"},{"title":"Exports","sidebarTitle":"Exports","href":"/developers/api/exports"},{"title":"Support tickets","sidebarTitle":"Support tickets","href":"/developers/api/support-tickets"},{"title":"Erase personal data","href":"/developers/api/erasure"}]},{"group":"API reference","pages":[{"group":"Account","pages":[{"title":"Get the current credential","openapi":"api-reference/openapi.json GET /me","href":"/developers/api/reference/get-me"}]},{"group":"Surveys","pages":[{"title":"List surveys","openapi":"api-reference/openapi.json GET /surveys","href":"/developers/api/reference/list-surveys"},{"title":"Get a survey","openapi":"api-reference/openapi.json GET /surveys/{surveyId}","href":"/developers/api/reference/get-survey"},{"title":"Get a survey's share link","openapi":"api-reference/openapi.json GET /surveys/{surveyId}/share","href":"/developers/api/reference/get-survey-share"},{"title":"Get the survey draft guide","openapi":"api-reference/openapi.json GET /surveys/capabilities","href":"/developers/api/reference/get-survey-capabilities"},{"title":"Create a survey draft","openapi":"api-reference/openapi.json POST /surveys","href":"/developers/api/reference/create-survey"},{"title":"Get a survey draft","openapi":"api-reference/openapi.json GET /surveys/{surveyId}/draft","href":"/developers/api/reference/get-survey-draft"},{"title":"Edit a survey draft","openapi":"api-reference/openapi.json PATCH /surveys/{surveyId}/draft","href":"/developers/api/reference/edit-survey-draft"},{"title":"Duplicate a survey as a draft","openapi":"api-reference/openapi.json POST /surveys/{surveyId}/duplicate","href":"/developers/api/reference/duplicate-survey"},{"title":"Pause a survey","openapi":"api-reference/openapi.json POST /surveys/{surveyId}/pause","href":"/developers/api/reference/pause-survey"},{"title":"Resume a survey","openapi":"api-reference/openapi.json POST /surveys/{surveyId}/resume","href":"/developers/api/reference/resume-survey"},{"title":"Archive a survey","openapi":"api-reference/openapi.json POST /surveys/{surveyId}/archive","href":"/developers/api/reference/archive-survey"},{"title":"Restore a survey","openapi":"api-reference/openapi.json POST /surveys/{surveyId}/restore","href":"/developers/api/reference/restore-survey"},{"title":"List sites","openapi":"api-reference/openapi.json GET /sites","href":"/developers/api/reference/list-sites"}]},{"group":"Responses","pages":[{"title":"List responses","openapi":"api-reference/openapi.json GET /responses","href":"/developers/api/reference/list-responses"},{"title":"List recent responses","openapi":"api-reference/openapi.json GET /responses/recent","href":"/developers/api/reference/list-recent-responses"},{"title":"Get a response","openapi":"api-reference/openapi.json GET /responses/{responseId}","href":"/developers/api/reference/get-response"},{"title":"Update a response","openapi":"api-reference/openapi.json PATCH /responses/{responseId}","href":"/developers/api/reference/update-response"},{"title":"List the analysis tree","openapi":"api-reference/openapi.json GET /themes","href":"/developers/api/reference/list-themes"},{"title":"List members","openapi":"api-reference/openapi.json GET /members","href":"/developers/api/reference/list-members"},{"title":"Download a respondent's file","openapi":"api-reference/openapi.json GET /responses/{responseId}/attachments/{attachmentId}","href":"/developers/api/reference/get-attachment"}]},{"group":"Notes","pages":[{"title":"List notes","openapi":"api-reference/openapi.json GET /responses/{responseId}/comments","href":"/developers/api/reference/list-comments"},{"title":"Add a note","openapi":"api-reference/openapi.json POST /responses/{responseId}/comments","href":"/developers/api/reference/add-comment"},{"title":"Edit a note","openapi":"api-reference/openapi.json PATCH /responses/{responseId}/comments/{commentId}","href":"/developers/api/reference/edit-comment"},{"title":"Delete a note","openapi":"api-reference/openapi.json DELETE /responses/{responseId}/comments/{commentId}","href":"/developers/api/reference/delete-comment"}]},{"group":"Erasure","pages":[{"title":"Erase a response","openapi":"api-reference/openapi.json DELETE /responses/{responseId}","href":"/developers/api/reference/delete-response"},{"title":"Erase a respondent","openapi":"api-reference/openapi.json POST /responses/erase","href":"/developers/api/reference/erase-respondent"},{"title":"Erase a contact","openapi":"api-reference/openapi.json POST /contacts/{contactId}/erase","href":"/developers/api/reference/erase-contact"},{"title":"Get a job","openapi":"api-reference/openapi.json GET /jobs/{jobId}","href":"/developers/api/reference/get-job"}]},{"group":"Metrics","pages":[{"title":"Get summary metrics","openapi":"api-reference/openapi.json GET /metrics/summary","href":"/developers/api/reference/get-metrics-summary"},{"title":"Get a metric over time","openapi":"api-reference/openapi.json GET /metrics/timeseries","href":"/developers/api/reference/get-metrics-time-series"},{"title":"Get a breakdown","openapi":"api-reference/openapi.json GET /metrics/breakdown","href":"/developers/api/reference/get-metrics-breakdown"},{"title":"Get a survey's results per question","openapi":"api-reference/openapi.json GET /surveys/{surveyId}/results","href":"/developers/api/reference/get-survey-results"}]},{"group":"Exports","pages":[{"title":"Start an export","openapi":"api-reference/openapi.json POST /exports","href":"/developers/api/reference/create-export"},{"title":"Get an export","openapi":"api-reference/openapi.json GET /exports/{exportId}","href":"/developers/api/reference/get-export"},{"title":"Download an export's file","openapi":"api-reference/openapi.json GET /exports/{exportId}/download","href":"/developers/api/reference/download-export"}]},{"group":"Contacts","pages":[{"title":"List contacts","openapi":"api-reference/openapi.json GET /contacts","href":"/developers/api/reference/list-contacts"},{"title":"Get a contact","openapi":"api-reference/openapi.json GET /contacts/{contactId}","href":"/developers/api/reference/get-contact"},{"title":"Create a contact","openapi":"api-reference/openapi.json POST /contacts","href":"/developers/api/reference/create-contact"},{"title":"Update a contact","openapi":"api-reference/openapi.json PATCH /contacts/{contactId}","href":"/developers/api/reference/update-contact"},{"title":"Delete a contact","openapi":"api-reference/openapi.json DELETE /contacts/{contactId}","href":"/developers/api/reference/delete-contact"}]},{"group":"Contact lists","pages":[{"title":"List contact lists","openapi":"api-reference/openapi.json GET /contacts/lists","href":"/developers/api/reference/list-contact-lists"},{"title":"Get a contact list","openapi":"api-reference/openapi.json GET /contacts/lists/{listId}","href":"/developers/api/reference/get-contact-list"},{"title":"Create a contact list","openapi":"api-reference/openapi.json POST /contacts/lists","href":"/developers/api/reference/create-contact-list"},{"title":"Update a contact list","openapi":"api-reference/openapi.json PATCH /contacts/lists/{listId}","href":"/developers/api/reference/update-contact-list"},{"title":"Delete a contact list","openapi":"api-reference/openapi.json DELETE /contacts/lists/{listId}","href":"/developers/api/reference/delete-contact-list"},{"title":"List a list's contacts","openapi":"api-reference/openapi.json GET /contacts/lists/{listId}/members","href":"/developers/api/reference/list-contact-list-members"},{"title":"Add contacts to a list","openapi":"api-reference/openapi.json POST /contacts/lists/{listId}/members","href":"/developers/api/reference/add-contact-list-members"},{"title":"Remove contacts from a list","openapi":"api-reference/openapi.json POST /contacts/lists/{listId}/members/remove","href":"/developers/api/reference/remove-contact-list-members"}]},{"group":"Email sends","pages":[{"title":"List email sends","openapi":"api-reference/openapi.json GET /email/sends","href":"/developers/api/reference/list-email-sends"},{"title":"Get an email send","openapi":"api-reference/openapi.json GET /email/sends/{sendId}","href":"/developers/api/reference/get-email-send"},{"title":"List a send's recipients","openapi":"api-reference/openapi.json GET /email/sends/{sendId}/recipients","href":"/developers/api/reference/list-email-send-recipients"},{"title":"Count a send's recipients","openapi":"api-reference/openapi.json GET /email/sends/{sendId}/recipients/summary","href":"/developers/api/reference/get-email-send-recipient-summary"}]},{"group":"Dashboards","pages":[{"title":"Dashboard draft guide","openapi":"api-reference/openapi.json GET /dashboards/capabilities","href":"/developers/api/reference/get-dashboard-capabilities"},{"title":"List dashboards","openapi":"api-reference/openapi.json GET /dashboards","href":"/developers/api/reference/list-dashboards"},{"title":"Get a dashboard","openapi":"api-reference/openapi.json GET /dashboards/{dashboardId}","href":"/developers/api/reference/get-dashboard"},{"title":"Get a dashboard draft","openapi":"api-reference/openapi.json GET /dashboards/{dashboardId}/draft","href":"/developers/api/reference/get-dashboard-draft"},{"title":"Create a dashboard draft","openapi":"api-reference/openapi.json POST /dashboards","href":"/developers/api/reference/create-dashboard"},{"title":"Edit a dashboard draft","openapi":"api-reference/openapi.json PATCH /dashboards/{dashboardId}/draft","href":"/developers/api/reference/edit-dashboard-draft"}]},{"group":"Workflows","pages":[{"title":"Workflow draft guide","openapi":"api-reference/openapi.json GET /workflows/capabilities","href":"/developers/api/reference/get-workflow-capabilities"},{"title":"List workflows","openapi":"api-reference/openapi.json GET /workflows","description":"The organization's workflows, edited last first unless sorted, each with its status, its runs of the last 7 days and whether the plan stops it. Needs the member's permission to manage workflows.\n\nScopes: workflows:read.","href":"/developers/api/reference/list-workflows"},{"title":"Get a workflow","openapi":"api-reference/openapi.json GET /workflows/{workflowId}","href":"/developers/api/reference/get-workflow"},{"title":"Create a workflow draft","openapi":"api-reference/openapi.json POST /workflows","description":"Creates a workflow switched off from a name and a draft (trigger, steps and wires; a bare trigger when left out). Nothing runs: a person publishes the workflow in Usertick (editorUrl), which also turns it on. The API never publishes, turns on or off, duplicates or deletes a workflow. A step may leave its connection and settings for the person; publishIssues says what is missing. A draft that places no step is arranged as the editor's Tidy up arranges it. The action steps must be ones the plan includes (403 PLN-002-001), within the plan's steps that send to another tool (403 PLN-001-021). Needs the member's permission to manage workflows. A survey the credential can't read is 404 APK-006-005; a plan without workflows is 403 PLN-002-001, and a survey with as many workflows as the plan allows 403 PLN-001-011. Recorded in the audit log as made through the credential. 201 with the workflow and its address in Location.\n\nScopes: workflows:draft, workflows:read.","href":"/developers/api/reference/create-workflow"},{"title":"Edit a workflow draft","openapi":"api-reference/openapi.json PATCH /workflows/{workflowId}/draft","href":"/developers/api/reference/edit-workflow-draft"},{"title":"List a workflow's runs","openapi":"api-reference/openapi.json GET /workflows/{workflowId}/runs","href":"/developers/api/reference/list-workflow-runs"},{"title":"Get a workflow run","openapi":"api-reference/openapi.json GET /workflows/runs/{runId}","href":"/developers/api/reference/get-workflow-run"}]},{"group":"Support tickets","pages":[{"title":"List your support tickets","openapi":"api-reference/openapi.json GET /support/tickets","href":"/developers/api/reference/list-support-tickets"},{"title":"Get a support ticket","openapi":"api-reference/openapi.json GET /support/tickets/{ticketId}","href":"/developers/api/reference/get-support-ticket"},{"title":"Open a support ticket","openapi":"api-reference/openapi.json POST /support/tickets","href":"/developers/api/reference/create-support-ticket"},{"title":"Reply on a support ticket","openapi":"api-reference/openapi.json POST /support/tickets/{ticketId}/messages","href":"/developers/api/reference/reply-support-ticket"}]},{"group":"Webhook subscriptions","pages":[{"title":"List subscriptions","openapi":"api-reference/openapi.json GET /webhooks","href":"/developers/api/reference/list-webhooks"},{"title":"Subscribe a URL","openapi":"api-reference/openapi.json POST /webhooks/subscribe","href":"/developers/api/reference/subscribe-webhook"},{"title":"List workflow Zapier steps","openapi":"api-reference/openapi.json GET /workflows/zapier-steps","href":"/developers/api/reference/list-zapier-steps"},{"title":"Unsubscribe a URL","openapi":"api-reference/openapi.json DELETE /webhooks/{webhookId}","href":"/developers/api/reference/unsubscribe-webhook"},{"title":"List deliveries","openapi":"api-reference/openapi.json GET /webhooks/{webhookId}/deliveries","href":"/developers/api/reference/list-deliveries"},{"title":"Resend a delivery","openapi":"api-reference/openapi.json POST /webhooks/{webhookId}/deliveries/{deliveryId}/resend","href":"/developers/api/reference/resend-delivery"}]},{"group":"Webhook events","pages":[{"title":"response.created","openapi":"api-reference/openapi.json webhook response.created","href":"/developers/api/reference/webhook-response-created"},{"title":"response.analyzed","openapi":"api-reference/openapi.json webhook response.analyzed","href":"/developers/api/reference/webhook-response-analyzed"},{"title":"response.status_changed","openapi":"api-reference/openapi.json webhook response.status_changed","href":"/developers/api/reference/webhook-response-status-changed"},{"title":"response.classification_corrected","openapi":"api-reference/openapi.json webhook response.classification_corrected","href":"/developers/api/reference/webhook-response-classification-corrected"},{"title":"response.urgent","openapi":"api-reference/openapi.json webhook response.urgent","href":"/developers/api/reference/webhook-response-urgent"},{"title":"theme.spiking","openapi":"api-reference/openapi.json webhook theme.spiking","href":"/developers/api/reference/webhook-theme-spiking"}]}]},{"group":"Webhooks","icon":"webhook","root":{"title":"Webhooks","sidebarTitle":"Overview","href":"/developers/webhooks/overview"},"directory":"card","pages":[{"title":"Webhook events","href":"/developers/webhooks/events"},{"title":"Verify signatures","href":"/developers/webhooks/verify"},{"title":"Delivery and retries","href":"/developers/webhooks/delivery"},{"title":"Rotate a secret","href":"/developers/webhooks/rotation"}]},{"group":"MCP","icon":"bot","pages":[{"title":"MCP server","href":"/developers/mcp"}]}]},{"tab":"Changelog","icon":"history","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Get a workflow - Usertick","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}