{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Docs","colors":{"primary":"#02A8F3","light":"#02A8F3","dark":"#028FCF"},"favicon":"https://mintcdn.com/mile-app/JbFasViqaZTzE9Zc/favicon.ico?fit=max\u0026auto=format\u0026n=JbFasViqaZTzE9Zc\u0026q=85\u0026s=4e7ddbcee052a480a983e57b5e25103b","api":{"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"}}},"search":{},"seo":{"metatags":{"robots":"noindex, nofollow"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"mile-app","hasAudioNarration":false,"actualSubdomain":"mile-app","customDomains":["docsy3.mile.app"],"gitSource":{"type":"gitlab","owner":"paketid","repo":"mileapp-docs","deployBranch":"whitelabel","contentDirectory":"","isPrivate":true,"projectId":76553900,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6af56e88185706f0def03fc0","clientVersion":"0.0.4128","searchFilterCounts":[{"language":"default","tag":"API Reference","count":374},{"language":"default","tag":"Guides","count":204},{"language":"default","tag":"Workflow","count":142},{"language":"default","tag":"Settings","count":118},{"language":"default","tag":"Planning","count":102},{"language":"default","tag":"Routing","count":89},{"language":"default","tag":"Activities","count":75},{"language":"default","tag":"Task","count":75},{"language":"default","tag":"Flow","count":50},{"language":"default","tag":"Analytics","count":45}]},"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"header>a:first-child img,nav>a:first-child img,a[href=\"/\"]>img,img[src*=\"/logo/\"]{width:150px!important;height:auto!important;max-width:150px!important}"}],"page":{"pagePath":"api-reference/setting/addon/get-add-on-details","slug":"/api-reference/setting/addon/get-add-on-details","pageMetadata":{"title":"Get add-on details","description":"Retrieves detailed information about a specific add-on. Only add-ons belonging to your organization or system add-ons are accessible.","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /addon/{id}","href":"/api-reference/setting/addon/get-add-on-details","autogeneratedByOpenApi":true},"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: \"Retrieves detailed information about a specific add-on. Only add-ons belonging to your organization or system add-ons are accessible.\"\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":{"config":{},"pageMetadata":{"title":"Get add-on details","description":"Retrieves detailed information about a specific add-on. Only add-ons belonging to your organization or system add-ons are accessible.","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /addon/{id}","href":"/api-reference/setting/addon/get-add-on-details","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/mile-app/445bf38d440c2c31/scripts/build-openapi.js","/_mintlify/custom/mile-app/bbd4ec23fcfb0c2b/scripts/check-schema.js","/_mintlify/custom/mile-app/4154158bbff482b1/scripts/generate-tag-overviews.js"],"openApiReferenceData":{"operation":{"summary":"Get add-on details","description":"Retrieves detailed information about a specific add-on. Only add-ons belonging to your organization or system add-ons are accessible.","tags":["Addon"],"operationId":"getAddon","deprecated":false,"parameters":["ea5b2978-6205-4757-9b93-accc68955cec"],"responses":{"200":"a10c3e76-3102-4d24-8ed1-3ab20aa9d9ff","401":"8374bc85-cddd-43c6-b28a-e7c0bd292b80","403":"25e3bcb9-fa40-4b50-85e7-34e37e1a279d","404":"b44f8d05-a6c5-468d-8e5c-77c6cab83b3c","429":"dd8271c6-8f10-4246-9b66-cc0e058b4796"},"security":["6b4d8594-8ad1-4c66-8f50-73d37554e035"],"method":"get","type":"path","servers":["bbd2f0c4-c379-4c4a-98ae-4561a297cfcd"],"path":"/addon/{id}","baseUrlOptions":["https://apiweb.mile.app/api/v3"],"title":"Get add-on details","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ea5b2978-6205-4757-9b93-accc68955cec":{"name":"id","in":"path","required":true,"description":"Add-on ID (MongoDB ObjectId)","schema":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","isRequired":true,"description":"Add-on ID (MongoDB ObjectId)","uniqueKey":"","typeLabel":"string"}}},"responses":{"a10c3e76-3102-4d24-8ed1-3ab20aa9d9ff":{"description":"Add-on details retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"Operation success status","example":true,"isRequired":true,"uniqueKey":"status","typeLabel":"boolean"},"message":{"type":"string","description":"Success message","example":"Success.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"id":{"type":"string","description":"Unique add-on identifier (MongoDB ObjectId). **Example**: `68b440c9dad4c5d45707f6d2`","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"name":{"type":"string","description":"Add-on display name (3-100 characters). **Example**: `Custom Dashboard Widget`","isRequired":true,"uniqueKey":"data.name","typeLabel":"string"},"description":{"type":"string","isRequired":true,"uniqueKey":"data.description","typeLabel":"string"},"resourceFile":{"type":"string","description":"Original filename of the JavaScript resource. **Example**: `1756656087_Custom-Dashboard-Widget.js`","isRequired":true,"uniqueKey":"data.resourceFile","typeLabel":"string"},"organizationId":{"type":"string","description":"Organization identifier. 'system' for global add-ons, organization ID for custom add-ons. **Example**: `686cc0ff083ca8093204f002` or `system`","isRequired":true,"uniqueKey":"data.organizationId","typeLabel":"string"},"resourceUrl":{"type":"string","description":"Full URL where the JavaScript resource is hosted. **Example**: `https://cdn.mile.app/plugins/2025/08/31/686cc0ff083ca8093204f002/1756656087_Custom-Dashboard-Widget.js`","isRequired":true,"uniqueKey":"data.resourceUrl","typeLabel":"string"},"createdBy":{"type":"string","description":"Email address of the user who created the add-on. **Example**: `[email protected]`","isRequired":true,"uniqueKey":"data.createdBy","typeLabel":"string"},"createdTime":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the add-on was created. **Format**: `YYYY-MM-DDTHH:mm:ss.ffffffZ`. **Example**: `2025-08-31T10:30:00.000000Z`","isRequired":true,"uniqueKey":"data.createdTime","typeLabel":"string\u003cdate-time>"},"updatedTime":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the add-on was last updated. **Format**: `YYYY-MM-DDTHH:mm:ss.ffffffZ`. **Example**: `2025-08-31T10:35:00.000000Z`","isRequired":true,"uniqueKey":"data.updatedTime","typeLabel":"string\u003cdate-time>"},"organizationName":{"type":"string","description":"Organization display name. 'Global' for system add-ons, actual organization name for custom add-ons. **Example**: `Acme Logistics` or `Global`","isRequired":true,"uniqueKey":"data.organizationName","typeLabel":"string"},"isUsed":{"type":"boolean","description":"Indicates if the add-on is currently active/installed in your organization. **Example**: `false`","isRequired":true,"uniqueKey":"data.isUsed","typeLabel":"boolean"},"icon":{"oneOf":[{"type":"string","description":"Full URL to the add-on icon (if available). **Example**: `https://cdn.mile.app/plugins/icons/1756656087_dashboard-widget.svg`","uniqueKey":"data.icon.oneOf.0","typeLabel":"string"},{"type":"null","description":"Full URL to the add-on icon (if available). **Example**: `https://cdn.mile.app/plugins/icons/1756656087_dashboard-widget.svg`","uniqueKey":"data.icon.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.icon","typeLabel":"string | null"},"updatedBy":{"oneOf":[{"type":"string","description":"Email address of the user who last updated the add-on. May be null if never updated. **Example**: `[email protected]`","uniqueKey":"data.updatedBy.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email address of the user who last updated the add-on. May be null if never updated. **Example**: `[email protected]`","uniqueKey":"data.updatedBy.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.updatedBy","typeLabel":"string | null"},"isPublished":{"type":"boolean","description":"Whether the add-on is published and visible to client users. Only applicable to system (global) add-ons.","example":true,"uniqueKey":"data.isPublished","typeLabel":"boolean"},"customModuleId":{"oneOf":[{"type":"string","description":"ID of associated custom module or null if standalone. **Example**: `null` or `62846484ed5be87b6f4358f3`","uniqueKey":"data.customModuleId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of associated custom module or null if standalone. **Example**: `null` or `62846484ed5be87b6f4358f3`","uniqueKey":"data.customModuleId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.customModuleId","typeLabel":"string | null"}},"required":["id","name","description","resourceFile","organizationId","resourceUrl","createdBy","createdTime","updatedTime","organizationName","isUsed"],"example":{"id":"68b440c9dad4c5d45707f6d2","name":"Custom Dashboard Widget","description":"A custom widget for displaying real-time analytics data","resourceFile":"1756656087_Custom-Dashboard-Widget.js","icon":"https://cdn.mile.app/plugins/icons/1756656087_dashboard-widget.svg","organizationId":"686cc0ff083ca8093204f002","resourceUrl":"https://cdn.mile.app/plugins/2025/08/31/686cc0ff083ca8093204f002/1756656087_Custom-Dashboard-Widget.js","createdBy":"[email protected]","updatedBy":"[email protected]","createdTime":"2025-08-31T10:30:00.000000Z","updatedTime":"2025-08-31T10:35:00.000000Z","organizationName":"Acme Logistics","isUsed":false,"isPublished":true,"customModuleId":null,"status":"active"},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["status","message","data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":true,"message":"Success.","data":{"id":"68b440c9dad4c5d45707f6d2","name":"Custom Dashboard Widget","description":"A custom widget for displaying real-time analytics data","resourceFile":"1756656087_Custom-Dashboard-Widget.js","icon":"https://cdn.mile.app/plugins/icons/1756656087_dashboard-widget.svg","organizationId":"686cc0ff083ca8093204f002","resourceUrl":"https://cdn.mile.app/plugins/2025/08/31/686cc0ff083ca8093204f002/1756656087_Custom-Dashboard-Widget.js","createdBy":"[email protected]","updatedBy":"[email protected]","createdTime":"2025-08-31T10:30:00.000000Z","updatedTime":"2025-08-31T10:35:00.000000Z","organizationName":"Acme Logistics","isUsed":false,"isPublished":true,"customModuleId":null,"status":"active"}}}},"exampleType":"generated"}},"exampleType":"generated"},"8374bc85-cddd-43c6-b28a-e7c0bd292b80":{"description":"Unauthorized - Invalid or missing access token","content":{"application/json":{"schema":{"title":"ErrorResponse","type":"object","description":"Standard error response structure","properties":{"status":{"type":"boolean","description":"Always false for error responses","isRequired":true,"uniqueKey":"status","typeLabel":"boolean"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"failedCode":{"type":"string","description":"Error code for debugging and error tracking","uniqueKey":"failedCode","typeLabel":"string"}},"required":["status","message"],"uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"status":true,"message":"\u003cstring>","failedCode":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"25e3bcb9-fa40-4b50-85e7-34e37e1a279d":{"description":"Forbidden - Add-on not accessible to your organization","content":{"application/json":{"schema":{"title":"ErrorResponse","type":"object","description":"Standard error response structure","properties":{"status":{"type":"boolean","description":"Always false for error responses","isRequired":true,"uniqueKey":"status","typeLabel":"boolean"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"failedCode":{"type":"string","description":"Error code for debugging and error tracking","uniqueKey":"failedCode","typeLabel":"string"}},"required":["status","message"],"uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"status":true,"message":"\u003cstring>","failedCode":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"b44f8d05-a6c5-468d-8e5c-77c6cab83b3c":{"description":"Not Found - Add-on not found or not accessible","content":{"application/json":{"schema":{"title":"ErrorResponse","type":"object","description":"Standard error response structure","properties":{"status":{"type":"boolean","description":"Always false for error responses","isRequired":true,"uniqueKey":"status","typeLabel":"boolean"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"failedCode":{"type":"string","description":"Error code for debugging and error tracking","uniqueKey":"failedCode","typeLabel":"string"}},"required":["status","message"],"uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"status":true,"message":"\u003cstring>","failedCode":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"dd8271c6-8f10-4246-9b66-cc0e058b4796":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"title":"ErrorResponse","type":"object","description":"Standard error response structure","properties":{"status":{"type":"boolean","description":"Always false for error responses","isRequired":true,"uniqueKey":"status","typeLabel":"boolean"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"failedCode":{"type":"string","description":"Error code for debugging and error tracking","uniqueKey":"failedCode","typeLabel":"string"}},"required":["status","message"],"uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"status":true,"message":"\u003cstring>","failedCode":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"6b4d8594-8ad1-4c66-8f50-73d37554e035":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a valid Bearer token to authenticate.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"bbd2f0c4-c379-4c4a-98ae-4561a297cfcd":{"url":"https://apiweb.mile.app/api/v3"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Use a valid Bearer token to authenticate.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use a valid Bearer token to authenticate.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/public/openapi-setting.json"},"subdomain":"mile-app","siteName":"Docs","title":"Get add-on details - Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-12T07:46:03.077Z","originalFileLocation":"api-reference/setting/addon/get-add-on-details.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=\"Retrieves detailed information about a specific add-on. Only add-ons belonging to your organization or system add-ons are accessible.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex, nofollow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_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/mile-app/Twtpt2Bih2o8988O/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/mile-app/Twtpt2Bih2o8988O/_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/mile-app/Twtpt2Bih2o8988O/_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/mile-app/Twtpt2Bih2o8988O/_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/mile-app/Twtpt2Bih2o8988O/_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/mile-app/Twtpt2Bih2o8988O/_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/mile-app/Twtpt2Bih2o8988O/_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/mile-app/Twtpt2Bih2o8988O/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get add-on details - Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves detailed information about a specific add-on. Only add-ons belonging to your organization or system add-ons are accessible.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docsy3.mile.app/api-reference/setting/addon/get-add-on-details\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://mile-app.mintlify.site/_mintlify/api/og/v2?division=Add-ons\u0026amp;title=Get+add-on+details\u0026amp;description=Retrieves+detailed+information+about+a+specific+add-on.+Only+add-ons+belonging+to+your+organization+or+system+add-ons+are+accessible.\u0026amp;theme=e5f54c239a4cb7a66a297b96\u0026amp;signature=82d27d8a9b0ec34df4ed21db751e06d673f778f23337b96bad41e4c26df78428\">\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 add-on details - Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves detailed information about a specific add-on. Only add-ons belonging to your organization or system add-ons are accessible.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://mile-app.mintlify.site/_mintlify/api/og/v2?division=Add-ons\u0026amp;title=Get+add-on+details\u0026amp;description=Retrieves+detailed+information+about+a+specific+add-on.+Only+add-ons+belonging+to+your+organization+or+system+add-ons+are+accessible.\u0026amp;theme=e5f54c239a4cb7a66a297b96\u0026amp;signature=82d27d8a9b0ec34df4ed21db751e06d673f778f23337b96bad41e4c26df78428\">\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/mile-app/Twtpt2Bih2o8988O/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#02A8F3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docsy3.mile.app/api-reference/setting/addon/get-add-on-details\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/setting/addon/get-add-on-details.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docsy3.mile.app/#organization\",\"name\":\"Docs\",\"url\":\"https://docsy3.mile.app\"},{\"@type\":\"WebSite\",\"@id\":\"https://docsy3.mile.app#website\",\"name\":\"Docs\",\"url\":\"https://docsy3.mile.app\",\"publisher\":{\"@id\":\"https://docsy3.mile.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docsy3.mile.app/api-reference/setting/addon/get-add-on-details#webpage\",\"url\":\"https://docsy3.mile.app/api-reference/setting/addon/get-add-on-details\",\"name\":\"Get add-on details\",\"description\":\"Retrieves detailed information about a specific add-on. Only add-ons belonging to your organization or system add-ons are accessible.\",\"dateModified\":\"2026-11-12T07:46:03.077Z\",\"isPartOf\":{\"@id\":\"https://docsy3.mile.app#website\"},\"breadcrumb\":{\"@id\":\"https://docsy3.mile.app/api-reference/setting/addon/get-add-on-details#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docsy3.mile.app/api-reference/setting/addon/get-add-on-details#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Settings\",\"item\":\"https://docsy3.mile.app/api-reference/setting/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Extensions\",\"item\":\"https://docsy3.mile.app/api-reference/setting/addon-overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Add-ons\",\"item\":\"https://docsy3.mile.app/api-reference/setting/addon-overview\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Get add-on details\",\"item\":\"https://docsy3.mile.app/api-reference/setting/addon/get-add-on-details\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docsy3.mile.app/api-reference/setting/addon/get-add-on-details#apireference\",\"headline\":\"Get add-on details\",\"name\":\"Get add-on details\",\"description\":\"Retrieves detailed information about a specific add-on. Only add-ons belonging to your organization or system add-ons are accessible.\",\"url\":\"https://docsy3.mile.app/api-reference/setting/addon/get-add-on-details\",\"mainEntityOfPage\":{\"@id\":\"https://docsy3.mile.app/api-reference/setting/addon/get-add-on-details#webpage\"},\"dateModified\":\"2026-11-12T07:46:03.077Z\",\"publisher\":{\"@id\":\"https://docsy3.mile.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docsy3.mile.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/setting/addon/get-add-on-details.md","siteName":"Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/pages/getting-started/introduction"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Data Formats","href":"/api-reference/data-formats"},{"title":"Status Codes","href":"/api-reference/status-codes"}]},{"group":"Analytics","pages":[{"group":"Dashboard","pages":[{"title":"Dashboard","href":"/api-reference/analytics/dashboard-overview"},{"title":"Read dashboards","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /dynamic-dashboards","href":"/api-reference/analytics/dashboard/read-dashboards"},{"title":"Create dashboard","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /dynamic-dashboard","href":"/api-reference/analytics/dashboard/create-dashboard"},{"title":"Read dashboard by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /dynamic-dashboard/{id}","href":"/api-reference/analytics/dashboard/read-dashboard-by-id"},{"title":"Update partially dashboard by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json patch /dynamic-dashboard/{id}","href":"/api-reference/analytics/dashboard/update-partially-dashboard-by-id"},{"title":"Delete dashboard by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json delete /dynamic-dashboard/{id}","href":"/api-reference/analytics/dashboard/delete-dashboard-by-id"},{"title":"Duplicate dashboard by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /dynamic-dashboard/{id}/duplicate","href":"/api-reference/analytics/dashboard/duplicate-dashboard-by-id"},{"title":"Save dashboard as template","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /dynamic-dashboard/{id}/save-as-template","href":"/api-reference/analytics/dashboard/save-dashboard-as-template"},{"title":"Read dashboard templates","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /dynamic-dashboard-templates","href":"/api-reference/analytics/dashboard/read-dashboard-templates"},{"title":"Delete dashboard template by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json delete /dynamic-dashboard-template/{id}","href":"/api-reference/analytics/dashboard/delete-dashboard-template-by-id"},{"title":"Read widgets","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /dynamic-dashboard-widgets","href":"/api-reference/analytics/dashboard/read-widgets"},{"title":"Create custom widget","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /dynamic-dashboard-widget","href":"/api-reference/analytics/dashboard/create-custom-widget"},{"title":"Update partially custom widget by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json patch /dynamic-dashboard-widget/{id}","href":"/api-reference/analytics/dashboard/update-partially-custom-widget-by-id"},{"title":"Delete custom widget by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json delete /dynamic-dashboard-widget/{id}","href":"/api-reference/analytics/dashboard/delete-custom-widget-by-id"},{"title":"Run analytics query","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /analytics/query","href":"/api-reference/analytics/dashboard/run-analytics-query"},{"title":"Read analytics catalog","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /analytics/catalog","href":"/api-reference/analytics/dashboard/read-analytics-catalog"},{"title":"Read analytics field metadata","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /analytics/field-metadata","href":"/api-reference/analytics/dashboard/read-analytics-field-metadata"},{"title":"Get sample rows","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /analytics/preview","href":"/api-reference/analytics/dashboard/get-sample-rows"},{"title":"Save card as widget template","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /dynamic-dashboard/{id}/card/{cardId}/save-as-widget-template","href":"/api-reference/analytics/dashboard/save-card-as-widget-template"}]},{"group":"Report","pages":[{"title":"Report","href":"/api-reference/analytics/report-overview"},{"title":"Read reports","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /reports","href":"/api-reference/analytics/report/read-reports"},{"title":"Create report","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /report","href":"/api-reference/analytics/report/create-report"},{"title":"Read report by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /report/{id}","href":"/api-reference/analytics/report/read-report-by-id"},{"title":"Update report","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json patch /report/{id}","href":"/api-reference/analytics/report/update-report"},{"title":"Delete report","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json delete /report/{id}","href":"/api-reference/analytics/report/delete-report"}]},{"group":"Insight","pages":[{"title":"Insight","href":"/api-reference/analytics/insight-report-overview"},{"title":"Read insight context","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /ai-insight/context/{objectId}","href":"/api-reference/analytics/insight-report/read-insight-context"},{"title":"Update insight context","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json put /ai-insight/context/{objectId}","href":"/api-reference/analytics/insight-report/update-insight-context"},{"title":"Regenerate insight context","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /ai-insight/context/{objectId}/regenerate","href":"/api-reference/analytics/insight-report/regenerate-insight-context"},{"title":"Generate insight report","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /ai-insight/generate","href":"/api-reference/analytics/insight-report/generate-insight-report"},{"title":"Read insight reports","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /ai-insight/results","href":"/api-reference/analytics/insight-report/read-insight-reports"},{"title":"Read insight report by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json get /ai-insight/results/{id}","href":"/api-reference/analytics/insight-report/read-insight-report-by-id"},{"title":"Delete insight report","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json delete /ai-insight/results/{id}","href":"/api-reference/analytics/insight-report/delete-insight-report"},{"title":"Retry insight report","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-analytics.json post /ai-insight/results/{id}/retry","href":"/api-reference/analytics/insight-report/retry-insight-report"}]}]},{"group":"Planning","pages":[{"group":"Routing","pages":[{"group":"Routing","pages":[{"title":"Routing","href":"/api-reference/routing/overview"},{"title":"Read routing results","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /results","href":"/api-reference/routing/routing/read-routing-results"},{"title":"Read routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /result/{resultId}","href":"/api-reference/routing/routing/read-routing-result-by-id"},{"title":"Update routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /result/{resultId}","href":"/api-reference/routing/routing/update-routing-result-by-id"},{"title":"Update partially routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json patch /result/{resultId}","href":"/api-reference/routing/routing/update-partially-routing-result-by-id"},{"title":"Delete routing result by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /result/{resultId}","href":"/api-reference/routing/routing/delete-routing-result-by-id"},{"title":"Route optimize","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /routing","href":"/api-reference/routing/routing/route-optimize"},{"title":"Dispatch routing result","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /dispatch","href":"/api-reference/routing/routing/dispatch-routing-result"},{"title":"Reorder visits","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /reorder-visits","href":"/api-reference/routing/routing/reorder-visits"},{"title":"Read routing result history by result ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /result/{resultId}/history","href":"/api-reference/routing/routing/read-routing-result-history-by-result-id"},{"title":"Switch visits between vehicles","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /result/switch-visit","href":"/api-reference/routing/routing/switch-visits-between-vehicles"},{"title":"Restore routing result version","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /result/{resultId}/restore/{version}","href":"/api-reference/routing/routing/restore-routing-result-version"},{"title":"Reset routing result","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /result/{resultId}/reset","href":"/api-reference/routing/routing/reset-routing-result"},{"title":"Read dispatch of a routing result","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /dispatch/{resultId}","href":"/api-reference/routing/routing/read-dispatch-of-a-routing-result"},{"title":"Delete dispatch of a routing result","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /dispatch/{resultId}","href":"/api-reference/routing/routing/delete-dispatch-of-a-routing-result"}]},{"group":"Vehicle","pages":[{"title":"Vehicle","href":"/api-reference/routing/vehicle-overview"},{"title":"Read vehicle","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /vehicles","href":"/api-reference/routing/vehicle/read-vehicle"},{"title":"Read vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/read-vehicle-by-id"},{"title":"Update vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/update-vehicle-by-id"},{"title":"Update partially vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json patch /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/update-partially-vehicle-by-id"},{"title":"Delete vehicle by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /vehicle/{vehicleId}","href":"/api-reference/routing/vehicle/delete-vehicle-by-id"},{"title":"Create vehicle","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /vehicle","href":"/api-reference/routing/vehicle/create-vehicle"},{"title":"Bulk create vehicle","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /vehicles/","href":"/api-reference/routing/vehicle/bulk-create-vehicle"},{"title":"Delete vehicle by Hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /vehicles/{hubId}/hub","href":"/api-reference/routing/vehicle/delete-vehicle-by-hub"}]},{"group":"Vehicle Maintenance","pages":[{"title":"Vehicle Maintenance","href":"/api-reference/routing/vehicle-maintenance-overview"},{"title":"Read vehicle maintenance schedules","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-routing.json get /vehicle-maintenances","href":"/api-reference/routing/vehicle-maintenance/read-vehicle-maintenance-schedules"},{"title":"Save vehicle maintenance schedules","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-routing.json post /vehicle-maintenances","href":"/api-reference/routing/vehicle-maintenance/save-vehicle-maintenance-schedules"},{"title":"Delete vehicle maintenance schedule by ID","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /vehicle-maintenance/{id}","href":"/api-reference/routing/vehicle-maintenance/delete-vehicle-maintenance-schedule-by-id"}]},{"group":"Configuration","pages":[{"title":"Configuration","href":"/api-reference/routing/configuration-overview"},{"title":"Read routing configurations","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /configurations","href":"/api-reference/routing/configuration/read-routing-configurations"},{"title":"Create routing configuration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /configuration","href":"/api-reference/routing/configuration/create-routing-configuration"},{"title":"Read routing configuration by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /configuration/{configurationId}","href":"/api-reference/routing/configuration/read-routing-configuration-by-id"},{"title":"Update routing configuration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /configuration/{configurationId}","href":"/api-reference/routing/configuration/update-routing-configuration"},{"title":"Delete routing configuration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /configuration/{configurationId}","href":"/api-reference/routing/configuration/delete-routing-configuration"},{"title":"Read default routing configuration of a hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /configuration/hub/{hubId}","href":"/api-reference/routing/configuration/read-default-routing-configuration-of-a-hub"},{"title":"Update routing configurations of a hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json patch /configurations/hub/{hubId}","href":"/api-reference/routing/configuration/update-routing-configurations-of-a-hub"},{"title":"Read capacity constraints","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /capacity-constraints","href":"/api-reference/routing/capacity-constraint/read-capacity-constraints"},{"title":"Read capacity constraint","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /capacity-constraint","href":"/api-reference/routing/capacity-constraint/read-capacity-constraint"},{"title":"Create capacity constraint","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /capacity-constraint","href":"/api-reference/routing/capacity-constraint/create-capacity-constraint"},{"title":"Read capacity constraint by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /capacity-constraint/{capacityConstraintId}","href":"/api-reference/routing/capacity-constraint/read-capacity-constraint-by-id"},{"title":"Update capacity constraint","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /capacity-constraint/{capacityConstraintId}","href":"/api-reference/routing/capacity-constraint/update-capacity-constraint"},{"title":"Delete capacity constraint","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /capacity-constraint/{capacityConstraintId}","href":"/api-reference/routing/capacity-constraint/delete-capacity-constraint"},{"title":"Read capacity constraint of a hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /capacity-constraint/hub/{hubId}","href":"/api-reference/routing/capacity-constraint/read-capacity-constraint-of-a-hub"},{"title":"Read geotagging zones","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /geotagging","href":"/api-reference/routing/geotagging/read-geotagging-zones"},{"title":"Create geotagging zone","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /geotagging","href":"/api-reference/routing/geotagging/create-geotagging-zone"},{"title":"Update geotagging zone","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json patch /geotagging/{geotaggingId}","href":"/api-reference/routing/geotagging/update-geotagging-zone"},{"title":"Delete geotagging zone","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /geotagging/{geotaggingId}","href":"/api-reference/routing/geotagging/delete-geotagging-zone"}]}]},{"group":"Schedule","pages":[{"group":"Task Schedule","pages":[{"title":"Task Schedule","href":"/api-reference/task/task-schedule-overview"},{"title":"Read task schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/schedules","href":"/api-reference/task/task-schedule/read-task-schedule"},{"title":"Read task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/schedule/{id}","href":"/api-reference/task/task-schedule/read-task-schedule-by-id"},{"title":"Create task schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/schedule","href":"/api-reference/task/task-schedule/create-task-schedule"},{"title":"Bulk create task schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/schedules/bulk","href":"/api-reference/task/task-schedule/bulk-create-task-schedule"},{"title":"Update task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/schedule/{scheduleId}","href":"/api-reference/task/task-schedule/update-task-schedule-by-id"},{"title":"Update partially task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /task/schedule/{scheduleId}","href":"/api-reference/task/task-schedule/update-partially-task-schedule-by-id"},{"title":"Delete task schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /task/schedule/{scheduleId}","href":"/api-reference/task/task-schedule/delete-task-schedule-by-id"}]},{"group":"Routing Schedule","pages":[{"title":"Routing Schedule","href":"/api-reference/routing/routing-schedule-overview"},{"title":"Create routing schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json post /routing/schedule","href":"/api-reference/routing/routing-schedule/create-routing-schedule"},{"title":"Read routing schedule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /routing/schedules","href":"/api-reference/routing/routing-schedule/read-routing-schedule"},{"title":"Read routing schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json get /routing/schedule/{scheduleId}","href":"/api-reference/routing/routing-schedule/read-routing-schedule-by-id"},{"title":"Update routing schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json put /routing/schedule/{scheduleId}","href":"/api-reference/routing/routing-schedule/update-routing-schedule-by-id"},{"title":"Update partially routing schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json patch /routing/schedule/{scheduleId}","href":"/api-reference/routing/routing-schedule/update-partially-routing-schedule-by-id"},{"title":"Delete routing schedule by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-routing.json delete /routing/schedule/{scheduleId}","href":"/api-reference/routing/routing-schedule/delete-routing-schedule-by-id"}]}]}]},{"group":"Monitoring","pages":[{"group":"Alert","pages":[{"title":"Alert","href":"/api-reference/monitoring/overview"},{"title":"Read alerts","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json get /alerts","href":"/api-reference/monitoring/alert/read-alerts"},{"title":"Read alert summary","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json get /alerts/summary","href":"/api-reference/monitoring/alert/read-alert-summary"},{"title":"Resolve alert","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json post /alert/{id}/resolve","href":"/api-reference/monitoring/alert/resolve-alert"},{"title":"Unresolve alert","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json delete /alert/{id}/resolve","href":"/api-reference/monitoring/alert/unresolve-alert"}]}]},{"group":"Activities","pages":[{"group":"Task","pages":[{"group":"Task","pages":[{"title":"Task","href":"/api-reference/task/overview"},{"title":"Send OTP","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/{taskId}/otp/send","href":"/api-reference/task/task/send-otp"},{"title":"Verify OTP","deprecated":null,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/{taskId}/otp/verify","href":"/api-reference/task/task/verify-otp"},{"title":"Read tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /tasks","href":"/api-reference/task/task/read-tasks"},{"title":"Read tasks gallery","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /tasks-gallery","href":"/api-reference/task/task/read-tasks-gallery"},{"title":"Read task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/{task_id}","href":"/api-reference/task/task/read-task-by-id"},{"title":"Read public task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /task/public/{task_id}","href":"/api-reference/task/task/read-public-task-by-id"},{"title":"Read task tracking","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /tasks/tracking","href":"/api-reference/task/task/read-task-tracking"},{"title":"Create task","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task","href":"/api-reference/task/task/create-task"},{"title":"Create multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /tasks/bulk/","href":"/api-reference/task/task/create-multiple-tasks"},{"title":"Upload image for task","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/photo/{forRenameFile}","href":"/api-reference/task/task/upload-image-for-task"},{"title":"Upload video for task","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/video/{forRenameFile}","href":"/api-reference/task/task/upload-video-for-task"},{"title":"Update task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/{taskid}","href":"/api-reference/task/task/update-task-by-id"},{"title":"Move task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/{taskId}/move","href":"/api-reference/task/task/move-task-by-id"},{"title":"Assign task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /task/{taskId}/assign","href":"/api-reference/task/task/assign-task-by-id"},{"title":"Move multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /tasks/bulk/move","href":"/api-reference/task/task/move-multiple-tasks"},{"title":"Assign multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /tasks/bulk/assign","href":"/api-reference/task/task/assign-multiple-tasks"},{"title":"Partially update task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /task/{taskId}","href":"/api-reference/task/task/partially-update-task-by-id"},{"title":"Partial update multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /tasks/bulk","href":"/api-reference/task/task/partial-update-multiple-tasks"},{"title":"Delete multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /tasks/bulk","href":"/api-reference/task/task/delete-multiple-tasks"},{"title":"Update multiple tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /tasks/bulk","href":"/api-reference/task/task/update-multiple-tasks"},{"title":"Delete task by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /task/{id}","href":"/api-reference/task/task/delete-task-by-id"},{"title":"Upload task photo","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/photo","href":"/api-reference/task/task/upload-task-photo"},{"title":"Upload task photo with file name","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/photo/{fileName}","href":"/api-reference/task/task/upload-task-photo-with-file-name"},{"title":"Upload task video","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/video","href":"/api-reference/task/task/upload-task-video"},{"title":"Upload task video with file name","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /task/video/{fileName}","href":"/api-reference/task/task/upload-task-video-with-file-name"}]},{"group":"Location History","pages":[{"title":"Location History","href":"/api-reference/task/location-history-overview"},{"title":"Read location history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /location-histories","href":"/api-reference/task/location-history/read-location-history"},{"title":"Read location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /location-history/{id}","href":"/api-reference/task/location-history/read-location-history-by-id"},{"title":"Read location history by token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json get /location-history/tracking/{token}","href":"/api-reference/task/location-history/read-location-history-by-token"},{"title":"Create location history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /location-history","href":"/api-reference/task/location-history/create-location-history"},{"title":"Bulk create location history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /location-history/bulk","href":"/api-reference/task/location-history/bulk-create-location-history"},{"title":"Generate location history token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json post /location-history/generate-token","href":"/api-reference/task/location-history/generate-location-history-token"},{"title":"Update location history by email \u0026 createdTime","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /location-history/","href":"/api-reference/task/location-history/update-location-history-by-email-\u0026-createdtime"},{"title":"Update location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json put /location-history/{loc_history_id}","href":"/api-reference/task/location-history/update-location-history-by-id"},{"title":"Update partially location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json patch /location-history/{loc_history_id}","href":"/api-reference/task/location-history/update-partially-location-history-by-id"},{"title":"Delete location history by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-task.json delete /location-history/{loc_history_id}","href":"/api-reference/task/location-history/delete-location-history-by-id"}]}]},{"group":"Order","pages":[{"title":"Order","href":"/api-reference/order/overview"},{"title":"Read orders","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json get /orders","href":"/api-reference/order/order/read-orders"},{"title":"Create order","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json post /order","href":"/api-reference/order/order/create-order"},{"title":"Read order by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json get /order/{id}","href":"/api-reference/order/order/read-order-by-id"},{"title":"Update order","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json put /order/{id}","href":"/api-reference/order/order/update-order"},{"title":"Delete order","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json delete /order/{id}","href":"/api-reference/order/order/delete-order"},{"title":"Cancel order","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json put /order/{id}/cancel","href":"/api-reference/order/order/cancel-order"},{"title":"Change order status","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json put /order/{id}/status","href":"/api-reference/order/order/change-order-status"},{"title":"Read order history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json get /order/{id}/history","href":"/api-reference/order/order/read-order-history"},{"title":"Read order step log","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json get /order/{id}/step-log","href":"/api-reference/order/order/read-order-step-log"},{"title":"Resolve order attention","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json post /order/{id}/attention/resolve","href":"/api-reference/order/order/resolve-order-attention"},{"title":"Retry order attention","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json post /order/{id}/attention/retry","href":"/api-reference/order/order/retry-order-attention"},{"title":"Create orders in bulk","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json post /orders/bulk","href":"/api-reference/order/order/create-orders-in-bulk"},{"title":"Export orders","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json post /orders/export","href":"/api-reference/order/order/export-orders"},{"title":"Read order export","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json get /orders/export/{exportId}","href":"/api-reference/order/order/read-order-export"},{"title":"Validate order import","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json post /orders/import/validate","href":"/api-reference/order/order/validate-order-import"},{"title":"Commit order import","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json post /orders/import/commit","href":"/api-reference/order/order/commit-order-import"},{"title":"Read order import","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json get /orders/import/{importId}","href":"/api-reference/order/order/read-order-import"},{"title":"Read active step options","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-order.json get /order-type/{id}/active-step-options","href":"/api-reference/order/order/read-active-step-options"}]}]},{"group":"Workflow","pages":[{"group":"Data Type","pages":[{"title":"Data","href":"/api-reference/data/overview"},{"title":"Data Type","href":"/api-reference/data/data-type-overview"},{"title":"Read data type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data-types","href":"/api-reference/data/data-type/read-data-type"},{"title":"Read data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data-type/{dataTypeId}/","href":"/api-reference/data/data-type/read-data-type-by-id"},{"title":"Create data type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data-type","href":"/api-reference/data/data-type/create-data-type"},{"title":"Update data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json put /data-type/{dataTypeId}","href":"/api-reference/data/data-type/update-data-type-by-id"},{"title":"Update partially data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json patch /data-type/{dataTypeId}","href":"/api-reference/data/data-type/update-partially-data-type-by-id"},{"title":"Delete data type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /data-type/{dataTypeId}","href":"/api-reference/data/data-type/delete-data-type-by-id"},{"title":"Create data types in bulk","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data-type/bulk","href":"/api-reference/data/data-type/create-data-types-in-bulk"},{"title":"Count data types","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data-types/count","href":"/api-reference/data/data-type/count-data-types"},{"title":"Copy v3 data type to v4","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data-type/{dataTypeId}/copy","href":"/api-reference/data/data-type/copy-v3-data-type-to-v4"},{"title":"Move v3 data type to v4","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data-type/{dataTypeId}/move","href":"/api-reference/data/data-type/move-v3-data-type-to-v4"},{"title":"Resume data type migration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data-type/{dataTypeId}/migration/resume","href":"/api-reference/data/data-type/resume-data-type-migration"}]},{"group":"Data Source","pages":[{"title":"Data Source","href":"/api-reference/data/data-source-overview"},{"title":"Read data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data","href":"/api-reference/data/data-source/read-data-source"},{"title":"Create data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data","href":"/api-reference/data/data-source/create-data-source"},{"title":"Read data source by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data/{dataId}","href":"/api-reference/data/data-source/read-data-source-by-id"},{"title":"Read data source by dataTypeName and dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data/type/{dataTypeName}/{dataId}","href":"/api-reference/data/data-source/read-data-source-by-datatypename-and-dataid"},{"title":"Read data source by hubId, dataTypeName, dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json get /data/hub/{hubId}/type/{dataTypeName}/{data_id}","href":"/api-reference/data/data-source/read-data-source-by-hubid-datatypename-dataid"},{"title":"Bulk create data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data/bulk","href":"/api-reference/data/data-source/bulk-create-data-source"},{"title":"Bulk create or update data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json post /data/bulk/upsert","href":"/api-reference/data/data-source/bulk-create-or-update-data-source"},{"title":"Update data source by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json put /data/{_id}","href":"/api-reference/data/data-source/update-data-source-by-id"},{"title":"Update data source by hubId, dataTypeName, dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json put /data/hub/{hub_id}/type/{dataTypeName}/{dataId}","href":"/api-reference/data/data-source/update-data-source-by-hubid-datatypename-dataid"},{"title":"Update partially data source by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json patch /data/{data_id}","href":"/api-reference/data/data-source/update-partially-data-source-by-id"},{"title":"Delete data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /data/{data_id}/","href":"/api-reference/data/data-source/delete-data-source"},{"title":"Delete data source by hubId, dataTypeName, dataId","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /data/hub/{hubId}/type/{dataTypeName}/{dataId}","href":"/api-reference/data/data-source/delete-data-source-by-hubid-datatypename-dataid"},{"title":"Bulk patch data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json patch /datas/bulk","href":"/api-reference/data/data-source/bulk-patch-data-source"},{"title":"Bulk delete data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-data.json delete /datas/bulk","href":"/api-reference/data/data-source/bulk-delete-data-source"}]},{"group":"Flow","pages":[{"title":"Flow","href":"/api-reference/flow/overview"},{"title":"Read flows","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flows","href":"/api-reference/flow/flow/read-flows"},{"title":"Read flow by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow/{flowId}","href":"/api-reference/flow/flow/read-flow-by-id"},{"title":"Read flow fields","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow-fields","href":"/api-reference/flow/flow/read-flow-fields"},{"title":"Read flow components","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow-components","href":"/api-reference/flow/flow/read-flow-components"},{"title":"Read flow component by flow name","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow/{flowName}/fields","href":"/api-reference/flow/flow/read-flow-component-by-flow-name"},{"title":"Generate example","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow/{flowName}/task","href":"/api-reference/flow/flow/generate-example"},{"title":"Read flow histories","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /flow-logs","href":"/api-reference/flow/flow/read-flow-histories"},{"title":"Create flow","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /flow","href":"/api-reference/flow/flow/create-flow"},{"title":"Read flow versions","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /flows/check-version","href":"/api-reference/flow/flow/read-flow-versions"},{"title":"Re-order flow","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /flow-reorder","href":"/api-reference/flow/flow/re-order-flow"},{"title":"Update flow by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /flow/{flow_id}","href":"/api-reference/flow/flow/update-flow-by-id"},{"title":"Delete flow by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json delete /flow/{flow_id}","href":"/api-reference/flow/flow/delete-flow-by-id"},{"title":"Restore flow by flow log ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /flow/{flowId}/restore/{flowLogId}","href":"/api-reference/flow/flow/restore-flow-by-flow-log-id"}]},{"group":"Order Type","pages":[{"title":"Order Type","href":"/api-reference/flow/order-type-overview"},{"title":"Read order types","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /order-types","href":"/api-reference/flow/order-type/read-order-types"},{"title":"Create order type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /order-type","href":"/api-reference/flow/order-type/create-order-type"},{"title":"Read order type by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /order-type/{id}","href":"/api-reference/flow/order-type/read-order-type-by-id"},{"title":"Update order type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /order-type/{id}","href":"/api-reference/flow/order-type/update-order-type"},{"title":"Delete order type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json delete /order-type/{id}","href":"/api-reference/flow/order-type/delete-order-type"},{"title":"Publish order type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json patch /order-type/{id}/publish","href":"/api-reference/flow/order-type/publish-order-type"},{"title":"Restore order type version","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /order-type/{id}/restore/{version}","href":"/api-reference/flow/order-type/restore-order-type-version"},{"title":"Simulate order type","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /order-type/{id}/simulate","href":"/api-reference/flow/order-type/simulate-order-type"},{"title":"Read order type versions","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /order-type-logs","href":"/api-reference/flow/order-type/read-order-type-versions"},{"title":"Validate order type draft","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /order-type-validate","href":"/api-reference/flow/order-type/validate-order-type-draft"}]},{"group":"Automation","pages":[{"title":"Automation","href":"/api-reference/flow/automation-overview"},{"title":"Read automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /automations","href":"/api-reference/flow/automation/read-automation"},{"title":"Read log automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /automation-log","href":"/api-reference/flow/automation/read-log-automation"},{"title":"Read automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /automation/{automationId}","href":"/api-reference/flow/automation/read-automation-by-id"},{"title":"Create automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /automation","href":"/api-reference/flow/automation/create-automation"},{"title":"Retry bulk automation","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json post /automation-retries","href":"/api-reference/flow/automation/retry-bulk-automation"},{"title":"Update automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json put /automation/{automation_id}","href":"/api-reference/flow/automation/update-automation-by-id"},{"title":"Update partially automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json patch /automation/{automation_id}","href":"/api-reference/flow/automation/update-partially-automation-by-id"},{"title":"Retry automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json patch /automation-retry/{log_id}","href":"/api-reference/flow/automation/retry-automation-by-id"},{"title":"Delete automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json delete /automation/{automation_id}/","href":"/api-reference/flow/automation/delete-automation-by-id"},{"title":"Read log automation by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-flow.json get /automation-log/{logId}","href":"/api-reference/flow/automation/read-log-automation-by-id"}]}]},{"group":"Export \u0026 Import","pages":[{"group":"Export","pages":[{"title":"Export \u0026 Import","href":"/api-reference/importexport/overview"},{"title":"Export Task","href":"/api-reference/importexport/export-task-overview"},{"title":"Export Config","href":"/api-reference/importexport/export-config-overview"},{"title":"Get export log history","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /tasks/export-log","href":"/api-reference/importexport/export-task/get-export-log-history"},{"title":"Export tasks","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /tasks/export","href":"/api-reference/importexport/export-task/export-tasks"},{"title":"Export data source","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /data/export","href":"/api-reference/importexport/export-task/export-data-source"},{"title":"Read export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /export-configs","href":"/api-reference/importexport/export-config/read-export-config"},{"title":"Read export config by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /export-config/{exportConfigId}","href":"/api-reference/importexport/export-config/read-export-config-by-id"},{"title":"Create export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /export-config","href":"/api-reference/importexport/export-config/create-export-config"},{"title":"Update export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json put /export-config/{exportConfigId}/","href":"/api-reference/importexport/export-config/update-export-config"},{"title":"Delete export config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json delete /export-config/{exportConfigId}/","href":"/api-reference/importexport/export-config/delete-export-config"}]},{"group":"Import","pages":[{"title":"Data Import","href":"/api-reference/importexport/data-import-overview"},{"title":"Import Config","href":"/api-reference/importexport/import-config-overview"},{"title":"Import data source from file","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /data/import","href":"/api-reference/importexport/data-import/import-data-source-from-file"},{"title":"Read import monitoring records","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-monitoring","href":"/api-reference/importexport/data-import/read-import-monitoring-records"},{"title":"Read import monitoring record by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-monitoring/{id}","href":"/api-reference/importexport/data-import/read-import-monitoring-record-by-id"},{"title":"Read import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-configs","href":"/api-reference/importexport/import-config/read-import-config"},{"title":"Create import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /import-configs","href":"/api-reference/importexport/import-config/create-import-config"},{"title":"Read import config by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /import-configs/{importConfigId}","href":"/api-reference/importexport/import-config/read-import-config-by-id"},{"title":"Update import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json put /import-configs/{importConfigId}","href":"/api-reference/importexport/import-config/update-import-config"},{"title":"Delete import config","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json delete /import-configs/{importConfigId}","href":"/api-reference/importexport/import-config/delete-import-config"},{"title":"Import tasks from file","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json post /tasks/import","href":"/api-reference/importexport/data-import/import-tasks-from-file"},{"title":"Read task import records","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-importexport.json get /tasks/import-monitoring","href":"/api-reference/importexport/data-import/read-task-import-records"}]}]},{"group":"Settings","pages":[{"title":"Settings","href":"/api-reference/setting/overview"},{"group":"Users \u0026 Access","pages":[{"group":"User","pages":[{"title":"User","href":"/api-reference/setting/user-overview"},{"title":"Read user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /users","href":"/api-reference/setting/user/read-user"},{"title":"Read mine","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /user","href":"/api-reference/setting/user/read-mine"},{"title":"Update partially user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json patch /user","href":"/api-reference/setting/user/update-partially-user"},{"title":"Read user by email","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /user/email/{email}","href":"/api-reference/setting/user/read-user-by-email"},{"title":"Read user by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /user/{userId}","href":"/api-reference/setting/user/read-user-by-id"},{"title":"Update user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /user/{userId}","href":"/api-reference/setting/user/update-user"},{"title":"Read locked user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /members/locked","href":"/api-reference/setting/user/read-locked-user"},{"title":"Unlock locked user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /member/unlock","href":"/api-reference/setting/user/unlock-locked-user"},{"title":"Reset password user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /member/reset-password","href":"/api-reference/setting/user/reset-password-user"},{"title":"Delete user","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /member/{userId}","href":"/api-reference/setting/user/delete-user"},{"title":"Update member","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /member/{userId}","href":"/api-reference/setting/user/update-member"},{"title":"Search users","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /user/search","href":"/api-reference/setting/user/search-users"}]},{"group":"Team","pages":[{"title":"Team","href":"/api-reference/setting/team-overview"},{"title":"Read team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /teams","href":"/api-reference/setting/team/read-team"},{"title":"Read team by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /team/{teamId}","href":"/api-reference/setting/team/read-team-by-id"},{"title":"Create team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /team","href":"/api-reference/setting/team/create-team"},{"title":"Update team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /team/{teamId}/","href":"/api-reference/setting/team/update-team"},{"title":"Delete team","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /team/{teamId}/","href":"/api-reference/setting/team/delete-team"}]},{"group":"Permission","pages":[{"title":"Role","href":"/api-reference/setting/role-overview"},{"title":"Read role","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /roles","href":"/api-reference/setting/role/read-role"},{"title":"Read role by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /role/{roleId}","href":"/api-reference/setting/role/read-role-by-id"},{"title":"Read my role","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /role","href":"/api-reference/setting/role/read-my-role"},{"title":"Read permissions","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /permissions","href":"/api-reference/setting/role/read-permissions"}]}]},{"group":"Workspace","pages":[{"group":"Organization","pages":[{"title":"Organization","href":"/api-reference/setting/organization-overview"},{"title":"Update organization","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /organization","href":"/api-reference/setting/organization/update-organization"}]},{"group":"Hub","pages":[{"title":"Hub","href":"/api-reference/setting/hub-overview"},{"title":"Read hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /hubs","href":"/api-reference/setting/hub/read-hub"},{"title":"Read hub by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /hub/{hubId}/","href":"/api-reference/setting/hub/read-hub-by-id"},{"title":"Create hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /hub","href":"/api-reference/setting/hub/create-hub"},{"title":"Update hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /hub/{hubId}","href":"/api-reference/setting/hub/update-hub"},{"title":"Delete hub","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /hub/{hubId}","href":"/api-reference/setting/hub/delete-hub"}]}]},{"group":"Security","pages":[{"group":"Password Policy","pages":[{"title":"Password Policy","href":"/api-reference/setting/password-policy-overview"},{"title":"Read password policies","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /password-policies","href":"/api-reference/setting/password-policy/read-password-policies"},{"title":"Create password policy","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /password-policy","href":"/api-reference/setting/password-policy/create-password-policy"},{"title":"Read password policy by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /password-policy/{id}","href":"/api-reference/setting/password-policy/read-password-policy-by-id"},{"title":"Update password policy","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /password-policy/{id}","href":"/api-reference/setting/password-policy/update-password-policy"},{"title":"Update password policy (PATCH)","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json patch /password-policy/{id}","href":"/api-reference/setting/password-policy/update-password-policy-patch"},{"title":"Delete password policy","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /password-policy/{id}","href":"/api-reference/setting/password-policy/delete-password-policy"}]}]},{"group":"Monitoring","pages":[{"group":"Geofence","pages":[{"title":"Geofence","href":"/api-reference/monitoring/geofence-overview"},{"title":"Read geofences","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json get /geofence","href":"/api-reference/monitoring/geofence/read-geofences"},{"title":"Create geofence","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json post /geofence","href":"/api-reference/monitoring/geofence/create-geofence"},{"title":"Read geofence by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json get /geofence/{id}","href":"/api-reference/monitoring/geofence/read-geofence-by-id"},{"title":"Update geofence","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json put /geofence/{id}","href":"/api-reference/monitoring/geofence/update-geofence"},{"title":"Update geofence status","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json patch /geofence/{id}","href":"/api-reference/monitoring/geofence/update-geofence-status"},{"title":"Delete geofence","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json delete /geofence/{id}","href":"/api-reference/monitoring/geofence/delete-geofence"},{"title":"Read geofence groups","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json get /geofence-group","href":"/api-reference/monitoring/geofence-group/read-geofence-groups"},{"title":"Create geofence group","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json post /geofence-group","href":"/api-reference/monitoring/geofence-group/create-geofence-group"},{"title":"Update geofence group","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json put /geofence-group/{id}","href":"/api-reference/monitoring/geofence-group/update-geofence-group"},{"title":"Delete geofence group","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json delete /geofence-group/{id}","href":"/api-reference/monitoring/geofence-group/delete-geofence-group"}]},{"group":"Alert Setting","pages":[{"title":"Alert Setting","href":"/api-reference/monitoring/alert-setting-overview"},{"title":"Read alert setting","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json get /alert-setting","href":"/api-reference/monitoring/alert-setting/read-alert-setting"},{"title":"Update alert setting","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-monitoring.json put /alert-setting","href":"/api-reference/monitoring/alert-setting/update-alert-setting"}]}]},{"group":"Extensions","pages":[{"group":"Add-ons","pages":[{"title":"Add-on","href":"/api-reference/setting/addon-overview"},{"title":"Create add-on","description":"Creates a new add-on for your organization with JavaScript resource file and optional SVG icon. The add-on extends functionality within the app for your organization.","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /addon","href":"/api-reference/setting/addon/create-add-on"},{"title":"Get add-on details","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /addon/{id}","href":"/api-reference/setting/addon/get-add-on-details"},{"title":"Update add-on","description":"Updates an existing add-on's name and description. Only add-ons belonging to your organization can be updated.","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /addon/{id}","href":"/api-reference/setting/addon/update-add-on"},{"title":"Update add-on partially","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json patch /addon/{id}","href":"/api-reference/setting/addon/update-add-on-partially"},{"title":"Delete add-on","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /addon/{id}","href":"/api-reference/setting/addon/delete-add-on"},{"title":"List add-ons","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /addons","href":"/api-reference/setting/addon/list-add-ons"}]},{"group":"Integration","pages":[{"title":"App Integration","href":"/api-reference/setting/app-integration-overview"},{"title":"Read App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /app-integrations","href":"/api-reference/setting/app-integration/read-app-integration"},{"title":"Read App Integration by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /app-integration/{appIntegrationId}","href":"/api-reference/setting/app-integration/read-app-integration-by-id"},{"title":"Delete App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /app-integration/{appIntegrationId}","href":"/api-reference/setting/app-integration/delete-app-integration"},{"title":"Create App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /app-integration","href":"/api-reference/setting/app-integration/create-app-integration"},{"title":"Update App Integration","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /app-integration-update/{appIntegrationId}","href":"/api-reference/setting/app-integration/update-app-integration"},{"title":"Read SMS gateway","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /sms-gateway","href":"/api-reference/setting/app-integration/read-sms-gateway"},{"title":"Create SMS gateway","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /sms-gateway","href":"/api-reference/setting/app-integration/create-sms-gateway"},{"title":"Update SMS gateway","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /sms-gateway/{id}","href":"/api-reference/setting/app-integration/update-sms-gateway"},{"title":"Delete SMS gateway","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /sms-gateway/{id}","href":"/api-reference/setting/app-integration/delete-sms-gateway"},{"title":"Test SMS gateway","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /sms-gateway/test","href":"/api-reference/setting/app-integration/test-sms-gateway"},{"title":"Read Accurate connection status","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /integration/accurate/status","href":"/api-reference/setting/app-integration/read-accurate-connection-status"},{"title":"Start Accurate connection","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /integration/accurate/connect-start","href":"/api-reference/setting/app-integration/start-accurate-connection"},{"title":"Disconnect Accurate","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /integration/accurate/disconnect","href":"/api-reference/setting/app-integration/disconnect-accurate"},{"title":"Read Accurate modules","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /integration/accurate/modules","href":"/api-reference/setting/app-integration/read-accurate-modules"},{"title":"Read Accurate module options","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /integration/accurate/module-options","href":"/api-reference/setting/app-integration/read-accurate-module-options"},{"title":"Read Accurate business data","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /integration/accurate/business-data","href":"/api-reference/setting/app-integration/read-accurate-business-data"},{"title":"Read Accurate flow usage","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /integration/accurate/flow-usage","href":"/api-reference/setting/app-integration/read-accurate-flow-usage"},{"title":"Read Accurate webhook log","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /integration/accurate/webhook-log","href":"/api-reference/setting/app-integration/read-accurate-webhook-log"},{"title":"Read Accurate sync rules","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /integration/accurate/rules","href":"/api-reference/setting/app-integration/read-accurate-sync-rules"},{"title":"Create Accurate sync rule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /integration/accurate/rules","href":"/api-reference/setting/app-integration/create-accurate-sync-rule"},{"title":"Update Accurate sync rule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /integration/accurate/rules/{id}","href":"/api-reference/setting/app-integration/update-accurate-sync-rule"},{"title":"Delete Accurate sync rule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /integration/accurate/rules/{id}","href":"/api-reference/setting/app-integration/delete-accurate-sync-rule"},{"title":"Turn Accurate sync rule on or off","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /integration/accurate/rules/{id}/toggle","href":"/api-reference/setting/app-integration/turn-accurate-sync-rule-on-or-off"},{"title":"Repair Accurate sync rule","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /integration/accurate/rules/{id}/repair","href":"/api-reference/setting/app-integration/repair-accurate-sync-rule"}]},{"group":"Custom Module","pages":[{"title":"Custom Module","href":"/api-reference/setting/custom-module-overview"},{"title":"Read custom modules","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /custom-modules","href":"/api-reference/setting/custom-module/read-custom-modules"},{"title":"Create custom module","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json post /custom-module","href":"/api-reference/setting/custom-module/create-custom-module"},{"title":"Read custom module by ID","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /custom-module/{id}","href":"/api-reference/setting/custom-module/read-custom-module-by-id"},{"title":"Update custom module","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json put /custom-module/{id}","href":"/api-reference/setting/custom-module/update-custom-module"},{"title":"Delete custom module","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json delete /custom-module/{id}","href":"/api-reference/setting/custom-module/delete-custom-module"}]}]},{"group":"Other","pages":[{"group":"Trash","pages":[{"title":"Trash","href":"/api-reference/setting/trash-overview"},{"title":"Read trash","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-setting.json get /trash","href":"/api-reference/setting/trash/read-trash"}]}]}]},{"group":"Account","pages":[{"group":"Switching Organization","pages":[{"title":"Multi-Organization","href":"/api-reference/auth/multi-organization-overview"},{"title":"Get User Organizations","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-auth.json get /organizations","href":"/api-reference/auth/multi-organization/get-user-organizations"},{"title":"Switch Organization","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-auth.json post /organization/switch","href":"/api-reference/auth/multi-organization/switch-organization"},{"title":"Create Organization","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-auth.json post /organization","href":"/api-reference/auth/multi-organization/create-organization"}]},{"group":"Short Token","pages":[{"title":"Generate Short Token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-tools.json post /short-token/generate","href":"/api-reference/tools/short-token/generate-short-token"},{"title":"Resolve Short Token","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-tools.json post /short-token/resolve","href":"/api-reference/tools/short-token/resolve-short-token"}]}]},{"group":"Webhook","pages":[{"title":"How does it works","href":"/api-reference/webhooks/how-it-works"},{"title":"Delivery Attempts and Retries","href":"/api-reference/webhooks/delivery-attempts"},{"title":"Quick Response Requirement","href":"/api-reference/webhooks/quick-response"},{"title":"Failure Monitoring and Notification Process","href":"/api-reference/webhooks/failure-monitoring"},{"group":"Webhook","pages":[{"title":"Task events","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook task-events","href":"/api-reference/webhooks/webhook/task-events"},{"title":"On data source created","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook data-source-created","href":"/api-reference/webhooks/webhook/on-data-source-created"},{"title":"Routing events","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook routing-events","href":"/api-reference/webhooks/webhook/routing-events"},{"title":"Trip events","version":null,"deprecated":null,"openapi":"/openapi/public/openapi-webhooks.json webhook trip-events","href":"/api-reference/webhooks/webhook/trip-events"}]}]},{"group":"File","pages":[{"title":"Overview","href":"/api-reference/file/overview"},{"group":"File","pages":[{"title":"View file","deprecated":false,"version":null,"openapi":"/openapi/public/openapi-file.json get /file/view","href":"/api-reference/file/file/view-file"}]}]},{"group":"Objects","pages":[{"title":"Task object","href":"/api-reference/objects/task-object"},{"title":"Location history object","href":"/api-reference/objects/location-history-object"},{"title":"Alert object","href":"/api-reference/objects/alert-object"},{"title":"Export Config object","href":"/api-reference/objects/export-config-object"},{"title":"Task Schedule object","href":"/api-reference/objects/task-schedule-object"},{"title":"Vehicle object","href":"/api-reference/objects/vehicle-object"},{"title":"Routing object","href":"/api-reference/objects/routing-object"},{"title":"Flow object","href":"/api-reference/objects/flow-object"},{"title":"Automation object","href":"/api-reference/objects/automation-object"},{"title":"Data source object","href":"/api-reference/objects/data-source-object"},{"title":"Data type object","href":"/api-reference/objects/data-type-object"},{"title":"User object","href":"/api-reference/objects/user-object"},{"title":"Role object","href":"/api-reference/objects/role-object"},{"title":"Hub object","href":"/api-reference/objects/hub-object"},{"title":"Team object","href":"/api-reference/objects/team-object"},{"title":"Add-on object","href":"/api-reference/objects/addon-object"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/pages/changelog"}]},{"tab":"Internal API","hidden":true,"pages":[{"title":"Internal API","href":"/api-reference-internal/introduction"}]}]},"basePath":"","title":"Get add-on details - Docs","buildId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","deploymentId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DbeN8Wo6.js","utils-CwSb5Doc.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BmREeM3N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-AYjWerCj.js","snippetPresets-QD4ULQlp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Digj5cjF.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CiHrzluR.js","shallow-D7h7pFGg.js","getApiPlaygroundDisplay-mlxkpAUf.js","CodeSnippet-D2rH5lZI.js","CodeSnippets-B53ulOaL.js","Page-CqcDm2To.js","getPastedJson-DxGeNMih.js","icon-BHbyrebp.js","MethodPill-C7F_KEEJ.js","DuplicateIcon-j3c5-73z.js","createIcon-OvCnyFqD.js","DynamicMarkdown-DpAS3GCb.js","SectionHeading-DMPpdrvW.js","axios-vUo_bRtp.js","Markdown-D7pDRguu.js","clsx-2_c6mSt_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cu7_SikL.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ydqCcy4b.js"]}