Skip to content

Base URL & authentication

Base URL Route prefix
https://api.vastvision.io /third-party-access

Every route in these docs is the base URL followed by the route prefix, for example https://api.vastvision.io/third-party-access/zones/. The full interactive reference lives at api.vastvision.io/docs (see API reference).

  • VastVision issues a long-lived bearer access token tied to your organization and a set of scopes. Tokens are generated in the VastVision web app under Custom Integration settings (by your administrator, see Onboarding) or by the VastVision team. There is no token endpoint for you to call.
  • Send the token on every request: Authorization: Bearer <YOUR_ACCESS_TOKEN>.
  • Tokens do not currently expire automatically. Treat them like passwords: keep them server-side only and ask VastVision to revoke and reissue one if it is exposed.
  • A missing or invalid token returns 401. A valid token without the required scope returns 403 {"detail": "Forbidden: insufficient scope"}.
Terminal window
curl https://api.vastvision.io/third-party-access/ping \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>"
200 OK
{
"status": "ok",
"organization_id": 42
}

Each route requires a specific scope. Your VastVision contact will confirm which scopes are enabled on your token.

Scope Label Grants
asset.read Read assets Ping and organization info
asset.create Create assets Bulk-create assets without printing
asset.print Print RFID labels & create assets Create assets and print their RFID labels
asset_classification.read Read asset classifications List the classification tree (with optional asset counts)
asset_classification.write Write asset classifications Bulk-create classifications
zone.read Read zones List zones and their reader/antenna placement
mqtt_change_message.read Read movement history Recent asset movements
mqtt_change_message.write Write movement messages Post RFID tag-read events
stock_alert.read Read stock alerts List par-level rules and current counts
stock_alert.write Write stock alerts Bulk-create par-level rules