How do I get API access to UniAsset?
Which plan
Odyssey or Cosmos. API access is not available on Nova or Orbit.
IoT ingestion is gated separately, on IoT access.
Who can set it up
The Owner. Settings → Integrations is Owner-only.
What the API can do
| Endpoint | Does |
|---|---|
| Create asset | Creates an asset |
| Update assignment | Changes an asset's assignment |
| Record maintenance | Creates a service record |
| Update geo position | Records a coordinate reading |
| Ingest IoT signal | Stores telemetry |
The current API is write-oriented and narrow. Read endpoints, work order operations, document management, and bulk import are not part of it today.
Webhooks
Thirteen event types can be pushed to an HTTPS endpoint you control, signed so you can verify they came from UniAsset. Also Odyssey and above.
See How to use webhooks.
Getting started
- Confirm your organization is on Odyssey or above.
- Create an API key with the minimum scopes needed. It is shown once — store it in a secret manager.
- Create the categories, locations, and statuses your data references. The API resolves names; it does not create them.
- Send a test request and watch Settings → Integrations → Activity, which logs every request including failures.
Full guide: Getting started with the REST API.
Common questions
Can I try the API on the free plan? No. It needs Odyssey or above.
What if I downgrade? Keys are not revoked. They stop authenticating while the capability is absent and work again on upgrade, with nothing to reconfigure.
Is the API versioned? Endpoints are currently unversioned and treated as v1. Breaking changes will get a version prefix, with Deprecation and Sunset headers and a minimum 90-day window. Build defensively — ignore unknown response fields.
Are there rate limits? Per key, 1–1000 requests per minute, default 60. Payloads are capped at 1 MB.
Is there documentation in the product? Yes — Settings → Integrations → Developer Guide.
Related articles
Need Help?
If you have questions not covered in this article, our support team is here to help.
Contact Support