DocumentsApi

All URIs are relative to /api

MethodHTTP requestDescription
deleteDELETE /documents/{lookup}Delete document(s) by name
listGET /documentsList documents
retrieveGET /documents/{key}Download a document

delete

delete(lookup)

Delete document(s) by name

Deletes generated PDF documents by name, all documents with this name are deleted.

Parameters

NameTypeDescriptionNotes
lookupStringDocument filename[default to null]

Return type

null (empty response body)

Authorization

api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

list

ListDocumentsResponseDto list(startOffset, limit, nameFilter, template, start)

List documents

List generated PDF documents for the organization with pagination and optional filtering.

Parameters

NameTypeDescriptionNotes
startOffsetStringPagination offset (0-based), use the startOffset from the previous response[optional] [default to null]
limitBigDecimalMaximum number of documents to return (default 100)[optional] [default to null]
nameFilterStringPartial match filter on document name[optional] [default to null]
templateBigDecimalFilter by template ID[optional] [default to null]
startoas_any_type_not_mappedPagination offset (0-based)[optional] [default to null]

Return type

ListDocumentsResponseDto

Authorization

api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

retrieve

File retrieve(key, dl)

Download a document

Download a generated PDF document by its filename key.

Parameters

NameTypeDescriptionNotes
keyStringDocument filename key[default to null]
dlStringSet to "1" to force download with Content-Disposition attachment header[optional] [default to null]

Return type

File

Authorization

api-key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/pdf, application/json