Create a report export | HINDSITE

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:

Request API credentials from HINDSITE support to receive your client_id and client_secret
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

The response will contain your access token:

1 {
2   "access_token": "your_access_token_here",
3   "token_type": "Bearer",
4   "expires_in": 7200,
5   "created_at": 1234567890
6 }

Include the token in subsequent API requests:

Authorization: Bearer your_access_token_here

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 ``` 3. The response will contain your access token: ```json { "access_token": "your_access_token_here", "token_type": "Bearer", "expires_in": 7200, "created_at": 1234567890 } ``` 4. Include the token in subsequent API requests: ``` Authorization: Bearer your_access_token_here ```

Path parameters

form_idintegerRequired

Request

This endpoint expects an object.

formatenumRequired

Export file format

image_sizeenumOptional

Resolution of embedded images

show_instructionsbooleanOptional

show_flagged_sectionbooleanOptional

show_completion_detailsbooleanOptional

Response

created Export

idstring

statusenum

formatenum

exportableobject

created_atdatetime

completed_atdatetime or null

download_urlstring or nullformat: "uri"

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

Errors

429

Too Many Requests Error

$	curl -X POST https://app.hindsiteind.com/api/v2/forms/1/exports \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"format": "pdf"
>	}'

1	{
2	"id": "string",
3	"status": "pending",
4	"format": "pdf",
5	"exportable": {
6	"type": "string",
7	"id": "string"
8	},
9	"created_at": "2024-01-15T09:30:00Z",
10	"completed_at": "2024-01-15T09:30:00Z",
11	"download_url": "string"
12	}

1	{
2	"access_token": "your_access_token_here",
3	"token_type": "Bearer",
4	"expires_in": 7200,
5	"created_at": 1234567890
6	}