Jump to Content
Trackunit Developer Hub & Iris API suite
HomeIrisXIris API ReferenceChangelogApp SDKDesign SystemWebhooksMarketplace
Log InTrackunit Developer Hub & Iris API suite
Iris API Reference
Log In
HomeIrisXIris API ReferenceChangelogApp SDKDesign SystemWebhooksMarketplace

GETTING STARTED

  • Iris APIs Overview
  • Access Token
  • Product Spotlight: Iris APIs

GRAPHQL API

  • GraphQL API - Introduction
  • GraphQL Explorer
  • GraphQL Visualizer
  • Search & Filter with the Trackunit Search Engine
  • Errors in GraphQL
  • Pagination in GraphQL
  • GraphQL Rate Limits
  • REST APIs vs. GraphQL API

REST APIs OVERVIEW

  • REST APIs - Introduction
  • Errors
  • Pagination
  • Rate & Size Limiting
  • Versioning

ORGANISATIONAL MANAGEMENT

  • Intro to Organizational Management

Accounts

  • Accounts
    • Create accountpost
    • Delete accountdelete
    • Get accountget
    • Update accountput
    • Returns the account hierarchy for the specified account and downwardsget

Account Connections

  • Connections
    • Add a connection to the account.post
    • Remove the connection from the account.delete
    • Get the connection from the account by connected account ID.get

Users

  • Get Usersget
  • Delete Userdelete
  • Roles
    • Get Rolesget
  • Export usersget
  • Flows
    • Activate Userpost
    • Request Password Resetpost
    • Reset Passwordpost
  • Create Userpost
  • Get Userget
  • Queries
    • Query Users by Identifierspost
  • Update Userpatch

ASSET ADMINISTRATION

  • Intro to Asset Administration

Assets

  • Assets API - Introduction
  • Get assetsget
  • Get asset actionspost
  • Create assetspost
  • Onboard assetpost
  • Validate assets specificationspost
  • Delete assetdelete
  • Get asset fields editabilityget
  • Offboard assetpost
  • Attach telematics devicepost
  • Query assets by given identifierspost
  • Hide/unhide assetspatch
  • Update asset note by given identifierpatch
  • Fetch multiple asset notespost
  • Get assetget
  • v1.0
    • Get assetsget
    • Get asset actionspost
    • Create assetspost
    • Onboard assetpost
    • Validate assets specificationspost
    • Delete assetdelete
    • Get assetget
    • Update assetpatch
    • Get asset fields editabilityget
    • Offboard assetpost
    • Attach telematics devicepost
  • Update assetpatch

Ownership & Visibility

  • Remove visibilitypost
  • Share assetspost
  • Transfer assetspost
  • Unshare assetspost
  • List asset sharesget
  • Ownership & Visibility - Introduction

Machines

  • Machine APIs - Introduction
  • Get machinesget
  • Get machineget
  • Get machines summaryget
  • Get machine extended informationget
  • Query machinespost
  • Get Service Documentsget
  • Get Service Documentget
  • Download Service Documentget
  • Get machine fields editabilityget
  • Update machineput
  • Update machine extended informationput
  • Machine metadata
    • Get machine brandsget
    • Get machine categoriesget
    • Get machine modelsget

Machine Onboarding

  • Create Machine Onboarding Requestpost

Machine Onboarding Events

  • Get Onboarding Eventsget

Groups

  • Group Asset Relations
    • Remove Assets from Groupdelete
    • Get Assets in Groupget
    • Add Assets to Grouppost
    • Replace Assets in Groupput
  • Get Groupsget
  • Delete Groupdelete
  • Group User Relations
    • Remove Users from Groupdelete
    • Get Users in Groupget
    • Add Users to Grouppost
    • Replace Users in Groupput
  • Create Grouppost
  • Get Groupget
  • Update Grouppatch

Sites API

  • Sites API - Introduction
  • Get Sitesget
  • Delete Sitedelete
  • Create Sitepost
  • Get Siteget
  • SiteImage
    • Get list of all images for a siteget
    • Upload a new image for a sitepost
    • Delete site imagedelete
  • Update Sitepatch
  • SiteInsights
    • Get Sites Insightsget
    • Get Sites Insightspost
    • Get Site Insightget
  • SitesKPIs
    • Get Sites KPIsget
  • SiteHistory
    • Get Site Historyget
  • SiteAssets
    • Get Sites An Asset Is Onpost
    • Get On-Site Assetspost
  • SiteUsers
    • Get Site Usersget
    • Update Site Userspatch
  • SiteContacts
    • Get Site Contactsget
    • Create Site Contactpost
    • Delete Site Contactdelete
    • Update Site Contactpatch
  • Manage owning depots
    • Remove Owning Depot from Assetdelete
    • Assign Owning Depot to Assetpost
  • SiteIntervals
    • Get Site Intervalsget
  • SiteSuggestions
    • Get Site Suggestionspost
    • Get Site Suggestionget

Custom Fields API

  • Custom Fields API - Introduction
  • Definitions
    • Get Definitionget
    • Get Definitionsget
    • Create Definitionpost
    • Delete Definitiondelete
    • Get Definitionget
    • Update Definitionpatch
  • Values
    • Set custom field valuespost
    • Get Valuesget
    • Create Valuepost
    • Delete Valuedelete
    • Update Valuepatch

CONFIGURATION

  • Intro to Configuration

Telematics Device

  • Telematics Device API - Introduction
  • Devices identity
    • Get devices filtered by serial numberget
    • Get device identityget
    • Get device identity of a Trackunit device by serial numberget
  • Devices state
    • Get device stateget
    • Update desired statepatch
    • Get desired state documentationget
  • Devices telemetry
    • Get device telemetryget

Alerts

  • Alert API - Introduction
  • Alert configuration
    • Get all alert configurationsget
    • Configure an alertpost
    • /v1/configurations/unitOfMeasurementget
    • Delete an alert configurationdelete
    • Get a specific alert configurationget
    • Update a specific alert configurationpatch

TELEMATICS FOUNDATION

  • Intro to Telematics Foundation

Locations

  • Location API - Introduction
  • Get locationsget
  • Get locationget

Can Faults

  • CAN Faults API - Introduction
  • Faults
    • Get faultspost
  • Faults Summary
    • Get faults summarypost
  • Simulated Faults
    • Get simulatable faultsget
    • Get simulated faultsget
    • Resolve simulated faultpost
    • Send simulated faultpost
    • Get simulated faults summaryget
  • Unit Active Faults
    • Get unit active faultsget
    • Get unit active faultspost

DATA ARCHIVE

  • Intro to Data Archive
  • Data Model
  • Comparison & Overview of Data Archive APIs

AEMP ISO API

  • Export ISO 15143-3 (AEMP 2.0) - Introduction
  • snapshot
    • Fleet snapshotget
    • Single-element snapshotget
  • time-series
    • Machine insightsget
    • Peak daily speedget
    • Locationget
    • Fuel used within the past 24 hours.get
    • Fuel Remaining Ratioget
    • Diagnostic codesget
    • Engine conditionget
    • Cumulative distance travelled.get
    • Percent of DEF remainingget
    • Cumulative power take-off hoursget
    • Cumulative payload totalget
    • Cumulative operating hoursget
    • Cumulative idle non-operating hoursget
    • Cumulative load countget
    • Cumulative idle hoursget
    • Cumulative fuel used.get
    • Cumulative non-productive regeneration hoursget
    • Average daily engine load factorget

Time Series API

  • Time Series API - Introduction
  • Time Series API - Usage guide
  • Advanced Querying
    • Instant Queryget
    • Instant Querypost
    • Range Queryget
    • Range Querypost
    • List label namesget
    • List label namespost
    • List times seriesget
    • List times seriespost
    • List label valuesget
  • Metrics
    • Get metricsget
    • Get metric offsetsget

FEATURE APIs

  • Intro to Feature APIs

Service Management

  • Service Management - Introduction
  • Plans
    • Create planpost
    • Get owned plansget
    • Get planget
    • Update planpatch
    • Delete plandelete
    • Plan optionsget
    • Add document to planpost
    • Get plan documentsget
    • Remove document from plandelete
    • Download document from planget
    • Get publicationget
    • Create publicationpost
    • Update publicationpatch
    • Delete publicationdelete
    • Get overlayget
    • Create overlaypost
    • Update overlaypatch
    • Delete overlaydelete
    • Add document to overlaypost
    • Get overlay documentsget
    • Remove document from overlaydelete
    • Download document from overlayget
    • List planspost
    • Get associated plansget
    • Get recommended planget
    • Get overlayspost
    • Get allowed brandsget
  • Assignments
    • Get providersget
    • Get assignments for assetget
    • Get assignmentspost
    • List optionspost
    • Update assignmentspost
    • Assign providerspost
    • Unassign providerspost
    • List assignable recommendationspost
    • Assign recommended planpatch
    • Get service statusesget
    • List service statusespost
    • Get assets with service statusget
    • Batch update assignmentspost
    • Batch delete assignmentsdelete
    • Batch update providerpost
    • Provider asset visibilitypost
    • Provider plans statepost
  • Classic
    • Returns latest service time of latest service log per asset. Deprecated: returns only classic service logs.post
  • Registrations
    • Register servicespost
    • List registrationspost
    • List registrationspost
    • Download document from registrationget
  • Booking
    • Make bookingpost
    • Cancel bookingdelete
  • Networks
    • Create networkpost
    • Get owned networksget
    • Get networkget
    • Update networkpatch
    • Delete networkdelete
    • Get plans in networkget
    • Add/remove planspatch
    • Get providers in networkget
    • Add/remove providerspatch
    • Get associated networksget
  • Files
    • Uploads a file.post

Access Management

  • Access Management - Introduction
  • Asset setup
    • Get device configurationget
    • Configure access management modepost
    • Setup rolling PIN codepost
    • Get access management modeget
    • Setup access management.post
  • Rolling PIN code
    • Get rolling PIN codeget
  • Keys
    • Create keyspost
    • Get keysget
    • Create keypost
    • Delete keydelete
    • Get keyget
    • Update keypatch
    • Get key deployment statusget
    • Get key usage events.get

Operators

  • Operator Registry - Introduction
  • Invitations
    • Create invitationpost
  • Operators
    • Get operatorsget
    • Get operator licensesget
    • Create operatorpost
    • Delete operatordelete
    • Get operatorget
    • Update operatorpatch
  • Key administrator
    • Remove key administrator roledelete
    • Add key administrator roleput
  • Key Cards
    • Get key cardsget
    • Create new key cardpost
    • Delete key carddelete
    • Set a key card as primarypost
  • Licenses
    • Add license to the operatorpost
    • Delete a licensedelete
    • Update existing operator's licensepatch
  • Profile image
    • Delete profile imagedelete
    • Upload profile imagepost

Emissions

  • Emissions API - Introduction
  • Emissions Assets Monthly By Site
    • Get Assets By Site Monthlyget
    • Filter Assets By Site Monthlypost
    • Get Assets By Site Monthly Summaryget
    • Get Assets By Site Monthly Summarypost
  • Emissions Period V2
    • Get Periodget
    • Filter Periodpost
    • Get Period KPIsget
    • Filter Period KPIspost
  • Emissions Monthly V2
    • Get Monthlyget
    • Filter Monthlypost
    • Get Monthly Summaryget
    • Filter Monthly Summarypost
  • Emissions Lifetime V2
    • Get Lifetimeget
    • Filter Lifetimepost
    • Get Lifetime KPIsget
    • Filter Lifetime KPIspost
  • Emissions Daily V2
    • Get Dailyget
    • Filter Dailypost
    • Get Daily Summaryget
    • Filter Daily Summarypost
    • Get Daily KPIsget
    • Filter Daily KPIspost
  • Emissions Site V2
    • Get Site Emissions V2get

Compaction API

  • Compaction API - Introduction
  • Filter
    • Get Trip Filterget
    • Update Trip Filterput
    • Delete Trip Filterdelete
  • Searches
    • Create Saved Searchpost
    • Get All Saved Searchesget
    • Get Saved Searchget
    • Update Saved Searchput
    • Delete Saved Searchdelete
  • Trips
    • Get Compaction Tripget
    • Delete Compaction Tripdelete
    • Get Compaction Datapointsget
    • Get Summarized Compactionget
    • Get Compaction Tripspost

CONNECTOR APIs

  • Intro to Connector APIs
  • Marketplace Data Feeds

Rental API

  • Rental API - Introduction
  • ERP Integration Guide
  • ContractItems
    • Get Contract Itemsget
    • Get Contract Itemget
  • Contracts
    • Get Contractsget
    • Get Contractget
  • Synchronization
    • Synchronize rental datapost
    • Update contractpost
    • Update customerpost

Customer API

  • Customer API - Introduction
  • Customers
    • Get Customer Types Summaryget
    • Get Customersget
    • Create Customerpost
    • Delete Customerdelete
    • Get Customerget
    • Update Customerpatch
  • Contacts
    • Get Contactspost
    • Get Contactsget
    • Create Contactpost
    • Delete Contactdelete
    • Get Contactget
    • Update Contactpatch
  • Customer Portals
    • Provision Customer Portal Accesspost
    • Get Impersonated API Tokenget
  • Assets
    • Get Assetsget
    • Update Assetpatch

LEGACY APIs

  • Legacy Classic APIs

Emissions Period V2

➡️

OpenAPI Specification for the Emissions API domain

Get the OpenAPI Specification (formerly Swagger), which is a standardized format that describes the functionalities, endpoints, parameters, and data models of this API in a JSON file here.