iGUIDE Portal API Documentation

Welcome to the iGUIDE Portal API documentation. This API allows you to manage iGUIDEs and related resources programmatically.

Quick links

• Your First iGUIDE Tutorial - Learn how to create your first iGUIDE using the Portal API
• API Reference - Complete API endpoint documentation with interactive examples

API overview

The iGUIDE Portal API is a RESTful API (v1.0) that allows you to manage iGUIDEs and related resources. All requests must be sent via HTTPS, and all responses are in JSON format.

Base URL

https://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