iGUIDE Portal API documentation

The Portal API lets you create iGUIDEs, download deliverables, pull measurement data and manage them programmatically. Plug iGUIDE into the tools your team already uses.

Quick links

• Your first iGUIDE: Create an iGUIDE, upload Stitch Data and check processing status
• Authentication: Set up API tokens or OAuth credentials
• API reference: Complete endpoint documentation with interactive examples

What you can build

• Automate iGUIDE creation. POST /iguides to create iGUIDEs from your scheduling or dispatch system. Pass type, industry and address to get started. See the Your first iGUIDE tutorial.
• Listen for processing events. Register a webhook when you create an iGUIDE and receive a ready event with the iGUIDE URL, media links and property data when processing completes. You can also poll the work order status as a fallback.
• Download deliverables. Call GET /iguides/{id}/asset-urls to retrieve all media and floor plan URLs in one request, or use the dedicated download-dwg, download-rvt and download-esx endpoints for CAD files. See the Download deliverables tutorial.
• Read measurement data. Access room dimensions, square footage and 3D coordinates through the tags endpoint (GET /iguides/{id}/tags) instead of parsing floor plan PDFs.
• Embed the iGUIDE viewer. Use the Viewer API JavaScript library to display the interactive 3D tour inside your own website and control navigation programmatically.
• Upload photos and assets. POST /iguides/{id}/assets returns S3 upload credentials so you can push images (JPEG, PNG, HEIC), PDFs and videos directly. See the Upload photos tutorial.
• Update tags and annotations. PUT /iguides/{id}/tags to keep listing details, labels and Markdown content in sync with your data. See the Manage tags tutorial.
• Order add-on services. POST /iguides/{id}/workOrders with task types like dwg-init, rvt-init or esx-init to request advanced drafting, 3D models or Xactimate reports. See the Order additional services tutorial.

Typical integration flow

1. Create an iGUIDE. POST /iguides with the property address, iGUIDE type (standard, premium, radix or photos) and a webhooks array for event delivery.
2. Upload Stitch Data. Request an S3 upload permit, push the capture files, then trigger processing. Credentials are valid for 24 hours.
3. Wait for processing. A webhook fires a ready event containing the public URL, media links and property metadata. Processing time ranges from minutes (Radix) to ~24 hours (Standard/Premium). You can also poll the work order status as a fallback.
4. Pull deliverables and data. Call GET /iguides/{id}/asset-urls for all media URLs or the dedicated download endpoints for CAD files. Read measurements via GET /iguides/{id}/tags.

For a step-by-step walkthrough, see the Your first iGUIDE tutorial and the iGUIDE lifecycle guide.

Portal-only features

Some operations are still managed in the iGUIDE Portal. Layout editing, floor plan positioning and visual adjustments are not available through the API.

API overview

The Portal API is a RESTful API (v1.0) for managing iGUIDEs and related resources. All requests are sent via HTTPS and all responses are in JSON format.

Base URL

https://manage.youriguide.com/api/v1

Available resources

Resource	Description
/banners	Manage public banners with contact details
/iguides	Create and manage iGUIDEs
/iguides/{iguideId}/assets	Upload and process iGUIDE assets
/iguides/{iguideId}/editors	Manage editors assigned to iGUIDEs
/iguides/{iguideId}/tags	Manage tags for iGUIDEs
/iguides/{iguideId}/views	Manage iGUIDE view expiration dates
/iguides/{iguideId}/workOrders	Create and manage work orders
/iguides/{iguideId}/asset-urls	Get all media and ADS download URLs
/iguides/{iguideId}/download-*	Download iGUIDE deliverables (DWG, ESX, RVT)
/integrations	Test integration credentials
/stitchData	Assign and process Stitch Data
/userinfo	Retrieve user and subaccount information