Jump to Content

Home IrisX Iris API Reference Changelog App SDK Design System Webhooks Marketplace

Iris API Reference

Home IrisX Iris API Reference Changelog App SDK Design System Webhooks Marketplace

All

Pages

Start typing to search…

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

Account Connections

Connections

Users

Get Usersget
Roles
- Get Rolesget
Flows
Queries
- Query Users by Identifierspost
Delete Userdel
Export usersget
Create Userpost
Get Userget
Update Userpatch

ASSET ADMINISTRATION

Intro to Asset Administration

Assets

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

Ownership & Visibility

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

Machines

Machine metadata
Get machinesget
Get machines summaryget
Query machinespost
Get machineget
Get machine extended informationget
Get Service Documentsget
Get Service Documentget
Download Service Documentget
Machine APIs - Introduction
Update machineput
Update machine extended informationput

Machine Onboarding

Create Machine Onboarding Requestpost

Machine Onboarding Events

Get Onboarding Eventsget

Groups

Group Asset Relations
Group User Relations
Get Groupsget
Delete Groupdel
Create Grouppost
Get Groupget
Update Grouppatch

Sites API

Get Sitesget
SiteImage
SiteInsights
SitesKPIs
- Get Sites KPIsget
Delete Sitedel
SiteHistory
- Get Site Historyget
SiteAssets
- Get Sites An Asset Is Onpost
- Get On-Site Assetspost
SiteUsers
- Get Site Usersget
- Update Site Userspatch
Sites API - Introduction
Create Sitepost
SiteContacts
Manage owning depots
SiteIntervals
- Get Site Intervalsget
SiteSuggestions
- Get Site Suggestionspost
- Get Site Suggestionget
Get Siteget
Update Sitepatch

Custom Fields API

Custom Fields API - Introduction
Definitions
Values

CONFIGURATION

Intro to Configuration

Telematics Device

Telematics Device API - Introduction
Devices identity
Devices state
Devices telemetry
- Get device telemetryget

Alerts

Alert API - Introduction
Alert configuration

TELEMATICS FOUNDATION

Intro to Telematics Foundation

Locations

Location API - Introduction
Get locationsget
Get locationget

CAN Faults API

CAN Faults API - Introduction
Faults
- Get faultspost
Faults Summary
- Get faults summarypost
Simulated Faults
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

Time Series API

Time Series API - Introduction
Time Series API - Usage guide
Advanced Querying
Metrics
- Get metricsget
- Get metric offsetsget

FEATURE APIs

Intro to Feature APIs

Service Management

Service Management - Introduction
Plans
Assignments
Classic
- Returns latest service time of latest service log per asset. Deprecated: returns only classic service logs.post
Registrations
Booking
- Make bookingpost
- Cancel bookingdel
Networks
Files
- Uploads a file.post

Access Management

Access Management - Introduction
Asset setup
Rolling PIN code
- Get rolling PIN codeget
Keys

Operators

Operator Registry - Introduction
Invitations
- Create invitationpost
Operators
Key administrator
- Remove key administrator roledel
- Add key administrator roleput
Key Cards
Licenses
Profile image
- Delete profile imagedel
- Upload profile imagepost

Emissions

Emissions API - Introduction
Emissions Assets Monthly By Site
Emissions Period V2
Emissions Monthly V2
Emissions Lifetime V2
Emissions Daily V2
Emissions Site V2
- Get Site Emissions V2get
Emissions Assets KPIs by Site
- Get Site Period KPIsget
- Filter Site Period KPIspost
Emissions Total KPIs by Site
- Get Site KPIs Emissionsget

Compaction API

Compaction API - Introduction
Filter
Searches
Trips

CONNECTOR APIs

Intro to Connector APIs
Marketplace Data Feeds

Data Ingestion

Data Ingest API - Introduction
Assets v1beta1
- Assets data ingestpost
Devices v1beta1
- Telematics devices data ingestpost
Assets v1beta2

Rental API

Rental API - Introduction
ERP Integration Guide
ContractItems
- Get Contract Itemsget
- Get Contract Itemget
Contracts
- Get Contractsget
- Get Contractget
Synchronization

Customer API

Customer API - Introduction
Customers
Contacts
Customer Portals
- Provision Customer Portal Accesspost
- Get Impersonated API Tokenget
Assets
- Get Assetsget
- Update Assetpatch
Customer Portal Templates
- Assign/Unassign Customer Portals to Templatepatch

LEGACY APIs

Legacy Classic APIs

Bluetooth tag configuration

Bluetooth Tag Configuration API - Introduction
KIN Challenge
- Sign KIN Challengepost
Utilization Profiles

Asset Event API

Asset Event API - Introduction
Asset Event API
- Get asset eventspost
- Get active asset eventspost

Databricks PostgREST Connector API

Table Data
- Get table data from Databricks Sync Tableget

Add/remove plans

patch

https://iris.trackunit.com/api/service-management/v2/networks/{serviceNetworkId}/plans

Language

Credentials

Bearer

JWT

Click Try It! to start a request and see the response here!