v1

latestSwagger 2.02026-07-1311212.1 KB
Application

Requests the generation of application export files (tabular, pdf, zip).

Exports are generated asynchronously within SlideRoom. To retrieve the export file generated by this request, use the api/v#/export/{token} endpoint to check the progress/result of the generation process. PDF and ZIP exports are available in the Advanced Plan.

post/api/v2/application/request-export

Query parameters

format'csv' | 'tsv' | 'txt' | 'tab' | 'xlsx' | 'pdf' | 'zip' | 'json'
roundType'Assigned' | 'Current' | 'Named' | 'All'
roundNamestring
tab.exportstring
pdf.includeFormsboolean
pdf.includeReferencesboolean
pdf.includeMediaboolean
pdf.includeApplicantAttachmentsboolean
pdf.includeOrganizationAttachmentsboolean
pdf.includeRatingsboolean
pdf.includeFullPageMediaboolean
pdf.includeHighlightsboolean
pdf.includeCommentsboolean
pdf.includeCommonAppboolean
zip.originalMediaboolean
zip.includeFormsboolean
zip.includeReferencesboolean
zip.includeMediaboolean
zip.includeApplicantAttachmentsboolean
zip.includeOrganizationAttachmentsboolean
zip.includeRatingsboolean
zip.includeCommentsboolean
zip.includeCommonAppboolean
delivery.accountstring
delivery.folderstring
sinceinteger
pool'All' | 'Current' | 'Archived' | 'CommonAppSDS'
status'All' | 'InProgress' | 'Submitted'
searchNamestring
emailstring

Response

OK

messagestring
submissionsinteger
tokeninteger