Object IDs

How Perspio object IDs are built.

Perspio gives most objects a readable ID made of your tenant's prefix, a type code and a number, such as in-gf-000123 for a geofence. IDs are lowercase. Use them in URL paths and request bodies exactly as the API returns them.

ObjectFormatExample
Asset{prefix}-{number}in-000123
Site{prefix}-site-{number}in-site-000123
Asset group{prefix}-astg-{number}in-astg-000123
Security group{prefix}-secg-{number}in-secg-000123
Geofence{prefix}-gf-{number}in-gf-000123
Workflow{prefix}-wf-{number}in-wf-000123
Dashboard{prefix}-db-{number}in-db-000123
Custom counter{prefix}-cc-{number}in-cc-000123
Device{pipeline prefix}-{device serial}dm-12345

{prefix} is your organisation's short code, such as in. Device IDs combine the prefix of the pipeline the device reports through with the device's own serial number.

📘

Your own IDs

Assets also have a customerAssetId field for your own reference, such as a fleet or plant number. Use it to match Perspio assets to records in your systems.