{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"NeetoDesk Docs","description":"Developer docs for NeetoDesk: the REST API and the CLI.","colors":{"primary":"#10B981","light":"#34D399","dark":"#059669"},"logo":"https://mintcdn.com/neetodesk-apis/fcjWFGChu0_ZhoJ8/assets/logo.svg?fit=max\u0026auto=format\u0026n=fcjWFGChu0_ZhoJ8\u0026q=85\u0026s=314a72c2599a6af037c5b2afffb942c1","favicon":"https://mintcdn.com/neetodesk-apis/t1YrhlPv0gVQ5VAV/assets/favicon.svg?fit=max\u0026auto=format\u0026n=t1YrhlPv0gVQ5VAV\u0026q=85\u0026s=c3ecdef5c4603c7c449f61988b8a9821","api":{"params":{"expanded":"all"},"playground":{"display":"interactive","proxy":true},"examples":{"defaults":"all","languages":["curl","javascript","python"]}},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"https://www.neeto.com/neetodesk/blog","label":"Blog"},{"href":"https://help.neetodesk.com/","label":"Help center"},{"href":"https://neetodesk.com/","label":"NeetoDesk"}]},"footer":{"socials":{"x":"https://x.com/neetohq","linkedin":"https://www.linkedin.com/company/neeto","youtube":"https://www.youtube.com/channel/UCoQ3Kv2JdZ51WZJ3QFFcI9g","slack":"https://neeto.com/community"}},"styling":{"eyebrows":"section","codeblocks":"system","latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"neetodesk-apis","hasAudioNarration":false,"actualSubdomain":"neetodesk-apis","customDomains":["apidocs.neetodesk.com"],"gitSource":{"type":"github","owner":"neetodeskapis","repo":"neeto-desk-api","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae870b972371a1bd633e519","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API","count":52},{"language":"default","tag":"API v1 (deprecated)","count":17},{"language":"default","tag":"CLI","count":16},{"language":"default","tag":"Getting started","count":13},{"language":"default","tag":"Commands","count":9},{"language":"default","tag":"Ticket fields","count":5},{"language":"default","tag":"Reports","count":5},{"language":"default","tag":"Team members","count":5},{"language":"default","tag":"Comments","count":4},{"language":"default","tag":"Tickets","count":4}]},"assistantConfig":{},"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":"llms-txt-v2","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}],"googleFontsInlined":false},"customCss":[{"filePath":"theme.css","content":":root{--primary-green: #0da874;--white: #ffffff;--light-gray: #eeeeee;--dark-gray: #1f2937;--text-white: rgb(255, 255, 255);--text-light: rgb(238, 238, 238)}#navbar-transition,[data-nav=\"true\"]{background-color:var(--primary-green)!important}.nav-logo{filter:brightness(0) invert(1)!important;height:20px!important;width:auto!important;max-width:none!important}[data-nav=\"true\"] a,#navbar-transition a,#navbar a,.navbar-link{color:var(--text-white)!important}[data-nav=\"true\"] a:hover,#navbar-transition a:hover,#navbar a:hover,.navbar-link:hover{color:var(--text-light)!important}#navbar button,#navbar span,#navbar div,#navbar p,#navbar .text-sm,#navbar .text-xs{color:var(--white)!important}#navbar .bg-gray-500,#navbar .bg-gray-400,#navbar .bg-gray-600,#navbar .bg-gray-300{background-color:var(--white)!important}[data-headlessui-state=\"open\"] [id*=\"headlessui-dialog-panel\"]{background-color:var(--white)!important}[data-headlessui-state=\"open\"] [id*=\"headlessui-dialog-panel\"] .navbar-link a,[data-headlessui-state=\"open\"] [id*=\"headlessui-dialog-panel\"] .text-gray-600,[data-headlessui-state=\"open\"] [id*=\"headlessui-dialog-panel\"] .dark\\:text-gray-400{color:var(--dark-gray)!important}[data-headlessui-state=\"open\"] [id*=\"headlessui-dialog-panel\"] .navbar-link a:hover,[data-headlessui-state=\"open\"] [id*=\"headlessui-dialog-panel\"] .hover\\:text-gray-900:hover,[data-headlessui-state=\"open\"] [id*=\"headlessui-dialog-panel\"] .dark\\:hover\\:text-gray-300:hover{color:var(--primary-green)!important}#search-bar-entry button,#search-bar-entry span,#search-bar-entry div,#search-bar-entry p,#search-bar-entry img,#search-bar-entry svg,#search-bar-entry .text-sm,#search-bar-entry .text-xs{color:var(--primary-green)!important}"}],"page":{"pagePath":"cli-reference/overview","slug":"/cli-reference/overview","pageMetadata":{"title":"Commands overview","description":"Every neetodesk command grouped by resource, with links to the full reference.","href":"/cli-reference/overview"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Every neetodesk command grouped by resource, with links to the full reference.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`global-flags`,children:`Global flags`}),`\n`,_jsxs(_components.p,{children:[`These flags work on every command and are left out of the per-command flag tables below. See `,_jsx(_components.a,{href:`/cli/output-formats`,children:`Output formats`}),` for details.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flag`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--json`})}),_jsx(_components.td,{children:`Output as JSON`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--quiet`})}),_jsx(_components.td,{children:`Output raw data only (no envelope)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--toon`})}),_jsx(_components.td,{children:`Output in TOON format (token-optimized for AI agents)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`--subdomain`})}),_jsx(_components.td,{children:`Override saved subdomain`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`attachments`,children:`attachments`}),`\n`,_jsx(_components.p,{children:`Upload files to attach to tickets and comments`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/attachments`,children:_jsx(_components.code,{children:`neetodesk attachments upload`})})}),_jsx(_components.td,{children:`Upload a file and print the signed id that attaches it`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`customers`,children:`customers`}),`\n`,_jsx(_components.p,{children:`Manage customers`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/customers`,children:_jsx(_components.code,{children:`neetodesk customers create`})})}),_jsx(_components.td,{children:`Create a customer`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/customers`,children:_jsx(_components.code,{children:`neetodesk customers list`})})}),_jsx(_components.td,{children:`List customers`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/customers`,children:_jsx(_components.code,{children:`neetodesk customers show`})})}),_jsx(_components.td,{children:`Show a customer`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`doctor`,children:`doctor`}),`\n`,_jsx(_components.p,{children:`Check CLI health and connectivity`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/utility`,children:_jsx(_components.code,{children:`neetodesk doctor`})})}),_jsx(_components.td,{children:`Check CLI health and connectivity`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`fields`,children:`fields`}),`\n`,_jsx(_components.p,{children:`Manage custom ticket fields`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/fields`,children:_jsx(_components.code,{children:`neetodesk fields create`})})}),_jsx(_components.td,{children:`Create a custom ticket field`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/fields`,children:_jsx(_components.code,{children:`neetodesk fields delete`})})}),_jsx(_components.td,{children:`Delete a custom ticket field`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/fields`,children:_jsx(_components.code,{children:`neetodesk fields list`})})}),_jsx(_components.td,{children:`List custom ticket fields`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/fields`,children:_jsx(_components.code,{children:`neetodesk fields show`})})}),_jsx(_components.td,{children:`Show a custom ticket field`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/fields`,children:_jsx(_components.code,{children:`neetodesk fields update`})})}),_jsx(_components.td,{children:`Update a custom ticket field`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`forms`,children:`forms`}),`\n`,_jsx(_components.p,{children:`List contact forms`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/forms`,children:_jsx(_components.code,{children:`neetodesk forms list`})})}),_jsx(_components.td,{children:`List enabled contact forms`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`login`,children:`login`}),`\n`,_jsx(_components.p,{children:`Authenticate to NeetoDesk via browser`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/utility`,children:_jsx(_components.code,{children:`neetodesk login`})})}),_jsx(_components.td,{children:`Authenticate to NeetoDesk via browser`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`logout`,children:`logout`}),`\n`,_jsx(_components.p,{children:`Sign out and clear saved credentials`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/utility`,children:_jsx(_components.code,{children:`neetodesk logout`})})}),_jsx(_components.td,{children:`Sign out and clear saved credentials`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`reports`,children:`reports`}),`\n`,_jsx(_components.p,{children:`View NeetoDesk reports`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/reports`,children:_jsx(_components.code,{children:`neetodesk reports agents`})})}),_jsx(_components.td,{children:`Agent performance report`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/reports`,children:_jsx(_components.code,{children:`neetodesk reports groups`})})}),_jsx(_components.td,{children:`Group performance report`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/reports`,children:_jsx(_components.code,{children:`neetodesk reports surveys`})})}),_jsx(_components.td,{children:`Customer satisfaction surveys report`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/reports`,children:_jsx(_components.code,{children:`neetodesk reports ticket-time-series`})})}),_jsx(_components.td,{children:`Ticket creation and closure time series report`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/reports`,children:_jsx(_components.code,{children:`neetodesk reports tickets`})})}),_jsx(_components.td,{children:`Ticket status change report`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`setup`,children:`setup`}),`\n`,_jsx(_components.p,{children:`Set up NeetoDesk for AI coding assistants`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/utility`,children:_jsx(_components.code,{children:`neetodesk setup claude`})})}),_jsx(_components.td,{children:`Register NeetoDesk plugin with Claude Code`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/utility`,children:_jsx(_components.code,{children:`neetodesk setup codex`})})}),_jsx(_components.td,{children:`Add NeetoDesk instructions for OpenAI Codex`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/utility`,children:_jsx(_components.code,{children:`neetodesk setup copilot`})})}),_jsx(_components.td,{children:`Add NeetoDesk instructions for GitHub Copilot`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/utility`,children:_jsx(_components.code,{children:`neetodesk setup cursor`})})}),_jsx(_components.td,{children:`Write NeetoDesk rules for Cursor IDE`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/utility`,children:_jsx(_components.code,{children:`neetodesk setup gemini`})})}),_jsx(_components.td,{children:`Add NeetoDesk instructions for Gemini CLI`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/utility`,children:_jsx(_components.code,{children:`neetodesk setup windsurf`})})}),_jsx(_components.td,{children:`Write NeetoDesk rules for Windsurf IDE`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`team-members`,children:`team-members`}),`\n`,_jsx(_components.p,{children:`Manage team members (agents)`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/team-members`,children:_jsx(_components.code,{children:`neetodesk team-members create`})})}),_jsx(_components.td,{children:`Invite team members by email`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/team-members`,children:_jsx(_components.code,{children:`neetodesk team-members delete`})})}),_jsx(_components.td,{children:`Remove a team member`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/team-members`,children:_jsx(_components.code,{children:`neetodesk team-members list`})})}),_jsx(_components.td,{children:`List team members`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/team-members`,children:_jsx(_components.code,{children:`neetodesk team-members show`})})}),_jsx(_components.td,{children:`Show a team member`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/team-members`,children:_jsx(_components.code,{children:`neetodesk team-members update`})})}),_jsx(_components.td,{children:`Update a team member`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`tickets`,children:`tickets`}),`\n`,_jsx(_components.p,{children:`Manage tickets`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/tickets`,children:_jsx(_components.code,{children:`neetodesk tickets comments create`})})}),_jsx(_components.td,{children:`Add a comment to a ticket`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/tickets`,children:_jsx(_components.code,{children:`neetodesk tickets comments list`})})}),_jsx(_components.td,{children:`List comments on a ticket`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/tickets`,children:_jsx(_components.code,{children:`neetodesk tickets comments show`})})}),_jsx(_components.td,{children:`Show a comment on a ticket`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/tickets`,children:_jsx(_components.code,{children:`neetodesk tickets create`})})}),_jsx(_components.td,{children:`Create a ticket`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/tickets`,children:_jsx(_components.code,{children:`neetodesk tickets drafts create`})})}),_jsx(_components.td,{children:`Create or upsert a draft on a ticket`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/tickets`,children:_jsx(_components.code,{children:`neetodesk tickets list`})})}),_jsx(_components.td,{children:`List tickets`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/tickets`,children:_jsx(_components.code,{children:`neetodesk tickets show`})})}),_jsx(_components.td,{children:`Show a ticket by number or id`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/tickets`,children:_jsx(_components.code,{children:`neetodesk tickets update`})})}),_jsx(_components.td,{children:`Update a ticket by number or id`})]})]})]}),`\n`,_jsx(Heading,{level:`3`,id:`update`,children:`update`}),`\n`,_jsx(_components.p,{children:`Update the CLI to the latest version`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/utility`,children:_jsx(_components.code,{children:`neetodesk update`})})}),_jsx(_components.td,{children:`Update the CLI to the latest version`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`version`,children:`version`}),`\n`,_jsx(_components.p,{children:`Print the CLI version`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/utility`,children:_jsx(_components.code,{children:`neetodesk version`})})}),_jsx(_components.td,{children:`Print the CLI version`})]})})]}),`\n`,_jsx(Heading,{level:`3`,id:`whoami`,children:`whoami`}),`\n`,_jsx(_components.p,{children:`Show current authenticated user(s)`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Command`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.a,{href:`/cli-reference/utility`,children:_jsx(_components.code,{children:`neetodesk whoami`})})}),_jsx(_components.td,{children:`Show current authenticated user(s)`})]})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Commands overview","description":"Every neetodesk command grouped by resource, with links to the full reference.","href":"/cli-reference/overview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Global flags","slug":"global-flags","depth":2,"children":[{"title":"attachments","slug":"attachments","depth":3,"children":[]},{"title":"customers","slug":"customers","depth":3,"children":[]},{"title":"doctor","slug":"doctor","depth":3,"children":[]},{"title":"fields","slug":"fields","depth":3,"children":[]},{"title":"forms","slug":"forms","depth":3,"children":[]},{"title":"login","slug":"login","depth":3,"children":[]},{"title":"logout","slug":"logout","depth":3,"children":[]},{"title":"reports","slug":"reports","depth":3,"children":[]},{"title":"setup","slug":"setup","depth":3,"children":[]},{"title":"team-members","slug":"team-members","depth":3,"children":[]},{"title":"tickets","slug":"tickets","depth":3,"children":[]},{"title":"update","slug":"update","depth":3,"children":[]},{"title":"version","slug":"version","depth":3,"children":[]},{"title":"whoami","slug":"whoami","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/neetodesk-apis/5f665fb1f1635bc3/os-detect.js"],"subdomain":"neetodesk-apis","siteName":"NeetoDesk Docs","title":"Commands overview - NeetoDesk Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-16T10:34:03.385Z","originalFileLocation":"cli-reference/overview.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Every neetodesk command grouped by resource, with links to the full reference.\">\u003cmeta data-mint-head name=\"application-name\" content=\"NeetoDesk Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/neetodesk-apis/tq8Gmpoy_-dPL6IW/_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/neetodesk-apis/tq8Gmpoy_-dPL6IW/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/neetodesk-apis/tq8Gmpoy_-dPL6IW/_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/neetodesk-apis/tq8Gmpoy_-dPL6IW/_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/neetodesk-apis/tq8Gmpoy_-dPL6IW/_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/neetodesk-apis/tq8Gmpoy_-dPL6IW/_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/neetodesk-apis/tq8Gmpoy_-dPL6IW/_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/neetodesk-apis/tq8Gmpoy_-dPL6IW/_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/neetodesk-apis/tq8Gmpoy_-dPL6IW/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Commands overview - NeetoDesk Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Every neetodesk command grouped by resource, with links to the full reference.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"NeetoDesk Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://apidocs.neetodesk.com/cli-reference/overview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://neetodesk-apis.mintlify.site/_mintlify/api/og/v2?division=Commands\u0026amp;title=Commands+overview\u0026amp;description=Every+neetodesk+command+grouped+by+resource%2C+with+links+to+the+full+reference.\u0026amp;theme=4fc5dc38702463bc51e5de60\u0026amp;signature=2505b3d0cf74269b5a548423aa2a09b3f8c88e8bdbe2d46490372883fac3cafa\">\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=\"Commands overview - NeetoDesk Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Every neetodesk command grouped by resource, with links to the full reference.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://neetodesk-apis.mintlify.site/_mintlify/api/og/v2?division=Commands\u0026amp;title=Commands+overview\u0026amp;description=Every+neetodesk+command+grouped+by+resource%2C+with+links+to+the+full+reference.\u0026amp;theme=4fc5dc38702463bc51e5de60\u0026amp;signature=2505b3d0cf74269b5a548423aa2a09b3f8c88e8bdbe2d46490372883fac3cafa\">\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/neetodesk-apis/tq8Gmpoy_-dPL6IW/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"NeetoDesk Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#10B981\">\u003clink data-mint-head rel=\"canonical\" href=\"https://apidocs.neetodesk.com/cli-reference/overview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/cli-reference/overview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://apidocs.neetodesk.com/#organization\",\"name\":\"NeetoDesk Docs\",\"url\":\"https://apidocs.neetodesk.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/neetodesk-apis/fcjWFGChu0_ZhoJ8/assets/logo.svg?fit=max\u0026auto=format\u0026n=fcjWFGChu0_ZhoJ8\u0026q=85\u0026s=314a72c2599a6af037c5b2afffb942c1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://apidocs.neetodesk.com#website\",\"name\":\"NeetoDesk Docs\",\"url\":\"https://apidocs.neetodesk.com\",\"publisher\":{\"@id\":\"https://apidocs.neetodesk.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://apidocs.neetodesk.com/cli-reference/overview#webpage\",\"url\":\"https://apidocs.neetodesk.com/cli-reference/overview\",\"name\":\"Commands overview\",\"description\":\"Every neetodesk command grouped by resource, with links to the full reference.\",\"dateModified\":\"2026-10-16T10:34:03.385Z\",\"isPartOf\":{\"@id\":\"https://apidocs.neetodesk.com#website\"},\"breadcrumb\":{\"@id\":\"https://apidocs.neetodesk.com/cli-reference/overview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://apidocs.neetodesk.com/cli-reference/overview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"NeetoDesk Docs\",\"item\":\"https://apidocs.neetodesk.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Commands overview\",\"item\":\"https://apidocs.neetodesk.com/cli-reference/overview\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://apidocs.neetodesk.com/cli-reference/overview#article\",\"headline\":\"Commands overview\",\"name\":\"Commands overview\",\"description\":\"Every neetodesk command grouped by resource, with links to the full reference.\",\"url\":\"https://apidocs.neetodesk.com/cli-reference/overview\",\"mainEntityOfPage\":{\"@id\":\"https://apidocs.neetodesk.com/cli-reference/overview#webpage\"},\"dateModified\":\"2026-10-16T10:34:03.385Z\",\"publisher\":{\"@id\":\"https://apidocs.neetodesk.com/#organization\"},\"isPartOf\":{\"@id\":\"https://apidocs.neetodesk.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"NeetoDesk Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"NeetoDesk Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/cli-reference/overview.md","siteName":"NeetoDesk Docs","nav":{"global":null,"tabs":[{"tab":"API","icon":"code","pages":[{"title":"API","href":"/api/introduction"}]},{"tab":"CLI","icon":"rectangle-terminal","groups":[{"group":"Getting started","icon":"rocket","pages":[{"title":"NeetoDesk CLI","href":"/cli/introduction"},{"title":"Installation","href":"/cli/installation"},{"title":"Workspace subdomain","href":"/cli/workspace-subdomain"},{"title":"Authentication","href":"/cli/authentication"},{"title":"Output formats","href":"/cli/output-formats"},{"title":"AI assistants","href":"/cli/ai-assistants"},{"title":"Troubleshooting","description":"Diagnose authentication and connectivity issues with neetodesk doctor.","href":"/cli/troubleshooting"}]},{"group":"Commands","icon":"terminal","pages":[{"title":"Commands overview","href":"/cli-reference/overview"},{"title":"Attachments","description":"Upload a file so a ticket or comment can carry it.","href":"/cli-reference/attachments"},{"title":"Tickets","href":"/cli-reference/tickets"},{"title":"Customers","href":"/cli-reference/customers"},{"title":"Fields","href":"/cli-reference/fields"},{"title":"Forms","href":"/cli-reference/forms"},{"title":"Reports","href":"/cli-reference/reports"},{"title":"Team members","href":"/cli-reference/team-members"},{"title":"Utility commands","href":"/cli-reference/utility"}]}]}]},"basePath":"","title":"Commands overview - NeetoDesk Docs","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":[],"chunks":[]}
