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.0Home Guides API Reference

Getting Started

Perspio Developer Hub
Quickstart
Authentication
REST API Overview

Assets

Create Assetpost
Get Assetsget
Get Assetget
Update Assetpatch
Delete Assetdelete
Telemetry
Asset Details
Documents, Links & Images
Asset Profiles
Servicing

Apps

Create Apppost
Get Appsget
Get Appget
Delete Appdelete
App Management

Connectors

Get Ingress Connectorsget
Get Action Connectorsget
Get Data Connectorsget
Get Webhooks Connectorget
Update Connector Configurationpost
Enable Connectorpost
Disable Connectorpost
History
Events
- Negotiate Socket Connectionpost
- Get Connector Eventsget
Checkpoints
- Get Ingress Connector Checkpointsget
- Get Data Connector Checkpointsget
Safety Culture

Dashboards

Create Dashboardpost
Get Dashboardsget
Get Dashboardget
Get Dashboard Dictionariesget
Get Dashboard Assetsget
Get Dashboard Dataget
Update Dashboardput
Delete Dashboarddelete
Widgets
- Get Dashboard Widgetget
- Get Dashboard Widget Dataget
Images

Devices

Get All Device Typesget
Get Device Typesget
Get All Device Types 2get
Get Device Types 2get
Trips
Events
Management
- Get Access Pinget
- Immobilisepost
Telemetry
Schema
Metadata

Geofences

Create Geofencepost
Get Geofencesget
Get Geofenceget
Get Geofence Asset Groupsget
Get Geofence Assetsget
Get all Region Geofencesget
Get all Weather Alert Geofencesget
Update Geofenceput
Update Geofence Asset Grouppatch
Delete Geofencedelete
Geofence
GeoJson Geofence
Toll
- Get Toll Geofenceget
- Get Toll Geofencesget
Events
- Get Geofence Eventsget
- Get Toll Geofence Eventsget

Groups

Create Asset Grouppost
Copy Asset Grouppost
Get Asset Groupsget
Get Asset Groupget
Update Asset Groupput
Delete Asset Groupdelete
Membership

Organisation

Get Invoicesget
Get Tenant Inventoryget
Get System Jobsget
Get Tenant Actions Consumptionget
Get Tenant Consumptionget
Banners
- Get Notificationsget
- Get Notificationget
Config
- Get Tenant Configget
- Update Tenant Configpatch
Info
- Get Tenant Infoget
- Update Tenant Infopatch
Logo

People

Get All Driversget
Get Driverget

Profiles

Custom Counters
Working Hours
Share Details

Public

Get Shared Assetsget

Reports

Create Reportpost
Submit Get Report Data Taskpost
Get Report Schemaget
Get Report Historyget
Get Report Dictionariesget
Get Reportsget
Get Report Dataget
Get Reportget
Update Reportput
Delete Reportdelete
Scheduled Reports
Saved Reports
- Get Saved Reportsget
- Get Saved Report Fileget

Search

Save Searchpost
Get Assets In Proximityget
Get Object Dependencyget
Global Searchget
Get Saved Searchesget
Delete Saved Searchdelete

Servicing

Schedules
Programs
Reminders
- Get Service Remindersget
- Get Service Reminderget
Entries

Tasks

Create Taskpost
Get Tasksget
Get Taskget

Users

Create Userpost
Create User Logpost
Get Usersget
Get User Logsget
Get Data Access For Userget
Get Group Usersget
Get User Accessget
Get User Access Profilesget
Get User Access Profileget
Get Users Extensionsget
Get Users Preferencesget
Get User Preferencesget
Update Userpatch
Update User Preferencespatch
Update Data Access For Userpost
Submit Create User Taskpost
Update User Accesspost
Delete Userdelete
Current User

Workflows

Get Workflowsget
Get Workflowget
Get Workflow Checkpointsget
Update Workflowpost
Copy Workflowpost
Unsuppress Checkpointpost
Unsuppress checkpointpost
Delete Workflowdelete
Workflow Helpers

WorkOrders

Service Jobs
- Get Service Jobsget
- Get Service Jobget
Transport Dockets
- Get Transport Docketsget
Transport Docket Lines
- Get Transport Docket Linesget

Powered by

Getting Started

Perspio Developer Hub
Quickstart
Authentication
REST API Overview

Assets

Create Assetpost
Get Assetsget
Get Assetget
Update Assetpatch
Delete Assetdelete
Telemetry
Asset Details
Documents, Links & Images
Asset Profiles
Servicing

Apps

Create Apppost
Get Appsget
Get Appget
Delete Appdelete
App Management

Connectors

Get Ingress Connectorsget
Get Action Connectorsget
Get Data Connectorsget
Get Webhooks Connectorget
Update Connector Configurationpost
Enable Connectorpost
Disable Connectorpost
History
Events
- Negotiate Socket Connectionpost
- Get Connector Eventsget
Checkpoints
- Get Ingress Connector Checkpointsget
- Get Data Connector Checkpointsget
Safety Culture

Dashboards

Create Dashboardpost
Get Dashboardsget
Get Dashboardget
Get Dashboard Dictionariesget
Get Dashboard Assetsget
Get Dashboard Dataget
Update Dashboardput
Delete Dashboarddelete
Widgets
- Get Dashboard Widgetget
- Get Dashboard Widget Dataget
Images

Devices

Get All Device Typesget
Get Device Typesget
Get All Device Types 2get
Get Device Types 2get
Trips
Events
Management
- Get Access Pinget
- Immobilisepost
Telemetry
Schema
Metadata

Geofences

Create Geofencepost
Get Geofencesget
Get Geofenceget
Get Geofence Asset Groupsget
Get Geofence Assetsget
Get all Region Geofencesget
Get all Weather Alert Geofencesget
Update Geofenceput
Update Geofence Asset Grouppatch
Delete Geofencedelete
Geofence
GeoJson Geofence
Toll
- Get Toll Geofenceget
- Get Toll Geofencesget
Events
- Get Geofence Eventsget
- Get Toll Geofence Eventsget

Groups

Create Asset Grouppost
Copy Asset Grouppost
Get Asset Groupsget
Get Asset Groupget
Update Asset Groupput
Delete Asset Groupdelete
Membership

Organisation

Get Invoicesget
Get Tenant Inventoryget
Get System Jobsget
Get Tenant Actions Consumptionget
Get Tenant Consumptionget
Banners
- Get Notificationsget
- Get Notificationget
Config
- Get Tenant Configget
- Update Tenant Configpatch
Info
- Get Tenant Infoget
- Update Tenant Infopatch
Logo

People

Get All Driversget
Get Driverget

Profiles

Custom Counters
Working Hours
Share Details

Public

Get Shared Assetsget

Reports

Create Reportpost
Submit Get Report Data Taskpost
Get Report Schemaget
Get Report Historyget
Get Report Dictionariesget
Get Reportsget
Get Report Dataget
Get Reportget
Update Reportput
Delete Reportdelete
Scheduled Reports
Saved Reports
- Get Saved Reportsget
- Get Saved Report Fileget

Search

Save Searchpost
Get Assets In Proximityget
Get Object Dependencyget
Global Searchget
Get Saved Searchesget
Delete Saved Searchdelete

Servicing

Schedules
Programs
Reminders
- Get Service Remindersget
- Get Service Reminderget
Entries

Tasks

Create Taskpost
Get Tasksget
Get Taskget

Users

Create Userpost
Create User Logpost
Get Usersget
Get User Logsget
Get Data Access For Userget
Get Group Usersget
Get User Accessget
Get User Access Profilesget
Get User Access Profileget
Get Users Extensionsget
Get Users Preferencesget
Get User Preferencesget
Update Userpatch
Update User Preferencespatch
Update Data Access For Userpost
Submit Create User Taskpost
Update User Accesspost
Delete Userdelete
Current User

Workflows

Get Workflowsget
Get Workflowget
Get Workflow Checkpointsget
Update Workflowpost
Copy Workflowpost
Unsuppress Checkpointpost
Unsuppress checkpointpost
Delete Workflowdelete
Workflow Helpers

WorkOrders

Service Jobs
- Get Service Jobsget
- Get Service Jobget
Transport Dockets
- Get Transport Docketsget
Transport Docket Lines
- Get Transport Docket Linesget

Powered by

Get Device Metadata

get https://talk.perspio.io/devices/v3/{id}/metadata

Get Device Info With Metadata

Language

Credentials

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