forms

Export Form as PDF

Export a form to PDF. All body fields are optional.

post/forms/{form_id}/pdf

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/forms/{form_id}/pdf
  • Auth: API key in header x-api-key

Path parameters

form_idinteger required

Form identifier

Request body

imagesOnlyboolean

Export only the form's image fields, omitting other field types. Defaults to false.

imagesInRow'0' | '1' | '2' | '3' | '4' | '5' | '6'

Number of images to lay out per row. Defaults to 2.

includeImageMetadataboolean

Include image metadata (e.g. GPS, timestamp) below each image. Defaults to true.

Response

PDF generated successfully

pdfBase64string required

Base64-encoded PDF bytes

contentType'application/pdf' required
namestring nullable

Suggested file name for the exported PDF

Changes

No recorded changes to this operation across all 1 revision of this API.