This API is in preview. Endpoints and request and response shapes may
change before the stable release.
The Ontoto API gives external integrations read access to your organisation’s
devices, sensor data, device groups and sites.Start by generating an API token in the Ontoto Dashboard.
Download OpenAPI spec
The full OpenAPI specification, for a client generator or API tool
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ontoto Docs","colors":{"primary":"#007BFF","light":"#5A9BFF","dark":"#0056B3"},"logo":{"light":"https://mintcdn.com/ontoto-fbe6101f/RAvqJ7QBQVtymFi1/logo/ontoto.svg?fit=max\u0026auto=format\u0026n=RAvqJ7QBQVtymFi1\u0026q=85\u0026s=4f12873e51d6f8c6dd60112d9de93a86","dark":"https://mintcdn.com/ontoto-fbe6101f/RAvqJ7QBQVtymFi1/logo/ontoto.svg?fit=max\u0026auto=format\u0026n=RAvqJ7QBQVtymFi1\u0026q=85\u0026s=4f12873e51d6f8c6dd60112d9de93a86"},"favicon":"https://mintcdn.com/ontoto-fbe6101f/MdF40awRA5TU8ZZ4/favicon.svg?fit=max\u0026auto=format\u0026n=MdF40awRA5TU8ZZ4\u0026q=85\u0026s=d94e3c3638fe22734da5265d32a25f82","api":{"openapi":"openapi.yaml","examples":{"defaults":"required","prefill":false}},"navbar":{"links":[],"primary":{"type":"button","label":"Dashboard","href":"https://beta.ontoto.com"}},"footer":{},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ontoto-fbe6101f","hasAudioNarration":false,"actualSubdomain":"ontoto-fbe6101f","customDomains":["docs.beta.ontoto.com"],"gitSource":{"type":"github","owner":"ontoto","repo":"ontoto-dashboard-typescript","deployBranch":"master","contentDirectory":"packages/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac8740073d901d9064753e6","collectionId":"7d975bd7-a26b-45ac-9e99-7098f578f66e","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac8740073d901d9064753e6"},"entitlements":{},"buildId":"6ac8740073d901d9064753e6","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API Reference","count":14},{"language":"default","tag":"Getting Started","count":4},{"language":"default","tag":"Sensor Data","count":4},{"language":"default","tag":"Devices","count":2},{"language":"default","tag":"Device Groups","count":2},{"language":"default","tag":"Sites","count":2},{"language":"default","tag":"Outbound Delivery","count":1},{"language":"default","tag":"Dashboard Guide","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","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":"editor-v7-file-tree","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":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"Introduction","description":null,"href":"/api-reference/introduction"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Card,Warning}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Warning,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`This API is in preview.`}),` Endpoints and request and response shapes may\nchange before the stable release.`]})}),`\n`,_jsx(_components.p,{children:`The Ontoto API gives external integrations read access to your organisation’s\ndevices, sensor data, device groups and sites.`}),`\n`,_jsxs(_components.p,{children:[`Start by `,_jsx(_components.a,{href:`/api-reference/authentication`,children:`generating an API token`}),` in the Ontoto Dashboard.`]}),`\n`,_jsx(Card,{title:`Download OpenAPI spec`,icon:`download`,href:`https://docs.beta.ontoto.com/openapi.yaml`,children:_jsx(_components.p,{children:`The full OpenAPI specification, for a client generator or API tool`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Introduction","description":null,"href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ontoto-fbe6101f/e92cd72e305e1d85/eslint.config.js"],"subdomain":"ontoto-fbe6101f","siteName":"Ontoto Docs","title":"Introduction - Ontoto Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-09T04:56:38.105Z","originalFileLocation":"api-reference/introduction.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=\"application-name\" content=\"Ontoto Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ontoto-fbe6101f/MdH7qCWRs4ewz4pg/_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/ontoto-fbe6101f/MdH7qCWRs4ewz4pg/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ontoto-fbe6101f/MdH7qCWRs4ewz4pg/_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/ontoto-fbe6101f/MdH7qCWRs4ewz4pg/_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/ontoto-fbe6101f/MdH7qCWRs4ewz4pg/_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/ontoto-fbe6101f/MdH7qCWRs4ewz4pg/_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/ontoto-fbe6101f/MdH7qCWRs4ewz4pg/_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/ontoto-fbe6101f/MdH7qCWRs4ewz4pg/_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/ontoto-fbe6101f/MdH7qCWRs4ewz4pg/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Introduction - Ontoto Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ontoto Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.beta.ontoto.com/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ontoto-fbe6101f.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Introduction\u0026amp;theme=640bf5f6d407b9aa95653549\u0026amp;signature=b4d12c1c1d40789e662b39bd0c5f67a0b4705d210fa3cb12991d05eb5142ff27\">\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=\"Introduction - Ontoto Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ontoto-fbe6101f.mintlify.app/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Introduction\u0026amp;theme=640bf5f6d407b9aa95653549\u0026amp;signature=b4d12c1c1d40789e662b39bd0c5f67a0b4705d210fa3cb12991d05eb5142ff27\">\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/ontoto-fbe6101f/MdH7qCWRs4ewz4pg/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ontoto Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#007BFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.beta.ontoto.com/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.beta.ontoto.com/#organization\",\"name\":\"Ontoto Docs\",\"url\":\"https://docs.beta.ontoto.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ontoto-fbe6101f/RAvqJ7QBQVtymFi1/logo/ontoto.svg?fit=max\u0026auto=format\u0026n=RAvqJ7QBQVtymFi1\u0026q=85\u0026s=4f12873e51d6f8c6dd60112d9de93a86\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.beta.ontoto.com#website\",\"name\":\"Ontoto Docs\",\"url\":\"https://docs.beta.ontoto.com\",\"publisher\":{\"@id\":\"https://docs.beta.ontoto.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.beta.ontoto.com/api-reference/introduction#webpage\",\"url\":\"https://docs.beta.ontoto.com/api-reference/introduction\",\"name\":\"Introduction\",\"dateModified\":\"2026-10-09T04:56:38.105Z\",\"isPartOf\":{\"@id\":\"https://docs.beta.ontoto.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.beta.ontoto.com/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.beta.ontoto.com/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Ontoto Docs\",\"item\":\"https://docs.beta.ontoto.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.beta.ontoto.com/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.beta.ontoto.com/api-reference/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"url\":\"https://docs.beta.ontoto.com/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.beta.ontoto.com/api-reference/introduction#webpage\"},\"dateModified\":\"2026-10-09T04:56:38.105Z\",\"publisher\":{\"@id\":\"https://docs.beta.ontoto.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.beta.ontoto.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ontoto Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ontoto Docs","nav":{"global":null,"tabs":[{"tab":"Dashboard Guide","pages":[{"title":"Dashboard Guide","href":"/dashboard/introduction"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","description":"Generate an API token and send it with each request","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"}]},{"group":"Devices","pages":[{"openapi":"get /devices","title":"List devices","href":"/api-reference/list-devices"},{"openapi":"get /devices/{sn}","title":"Get device","href":"/api-reference/get-device"}]},{"group":"Sensor Data","pages":[{"openapi":"post /sensor-data","title":"Fetch sensor data","href":"/api-reference/fetch-sensor-data"},{"openapi":"post /sensor-data/latest","title":"Fetch latest sensor data","href":"/api-reference/fetch-latest-sensor-data"},{"openapi":"post /sensor-data/gnss","title":"Fetch GNSS sensor data","href":"/api-reference/fetch-gnss-sensor-data"},{"openapi":"post /sensor-data/gnss/latest","title":"Fetch latest GNSS sensor data","href":"/api-reference/fetch-latest-gnss-sensor-data"}]},{"group":"Device Groups","pages":[{"openapi":"get /device-groups","title":"List device groups","href":"/api-reference/list-device-groups"},{"openapi":"get /device-groups/{uuid}","title":"Get device group","href":"/api-reference/get-device-group"}]},{"group":"Sites","pages":[{"openapi":"get /sites","title":"List sites","href":"/api-reference/list-sites"},{"openapi":"get /sites/{uuid}","title":"Get site","href":"/api-reference/get-site"}]},{"group":"Outbound Delivery","pages":[{"title":"HTTP delivery","href":"/api-reference/http-delivery"}]}]}]},"title":"Introduction - Ontoto Docs","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":[],"chunks":[]}