For AI agents: visit https://developer.loconiq.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
LoconIQ
DocumentationAPI ReferenceChangelogStatus Page
LoconIQ
API Reference
DocumentationAPI ReferenceChangelogStatus Page

General

  • How to use the API

LoconIQ API

  • Environment Infrastructure
    • List Edgesget
    • Get Edge by Idget
    • Update Edge by Idput
    • Patch Edge by Idpatch
    • Link environment to an Edgepost
    • Unlink environment from an Edgedel
    • Get On Premise Api Keyget
    • Create On Premise Api Keypost
    • Delete On Premise Api Keydel
    • List Environmentsget
    • Create Environmentpost
    • Get Environments by Idget
    • Update Environmentput
    • Delete Environments by Iddel
    • Patch Environmentpatch
    • List Environment Locisget
    • Link Loci to Environmentpost
    • Unlink Loci from Environmentdel
    • List 3D Models from Environmentget
    • Create 3D Model upload linkpost
    • Get 3D Model by Idget
    • Delete 3D Model by Iddel
    • Patch the 3D Modelpatch
    • Create 3D Model download linkpost
    • Finish 3D Model uploadpost
    • Create 3D Model thumbnail upload linkpost
    • List Environment Zonesget
    • Link Zone to Environmentpost
    • Unlink Zone from Environmentdel
    • List Locisget
    • List Loci positionsget
    • Get Loci by Idget
    • Update Loci by Idput
    • Patch Loci by Idpatch
    • Get Events from Lociget
    • Update Loci Positionput
    • Reset Loci positionpost
    • Get Zone from Lociget
    • Preview Setupget
    • Run Setuppost
    • List Zonesget
    • Create Zonepost
    • List Locis from multiple Zonesget
    • Get Zone by Idget
    • Update Zoneput
    • Delete Zone by Iddel
    • Patch Zonepatch
    • List Zone Locisget
    • Get environment stateget
    • Get Calibration Statusget
    • Start Calibrationpost
    • Update multiple Loci Positionsput
    • Update multiple Zonesput
  • User and Organizations
    • Get User Detailsget
    • Patch userpatch
    • Create Api Key (Cloud)post
    • List Api Keys (Cloud)get
    • Delete Api Key (Cloud)del
    • Create App Tokenpost
    • Login Userpost
    • Create an Organizationpost
    • Get expanded Organization Detailsget
    • Get Organization by Idget
    • Delete an Organizationdel
    • Patche an Organizationpatch
    • List Organization Permissionget
    • Update Organization Permissionput
    • Create Organization Permissionpost
    • Delete Organization Permissiondel
    • Delete User from Organizationdel
    • Get Sub Organizationsget
    • Attach Sub Organizationpost
    • Detach Sub Organizationdel
    • Change Passwordpatch
    • Get the low battery push notification configurationget
    • Enables low battery push notificationsput
    • Disables low battery push notificationsdel
    • List user zone push notification configurationsget
    • Creates a user zone push notification configurationpost
    • List user zone push notification configurations for a zoneget
    • Get a user zone push notification configurationget
    • Deletes a user zone push notification configurationdel
  • App
    • List Environmentsget
    • Get Environment by Idget
    • List 3D Models from Environmentget
    • Get 3D Model by Idget
    • Create 3D Model download linkpost
    • List Locisget
    • Get Loci by Idget
    • List Zones from Lociget
    • List Zonesget
    • Get Zone by Idget

LoconIQ On Premise API

  • Environment Infrastructure
    • List Environmentsget
    • Get Environments by Idget
    • List Environment Locisget
    • List Locisget
    • List Loci positionsget
    • Get Loci by Idget
    • Get Events from Lociget
    • Get Zone from Lociget
    • List Zonesget
    • List Locis from multiple Zonesget
    • Get Zone by Idget
    • Get environment stateget
    • List Zone Locisget
Powered by 
  1. General

How to use the API

Have a look at our Development and Integration guide to get started with the API or head directly to our Cloud API or On-Premise API reference.

Updated 12 months ago


What’s Next

  • Development and Integration
  • Environment Infrastructure
Did this page help you?

Updated 12 months ago


What’s Next

  • Development and Integration
  • Environment Infrastructure
Did this page help you?