Queue a submitted-form export

GET

https://ssuccessv2.com/app/api/v1/forms/pdf/submitted/:id

Queues a PDF or ZIP export of submitted records for a form. The export type is required as a query parameter and the response is an acknowledgement, not a file download.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

idlongRequired>=1

Form ID to export.

Query parameters

typeenumRequired

Export format requested by the forms screen.

Allowed values:

Response

Export generation was queued.

statusenum

messagestring

datalist of any

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error