Skip to navigation
HINDSITE APIforms

Create a report export

View as Markdown

Starts an asynchronous PDF or DOCX export of the form. Responds immediately with a pending export; poll GET /api/v2/forms/{form_id}/exports/{id} or subscribe to the report_export_completed webhook to receive the download URL once it is ready.

Authentication

AuthorizationBearer

OAuth 2.0 Client Credentials Flow. To obtain an access token:

  1. Request API credentials from HINDSITE support to receive your client_id and client_secret

  2. Make a POST request to obtain an access token:

POST https://app.hindsiteind.com/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET
  1. The response will contain your access token:
{
  "access_token": "your_access_token_here",
  "token_type": "Bearer",
  "expires_in": 7200,
  "created_at": 1234567890
}
  1. Include the token in subsequent API requests:
Authorization: Bearer your_access_token_here

Path parameters

form_idstringRequired

Request

This endpoint expects an object.
formatenumRequired
Export file format
Allowed values:
image_sizeenumOptional
Resolution of embedded images
Allowed values:
show_instructionsbooleanOptional
show_flagged_sectionbooleanOptional
show_completion_detailsbooleanOptional

Response

created Export
idstringOptional
statusenumOptional
Allowed values:
formatenumOptional
Allowed values:
download_urlstring or nullOptionalformat: "uri"

Short-lived signed URL; present only when status is completed

created_atlongOptional

Unix timestamp (seconds since epoch) when the record was created

updated_atlongOptional

Unix timestamp (seconds since epoch) when the record was last updated

Errors

429
Too Many Requests Error