Jump to Content
Home
IrisX
Iris API Reference
Changelog
App SDK
Design System
Webhooks
Marketplace
Log In
Iris API Reference
Log In
Home
IrisX
Iris API Reference
Changelog
App SDK
Design System
Webhooks
Marketplace
Alert API - Introduction
All
Pages
Start typing to search…
JUMP TO
GETTING STARTED
Iris APIs Overview
Access Token
Product Spotlight: Iris APIs
API Tokens v2
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 API introduction
Accounts
Get my account
get
Get accounts
get
Create account
post
Delete account
del
Get account by id
get
Update account
put
Get hierarchy
get
Account Connections
Connections
Add a connection to the account.
post
Remove the connection from the account.
del
Get the connection from the account by connected account ID.
get
Users
Get Users
get
Roles
Get Roles
get
Flows
Activate User
post
Request Password Reset
post
Reset Password
post
Queries
Query Users by Identifiers
post
Delete User
del
Export users
get
Create User
post
Get User
get
Update User
patch
ASSET ADMINISTRATION
Intro to Asset Administration
Assets
Assets API - Introduction
Get asset
get
Get assets
get
Query assets by given identifiers
post
Fetch multiple asset notes
post
Create assets
post
Update asset
patch
Update asset note by given identifier
patch
Hide/unhide assets
patch
Attach telematics device
post
Delete asset
del
v2beta1
Get assets
get
Create assets
post
Hide/unhide assets
patch
Update asset note by given identifier
patch
Fetch multiple asset notes
post
Onboard asset
post
Query assets by given identifiers
post
Delete asset
del
Offboard asset
post
Attach telematics device
post
Get asset
get
Update asset
patch
v1.0
Get assets
get
Create assets
post
Onboard asset
post
Delete asset
del
Get asset
get
Update asset
patch
Offboard asset
post
Attach telematics device
post
Ownership & Visibility
Ownership & Visibility - Introduction
Remove visibility
post
Share assets
post
Transfer assets
post
Unshare assets
post
List asset shares
get
Machines
Machine metadata
Get machine brands
get
Get machine categories
get
Get machine models
get
Get machines
get
Get machines summary
get
Query machines
post
Get machine
get
Get machine extended information
get
Get Service Documents
get
Get Service Document
get
Download Service Document
get
Machine APIs - Introduction
Update machine
put
Update machine extended information
put
Machine Onboarding
Create Machine Onboarding Request
post
Machine Onboarding Events
Get Onboarding Events
get
Groups
Group Asset Relations
Remove Assets from Group
del
Remove Asset from Groups
del
Get Assets in Group
get
Add Asset to Groups
post
Add Assets to Group
post
Replace Assets in Group
put
Group User Relations
Remove Users from Group
del
Get Users in Group
get
Add Users to Group
post
Replace Users in Group
put
Remove User from Groups
del
Add User to Groups
post
Get Groups
get
Delete Group
del
Create Group
post
Get Group
get
Update Group
patch
Sites API
Get Sites
get
SiteImage
Get list of all images for a site
get
Upload a new image for a site
post
Delete site image
del
SiteInsights
Get Sites Insights
get
Get Sites Insights
post
Get Site Insight
get
SitesKPIs
Get Sites KPIs
get
Delete Site
del
SiteHistory
Get Site History
get
SiteAssets
Get Sites An Asset Is On
post
Get On-Site Assets
post
SiteUsers
Get Site Users
get
Update Site Users
patch
Sites API - Introduction
Create Site
post
SiteContacts
Get Site Contacts
get
Create Site Contact
post
Delete Site Contact
del
Update Site Contact
patch
Manage owning depots
Get Owned Assets
get
Remove Owning Depot from Asset
del
Assign Owning Depot to Asset
post
SiteIntervals
Get Site Intervals
get
SiteSuggestions
Get Site Suggestions
post
Get Site Suggestion
get
Get Site
get
Update Site
patch
Custom Fields API
Custom Fields API - Introduction
Definitions
Get Definition
get
Get Definitions
get
Create Definition
post
Delete Definition
del
Get Definition
get
Update Definition
patch
Values
Set custom field values
post
Get Values
get
Create Value
post
Delete Value
del
Update Value
patch
CONFIGURATION
Intro to Configuration
Telematics Device
Telematics Device API - Introduction
Configuration Job
Get all configuration jobs
get
Create a New Configuration Job
post
Get configuration job
get
Get Configuration Job Status
get
Get device statuses for a configuration job
get
Devices identity
Get devices filtered by serial number
get
Get device identity
get
Get device identity of a Trackunit device by serial number
get
Devices state
Get device state
get
Update desired state
patch
Get desired state documentation
get
Devices telemetry
Get Device Telemetry
get
Alerts
Alert API - Introduction
Alert configuration
Get all alert configurations
get
Configure an alert
post
/v1/configurations/unitOfMeasurement
get
/v1/configurations/aoa/datatype
get
Delete an alert configuration
del
Get a specific alert configuration
get
Update a specific alert configuration
patch
TELEMATICS FOUNDATION
Intro to Telematics Foundation
Locations
Location API - Introduction
Get locations
get
Get location
get
CAN Faults API
CAN Faults API - Introduction
Faults
Get faults
post
Faults Summary
Get faults summary
post
Simulated Faults
Get simulatable faults
get
Get simulated faults
get
Resolve simulated fault
post
Send simulated fault
post
Get simulated faults summary
get
Unit Active Faults
Get unit active faults
get
Get unit active faults
post
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 snapshot
get
Single-element snapshot
get
time-series
Machine insights
get
Peak daily speed
get
Location
get
Fuel used within the past 24 hours.
get
Fuel Remaining Ratio
get
Diagnostic codes
get
Engine condition
get
Cumulative distance travelled.
get
Percent of DEF remaining
get
Cumulative power take-off hours
get
Cumulative payload total
get
Cumulative operating hours
get
Cumulative idle non-operating hours
get
Cumulative load count
get
Cumulative idle hours
get
Cumulative fuel used.
get
Cumulative non-productive regeneration hours
get
Average daily engine load factor
get
Time Series API
Time Series API - Introduction
Time Series API - Usage guide
Advanced Querying
Instant Query
get
Instant Query
post
Range Query
get
Range Query
post
List label names
get
List label names
post
List times series
get
List times series
post
List label values
get
Metrics
Get metrics
get
Get metric offsets
get
FEATURE APIs
Intro to Feature APIs
Service Management
Service Management - Introduction
Plans
Create plan
post
Get owned plans
get
Get plan
get
Update plan
patch
Delete plan
del
Plan options
get
Add document to plan
post
Get plan documents
get
Remove document from plan
del
Download document from plan
get
Get publication
get
Create publication
post
Update publication
patch
Delete publication
del
Get overlay
get
Create overlay
post
Update overlay
patch
Delete overlay
del
Add document to overlay
post
Get overlay documents
get
Remove document from overlay
del
Download document from overlay
get
List plans
post
Get associated plans
get
Get recommended plan
get
Get overlays
post
Get allowed brands
get
Assignments
Get providers
get
Get assignments for asset
get
Get assignments
post
List options
post
Update assignments
post
Assign providers
post
Unassign providers
post
List assignable recommendations
post
Assign recommended plan
patch
Get service statuses
get
List service statuses
post
Get assets with service status
get
Batch update assignments
post
Batch delete assignments
del
Batch update provider
post
Provider asset visibility
post
Provider plans state
post
Classic
Returns latest service time of latest service log per asset. Deprecated: returns only classic service logs.
post
Registrations
Register services
post
List registrations
post
List registrations
post
Download document from registration
get
Booking
Make booking
post
Cancel booking
del
Networks
Create network
post
Get owned networks
get
Get network
get
Update network
patch
Delete network
del
Get plans in network
get
Add/remove plans
patch
Get providers in network
get
Add/remove providers
patch
Get associated networks
get
Files
Uploads a file.
post
Access Management
Access Management - Introduction
Asset setup
Get device configuration
get
Configure access management mode
post
Setup rolling PIN code
post
Get access management mode
get
Setup access management.
post
Rolling PIN code
Get rolling PIN code
get
Keys
Create keys
post
Get keys
get
Create key
post
Delete key
del
Get key
get
Update key
patch
Get key deployment status
get
Get key usage events.
get
Operators
Operator Registry - Introduction
Invitations
Create invitation
post
Operators
Get operators
get
Get operator licenses
get
Create operator
post
Delete operator
del
Get operator
get
Update operator
patch
Key administrator
Remove key administrator role
del
Add key administrator role
put
Key Cards
Get key cards
get
Create new key card
post
Delete key card
del
Set a key card as primary
post
Licenses
Add license to the operator
post
Delete a license
del
Update existing operator's license
patch
Profile image
Delete profile image
del
Upload profile image
post
Emissions
Emissions API - Introduction
Emissions Assets Monthly By Site
Get Assets By Site Monthly
get
Filter Assets By Site Monthly
post
Get Assets By Site Monthly Summary
get
Get Assets By Site Monthly Summary
post
Emissions Period V2
Get Period
get
Filter Period
post
Get Period KPIs
get
Filter Period KPIs
post
Emissions Monthly V2
Get Monthly
get
Filter Monthly
post
Get Monthly Summary
get
Filter Monthly Summary
post
Emissions Lifetime V2
Get Lifetime
get
Filter Lifetime
post
Get Lifetime KPIs
get
Filter Lifetime KPIs
post
Emissions Daily V2
Get Daily
get
Filter Daily
post
Get Daily Summary
get
Filter Daily Summary
post
Get Daily KPIs
get
Filter Daily KPIs
post
Emissions Site V2
Get Site Emissions V2
get
Emissions Assets KPIs by Site
Get Site Period KPIs
get
Filter Site Period KPIs
post
Emissions Total KPIs by Site
Get Site KPIs Emissions
get
Compaction API
Compaction API - Introduction
Filter
Get Trip Filter
get
Update Trip Filter
put
Delete Trip Filter
del
Searches
Create Saved Search
post
Get All Saved Searches
get
Get Saved Search
get
Update Saved Search
put
Delete Saved Search
del
Trips
Get Compaction Trip
get
Delete Compaction Trip
del
Get Compaction Datapoints
get
Get Summarized Compaction
get
Get Compaction Trips
post
CONNECTOR APIs
Intro to Connector APIs
Marketplace Data Feeds
Data Ingestion
Data Ingest API - Introduction
Assets v1beta1
Assets data ingest
post
Devices v1beta1
Telematics devices data ingest
post
Assets v1beta2
Assets data ingest
post
Get ingestion status
get
Get asset ingestions history
get
Rental API
Rental API - Introduction
ERP Integration Guide
ContractItems
Get Contract Items
get
Get Contract Item
get
Contracts
Get Contracts
get
Get Contract
get
Synchronization
Synchronize rental data
post
Update contract
post
Update customer
post
Customer API
Customer API - Introduction
Customers
Get Customer Types Summary
get
Get Customers
get
Create Customer
post
Delete Customer
del
Get Customer
get
Update Customer
patch
Contacts
Get Contacts
post
Get Contacts
get
Create Contact
post
Delete Contact
del
Get Contact
get
Update Contact
patch
Customer Portals
Provision Customer Portal Access
post
Get Impersonated API Token
get
Update Customer Portal
patch
Update Customer Portal by Customer External Reference
patch
Create Customer Portal for Customer by External Reference
post
Update Customer Portal for Customer
patch
Create Customer Portal for Customer
post
Assets
Get Assets
get
Update Asset
patch
Customer Portal Templates
Assign/Unassign Customer Portals to Template
patch
LEGACY APIs
Legacy Classic APIs
Bluetooth tag configuration
Bluetooth Tag Configuration API - Introduction
KIN Challenge
Sign KIN Challenge
post
Utilization Profiles
Search Utilization Profiles
post
Get Utilization Profile
get
Acknowledge Desired Utilization Profile
put
Acknowledge Reported Utilization Profile
put
Asset Event API
Asset Event API - Introduction
Asset Event API
Get asset events
post
Get active asset events
post
Databricks PostgREST Connector API
Table Data
Get table data from Databricks Sync Table
get
Alert API - Introduction
Ask AI
