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
Provision Customer Portal Access
Search
JUMP TO
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 API introduction
Accounts
Get my account
get
Get accounts
get
Create account
post
Delete account
delete
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.
delete
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
delete
Export users
get
Create User
post
Get User
get
Update User
patch
ASSET ADMINISTRATION
Intro to Asset Administration
Assets
Assets API - Introduction
Get assets
get
v1.0
Get assets
get
Create assets
post
Onboard asset
post
Delete asset
delete
Get asset
get
Update asset
patch
Offboard asset
post
Attach telematics device
post
Create assets
post
Onboard asset
post
Delete asset
delete
Offboard asset
post
Attach telematics device
post
Query assets by given identifiers
post
Hide/unhide assets
patch
Update asset note by given identifier
patch
Fetch multiple asset notes
post
Get asset
get
Update asset
patch
Ownership & Visibility
Remove visibility
post
Share assets
post
Transfer assets
post
Unshare assets
post
List asset shares
get
Ownership & Visibility - Introduction
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
delete
Get Assets in Group
get
Add Assets to Group
post
Replace Assets in Group
put
Group User Relations
Remove Users from Group
delete
Get Users in Group
get
Add Users to Group
post
Replace Users in Group
put
Get Groups
get
Delete Group
delete
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
delete
SiteInsights
Get Sites Insights
get
Get Sites Insights
post
Get Site Insight
get
Delete Site
delete
SitesKPIs
Get Sites KPIs
get
SiteHistory
Get Site History
get
Sites API - Introduction
Create Site
post
SiteAssets
Get Sites An Asset Is On
post
Get On-Site Assets
post
SiteUsers
Get Site Users
get
Update Site Users
patch
Get Site
get
SiteContacts
Get Site Contacts
get
Create Site Contact
post
Delete Site Contact
delete
Update Site Contact
patch
Manage owning depots
Get Owned Assets
get
Remove Owning Depot from Asset
delete
Assign Owning Depot to Asset
post
SiteIntervals
Get Site Intervals
get
SiteSuggestions
Get Site Suggestions
post
Get Site Suggestion
get
Update Site
patch
Custom Fields API
Custom Fields API - Introduction
Definitions
Get Definition
get
Get Definitions
get
Create Definition
post
Delete Definition
delete
Get Definition
get
Update Definition
patch
Values
Set custom field values
post
Get Values
get
Create Value
post
Delete Value
delete
Update Value
patch
CONFIGURATION
Intro to Configuration
Telematics Device
Telematics Device API - Introduction
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
Delete an alert configuration
delete
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
delete
Plan options
get
Add document to plan
post
Get plan documents
get
Remove document from plan
delete
Download document from plan
get
Get publication
get
Create publication
post
Update publication
patch
Delete publication
delete
Get overlay
get
Create overlay
post
Update overlay
patch
Delete overlay
delete
Add document to overlay
post
Get overlay documents
get
Remove document from overlay
delete
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
delete
Batch update provider
post
Provider asset visibility
post
Provider plans state
post
