REST API Endpoints

This article lists all REST API endpoints for Cloud Services.

Subscribed Endpoints

There are two endpoints that developers may use to access Cloud Services. Both locations offer the same functionality and no data is shared between locations.

Location	Endpoint
USA	cloud.hotdocs.ws
EU	europe.hotdocs.ws

URL Placeholder

In the API documentation, the {subscribedEndpoint} placeholder denotes a place in a URL where the appropriate endpoint should be added.

Endpoint Methods

These are the methods available at the endpoints above, used to interact with Cloud Services.

Direct API

Name	Verb	URL	Description
Upload Package	PUT	https://{subscribedEndpoint}/hdcs/{subscriberID}/{packageID}	Upload a HotDocs Template Package file to Cloud Services.
Get Interview	POST	https://{subscribedEndpoint}/hdcs/interview/{subscriberID}/{packageID}/{templatename=null}	Generate an interview to display to a user.
Assemble Document	POST	https://{subscribedEndpoint}/hdcs/assemble/{subscriberID}/{packageID}/{templatename=null}	Assemble a completed document using a Template Package.
Get Component Info	GET	https://{subscribedEndpoint}/hdcs/componentinfo/{subscriberID}/{packageID}/{templatename=null}	Get information from the Component File in a Template Package.
Get Interview File	GET	https://{subscribedEndpoint}/hdcs/interviewfile/{subscriberID}/{packageID}?{filename}

Embedded API