Skip to main content
POST
cURL

Authorizations

Authorization
string
header
default:dav_ak_live_your_token
required

Personal access token. The scopes granted at issuance determine both which operations the key may call and the ceiling on the resource permissions it can exercise. Each scope family is a ladder: projects:manage implies projects:write and projects:read; cards:manage implies cards:write and cards:read; and teams:manage implies teams:write and teams:read. These are named API capability bundles, not blanket domain roles: manage exposes only the permissions enumerated for that scope and never bypasses the acting user's current role-based access.

Path Parameters

projectId
string
required

Project id. May be compound in the form {projectId}--{branchName}.

Minimum string length: 1
objectId
string
required

Id of an object in the project.

Minimum string length: 1

Query Parameters

branch
string
default:main

Body

application/json
format
string
required

A format the Export menu offers for the object, such as pdf, docx, pptx, xlsx, png, svg, or html. Case-insensitive. Print PDF, which ends in the browser's print dialog, is not offered.

Minimum string length: 1
displayType
string

View to export, for objects with more than one (for example table or tree). Defaults to the view the object opens in.

dpi
integer

Resolution for raster content in PDF exports. Defaults to 300.

Required range: 72 <= x <= 600
parentId
string

Package to save the file in, such as the Library, 00000000-0000-0000-0000-00000library. Defaults to the exported object's parent.

Response

The object was exported and the file saved to the project.

objectId
string
required
format
string
required

The format exported, lower-case.

file
object
required

The reference the export was saved as.

pageCount
integer | null
required

Number of pages, for PDF exports; null for other formats.

Required range: x >= 1