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 Assetdel
Details
Telemetry
Documents
Servicing
Profiles
Socket
- Negotiate Socket Connectionpost
- Get Asset Share Config by IDget
Jobs
- Create Asset Update Jobpost
- Create Asset Import Jobpost
Data Explorer
- Fetch and explore system object dataget

Apps

Get Appget
Get Appsget
Create Apppost
Delete Appdel
App Management

Connectors

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

Dashboards

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

Devices

Get Deviceget
Get Devicesget
Update Devicepatch
Get Device Typesget
Get Device Historyget
Trips
- Get Device Trips Countget
Events
- Get Device Events Countget
Telemetry
- Get Device Metricsget
- Get Device Telemetry Countget
Metadata
- Get Device Metadataget
- Get Device Infoget

Geofences

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

Groups

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

Organisation

Get Invoicesget
Get System Jobsget
Get Tenant Inventoryget
Get Tenant Consumptionget
Get Tenant Actions Consumptionget
Banners
- Get Notificationsget
- Get Notificationget
Config
- Get Tenant Configget
- Update Tenant Configpatch
Info
- Get Tenant Infoget
- Update Tenant Infopatch
Logo
App Version
- Get App Versionsget
- Update App Versionspatch
Reference Data

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 Reportdel
Scheduled Reports
Saved Reports
- Get Saved Reportsget
- Get Saved Reportget
Other

Search

Global Searchget
Get Assets In Proximityget
Get Object Dependencyget
Save

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 Userdel
Get Group Usersget
Get Users Extensionsget
Current User
User Management
Data Access
- Get User Data Accessget
- Update User Data Accesspost
User Access
- Get User Accessget
- Update User Accesspost
Access Profile
- Get User Access Profilesget
- Get User Access Profileget
User Preferences
User Logs
- Get User Logsget
- Create User Logpost

Workflows

Get Workflowget
Get Workflowsget
Update Workflowpost
Delete Workflowdel
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

Create Entity Data

post https://{#baseUrl#}/organisation/v3/referencedata/{entityType}

Create a new entity record

Language

Credentials

Log in to use your API keys

URL

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