Jump to Content
Home
Guides
API Reference
Home
Guides
API Reference
v3.0
Home
Guides
API Reference
Status Page
Help Centre
Perspio Portal
API Reference
Status Page
Help Centre
Perspio Portal
v3.0
Home
Guides
API Reference
Rate Limiting & Quotas
All
Pages
Start typing to search…
JUMP TO
Getting Started
Perspio Developer Hub
Quickstart
Postman Collection
OpenAPI Spec
SDK (API Clients)
Authentication
Create Application
Create User
Get Access Token - Client Credentials
Get Access Token - Authorization Code
Use Access Token
Refresh Access Token
REST API Overview
Base URL
Request Methods
Response Codes
Rate Limiting & Quotas
Roles and Security Groups
Date and Time Format
IP Addresses & Whitelisting
Object IDs
Assets
Get Asset
get
Get Assets
get
Create Asset
post
Update Asset
post
Patch Asset
patch
Delete Asset
del
Archive Asset
post
Enable Asset
post
Details
Get Asset Info
get
Get Assets Info
get
Update Asset Info
patch
Create Asset Share Link
post
Get Asset Tenant Hierarchies
get
Get Asset Master Schema
get
Update Asset Master Schema
patch
Get Asset Type
get
Get Asset Types
get
Get Asset Schema
get
Get Asset Type Schema
get
Get Asset Groups
get
Update Asset Groups
put
Get Asset Rental History
get
Get Asset Servicing History
get
Get Asset Workflow History
get
Create Asset Share
post
Get Asset Share Tokens
get
Update Asset Share Token
put
Get Asset Relationships
get
Get Asset Cameras
get
Get Asset Camera Snapshot
get
Get Asset Property Dependencies
get
Get Asset Dependencies
get
Telemetry
Get Asset Metrics
get
Get Asset Metrics Summary
get
Get Asset Events
get
Get Asset Events Master
get
Bulk Update Asset Events Master
post
Update Asset Events Master
patch
Get Asset Recent Events
get
Update Asset Meters
patch
Get Asset History
get
Get Asset Custom Counters
get
Update Custom Counters
patch
Get Asset Anomalies
get
Get Asset Forecast
get
Get Asset Trips
get
Get Latest Asset Trips
get
Get Asset Trips
get
Gets Asset Meters Utilisation
get
Get Asset Utilisation Average
get
Get Asset Utilisation Summary
get
Get Asset Latency Data
get
Get Asset Metrics Count
get
Documents
Get Asset Documents
get
Upload Asset Document
post
Update Asset Document Metadata
put
Delete Asset Document
del
Get Asset Images
get
Upload Asset Image
post
Update Asset Image Metadata
put
Delete Asset Image
del
Get Asset Comments
get
Add Asset Comment
post
Get Asset Links
get
Upload Asset Document Link
post
Update Asset Document Link
put
Delete Asset Document Links
del
Servicing
Get Asset Servicing Info
get
Get Asset Service Entries
get
Get Asset Service Programs
get
Get Asset Service Reminders
get
Profiles
Update Asset Share Config
put
Get Asset Share Config
get
Get Asset Work Hour Profile
get
Update Asset Work Hour Profile
patch
Get Asset Share Configs
get
Get Assets Share Config
get
Create Asset Share Config
post
Delete Asset Share Config
del
Socket
Negotiate Socket Connection
post
Get Asset Share Config by ID
get
Jobs
Create Asset Update Job
post
Create Asset Import Job
post
Data Explorer
Fetch and explore system object data
get
Apps
Get App
get
Get Apps
get
Create App
post
Delete App
del
App Management
Get App Subscription Key
get
Get App Users
get
Reset App Secret
post
Connectors
Get Ingress Connectors
get
Get Action Connectors
get
Get Action Quotas
get
Get Action Schema
get
Get Action Schema Template
get
Get Data Connectors
get
Get Webhooks Connector
get
Checkpoints
Get Ingress Connector Checkpoints
get
Get Data Connector Checkpoints
get
Safety Culture
Get Safety Culture Groups
get
Get Safety Culture Users
get
Get Safety Culture Assets
get
Management
Get Ingress Connector History
get
Get Action Connector History
get
Get Data Connector History
get
Get Webhook Connector History
get
Get Connector Events
get
Enable Connector
post
Disable Connector
post
Get Connector Configuration
get
Update Connector Configuration
post
Socket
Negotiate Socket Connection
post
Dashboards
Get Dashboard
get
Get Dashboards
get
Create Dashboard
post
Update Dashboard
put
Delete Dashboard
del
Get Dashboard Data
get
Get Dashboard Assets
get
Get Dashboard Dictionaries
get
Widgets
Get Dashboard Widget
get
Get Dashboard Widget Data
get
Images
Get Dashboard Images
get
Upload Dashboard Image
post
Delete Dashboard Images
del
Devices
Get Device
get
Get Devices
get
Update Device
patch
Get Device Types
get
Get Device History
get
Trips
Events
Telemetry
Get Device Metrics
get
Get Device Updates Count
get
Metadata
Get Device Metadata
get
Get Device Info
get
Geofences
Get Geofence
get
Get Geofences
get
Create Geofence
post
Update Geofence
put
Delete Geofence
del
Get Geofence Assets
get
Get Geofence Asset Groups
get
Update Geofence Asset Group
patch
Toll
Get Toll Geofence
get
Get Toll Geofences
get
Events
Get Geofence Events
get
Get Toll Geofence Events
get
Regions
Get Region Geofences
get
Weather Alerts
Get Weather Alert Geofences
get
Zones
Get Zone Library Geofences
get
Groups
Get Asset Group
get
Get Asset Groups
get
Create Asset Group
post
Copy Asset Group
post
Update Asset Group
put
Delete Asset Group
del
Membership
Get Group Membership Changes
get
Get Group Members
get
Update Group Members
put
Organisation
Get Invoices
get
Get System Jobs
get
Get Tenant Inventory
get
Get Tenant Consumption
get
Get Tenant Actions Consumption
get
Banners
Get Notifications
get
Get Notification
get
Config
Get Tenant Config
get
Update Tenant Config
patch
Info
Get Tenant Info
get
Update Tenant Info
patch
Logo
Get Tenant Logo Image
get
Get Tenant Logo Images
get
Upload Tenant Logo
post
Delete Tenant Logo Images
del
Reference Data
Get Entity Types
get
Get All Entity Schemas
get
Get Entity Schema
get
Get Entity Data
get
Create Entity Data
post
Bulk update entity data
put
Bulk delete entity data
del
Update specific entity
put
Delete specific entity
del
App Information
Get App Versions
get
Get App Changelog
get
People
Get Driver
get
Get Drivers
get
Profiles
Custom Counters
Get Custom Counters
get
Create Custom Counter
post
Get Custom Counter
get
Update Custom Counter
put
Delete Custom Counter
del
Working Hours
Get Working Hours Profiles
get
Create Working Hours Profile
post
Get Working Hours Profile
get
Update Working Hours Profile
put
Delete Working Hours Profile
del
Share Details
Get Details Sharing Profiles
get
Create Details Sharing Profile
post
Get Details Sharing Profile
get
Update Details Sharing Profile
put
Delete Details Sharing Profile
del
User Profiles
Get User Profiles
get
Create User Profile
post
Get User Profile
get
Update User Profile
patch
Delete User Profile
del
Asset Marker Profiles
Get Asset Marker Profiles
get
Create Asset Marker Profile
post
Get Asset Marker Profile
get
Update Asset Marker Profile
patch
Delete Asset Marker Profile
del
Public
Get Shared Assets
get
Reports
Get Report
get
Get Reports
get
Create Report
post
Update Report
put
Delete Report
del
Scheduled Reports
Get Report Schedules
get
Create Report Schedule
post
Get Report Schedule
get
Update Report Schedule
put
Delete Report Schedule
del
Get Tenant Scheduled Reports
get
Saved Reports
Get Saved Reports
get
Get Saved Report
get
Other
Get Report Schema
get
Get Report Data
get
Get Report Dictionaries
get
Get Report History
get
Create Report Data Job
post
Search
Global Search
get
Get Assets In Proximity
get
Get Object Dependency
get
Save
Get Saved Searches
get
Save Search
post
Delete Saved Search
del
Servicing
Schedules
Get Service Schedules
get
Create Service Schedule
post
Update Service Schedule
patch
Delete Service Schedule
del
Programs
Get Service Program
get
Update Service Program
patch
Delete Service Program
del
Get Service Programs
get
Create Service Program
post
Get Service Program Assets
get
Update Service Program Assets
put
Update Service Program Schedules
put
Reminders
Get Service Reminder
get
Get Service Reminders
get
Entries
Get Service Entry
get
Delete Service Entry
del
Update Service Entry
put
Get Service Entries
get
Create Service Entry
post
Tasks
Get Task
get
Get Tasks
get
Create Task
post
Users
Get Users
get
Create User
post
Update User
patch
Delete User
del
Get Group Users
get
Get Users Extensions
get
Current User
Get Current User
get
Update Current User
patch
Update Current User Extension
patch
Add Current User Extension
post
Get Current User's Extensions
get
Get Current User Access
get
Get Current User Logs
get
User Management
Enable User
post
Disable User
post
Resend Welcome Email
post
Create User Job
post
Create Support Ticket
post
Data Access
Get User Data Access
get
Update User Data Access
post
User Access
Get User Access
get
Update User Access
post
Access Profile
Get User Access Profiles
get
Get User Access Profile
get
User Preferences
Get Users Preferences
get
Get User Preferences
get
Update User Preferences
patch
User Logs
Get User Logs
get
Create User Log
post
Workflows
Get Workflow
get
Get Workflows
get
Update Workflow
post
Delete Workflow
del
Workflow Helpers
Get Assets
get
Get Data Schema From workflow Scope
post
Get Metadata
get
Get Event Types
get
Get Workflow Scope Assets
post
Get Groups
get
Get Workflow Trigger History
get
Get Workflow History Metrics Count
get
Workflow Management
Copy Workflow
post
Workflow Manual Trigger
post
Checkpoints
Get Workflow Checkpoints
get
Unsuppress Workflow Object Checkpoint
post
Unsuppress Workflow Checkpoint
post
WorkOrders
Service Jobs
Get Service Job
get
Get Service Jobs
get
Transport Dockets
Get Transport Dockets
get
Transport Docket Lines
Get Transport Docket Lines
get
Powered by
Rate Limiting & Quotas
Ask AI
