Skip to main content
GET
/
api
/
v2
/
documents
/
pdf-template
/
{slug}
/
metadata
PDF template document metadata
curl --request GET \
  --url https://api.example.com/api/v2/documents/pdf-template/{slug}/metadata
{
  "id": "<string>",
  "fileName": "<string>",
  "pdfPageCount": 1,
  "presignedUrl": "<string>",
  "size": 123
}

Path Parameters

​
slug
string
required

The slug of the PDF template.

Response

Successfully retrieved PDF template document metadata.

Successfully retrieved PDF template document metadata.

​
id
string
required
​
fileName
string
required
​
pdfPageCount
integer | null
required

The number of pages in the PDF, or null for non-PDFs and PDFs that have not been counted yet.

Required range: x >= 0
​
presignedUrl
string<uri>
required
​
size
number | null

The size of the file in bytes.