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

All

Pages

Start typing to search…

Getting Started

Perspio Developer Hub
Quickstart
Authentication
REST API Overview

Assets

Get Assetget
Get Assetsget
Create Assetpost
Update Assetpost
Patch Assetpatch
Delete Assetdelete
Details
Telemetry
Documents
Servicing
Profiles
Socket
- Negotiate Socket Connectionpost

Apps

Get Appget
Get Appsget
Create Apppost
Delete Appdelete
Management

Connectors

Get Ingress Connectorsget
Get Action Connectorsget
Get Data Connectorsget
Get Webhooks Connectorget
Checkpoints
- Get Data Connector Checkpointsget
- Get Ingress Connector Checkpointsget
Safety Culture
Management
Socket
- Negotiate Socket Connectionpost

Dashboards

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

Devices

Get Device Typesget
Get Device Id Typesget
Update Devicepatch
Trips
- Get Device Trips Countget
Events
- Get Device Events Countget
Management
- Get Access Pinget
- Immobilisepost
Telemetry
Schema
- Get Device Schemaget
- Get Device Schema By Typeget
Metadata

Geofences

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

Groups

Get Asset Groupget
Get Asset Groupsget
Create Asset Grouppost
Copy Asset Grouppost
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 Notificationget
- Get Notificationsget
Config
- Get Tenant Configget
- Update Tenant Configpatch
Info
- Get Tenant Infoget
- Update Tenant Infopatch
Logo
App Version
- Get App Versionsget
- Update App Versionspatch

People

Get Driverget
Get Driversget

Profiles

Custom Counters
Working Hours
Share Details
User Profiles
Asset Marker Profiles

Public

Get Shared Assetsget

Reports

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

Search

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

Servicing

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

Tasks

Get Taskget
Get Tasksget
Create Taskpost

Users

Get Usersget
Create Userpost
Update Userpatch
Delete Userdelete
Get Group Usersget
Get Users Extensionsget
Current User
User Management
Access
Profiles
- Get User Access Profileget
- Get User Access Profilesget
Preferences
Logs
- Get User Logsget
- Create User Logpost

Workflows

Get Workflowget
Get Workflowsget
Update Workflowpost
Delete Workflowdelete
Workflow Helpers
Workflow Management
- Copy Workflowpost
- Workflow Manual Triggerpost
Checkpoints

WorkOrders

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

Powered by

Get Asset Share Configs

get https://{#baseUrl#}/assets/v3/{id}/shareconfig

Get Share Configs For Asset

Language

Credentials

Log in to use your API keys

URL

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