Skip to content
Prevu3D

RealityConnect API FAQ

Some questions don’t belong to any one reference page. They’re commercial, architectural, or about what the API doesn’t do. This page collects the ones that come up most often in support, sales, and solutions engineering conversations, before a single line of code is written.

Can I access more than one organization with one set of credentials?

Section titled “Can I access more than one organization with one set of credentials?”

No, by design. Each OAuth token is permanently scoped to the organization it was issued for, and there’s no way to switch or read across organizations with a single set of credentials. See the Introduction and the Capabilities Overview for the full picture of what the API can and can’t do.

Why does my list come back empty when my token has every scope?

Section titled “Why does my list come back empty when my token has every scope?”

Check content access and role, not scopes. OAuth scopes are only layer 1 of the security model, so a token with every scope still only sees nodes the calling account has content access to, and can only act within its assigned role there. An empty result almost always means layer 2 or 3, not a missing scope. OAuth Scopes by Job confirms you have the right scopes at all; from there, check the calling account’s content access and role on that node.

How do I find my organization’s region?

Section titled “How do I find my organization’s region?”

Call GET /oauth/api-info with your access token. The response includes your regional apiUrl and your organization.id. Never hardcode a regional URL. See Getting Started and the Client Credentials Flow for a worked example.

Can I use the API without a RealityTwin licence or RealityPlan seat?

Section titled “Can I use the API without a RealityTwin licence or RealityPlan seat?”

For most of it, yes. A RealityTwin Data Manager license is only consumed by calls that touch twin content (assets, POIs, zones, drafts, search, object metadata, embed sessions, and the asset library). User and invitation management, roles, and the /oauth/api-info discovery call don’t touch a twin and don’t consume a license. Some RealityPlan-related endpoints also consume a RealityPlan seat. See Licensing.

Is there a test or sandbox environment?

Section titled “Is there a test or sandbox environment?”

No dedicated sandbox or trial environment exists today. The simplest way to try the API is a Client Credentials application in your own organization. See Choose an OAuth flow.

How do I keep my system’s identifiers on Prevu3D objects?

Section titled “How do I keep my system’s identifiers on Prevu3D objects?”

There’s no reserved field for this. Use a plain string or number property in the object’s metadata, for example a section named “External IDs” holding your system’s identifier. Metadata is free-form key/value data, not a fixed schema, so any property name works without provisioning anything first. See Typed Metadata Values and Attachments.

What’s next?

Section titled “What’s next?”