Skip to main content
NICE CXone Expert
Expert Success Center

pages/{pageid}/pdf (GET)


Export a page to PDF

  • REST Method: GET
  • Method Access: public

Uri Parameters

Name Type Description
filename string Filename to download the pdf as
pageid string either an integer page ID, "home", or "=" followed by a double uri-encoded page path

Query Parameters

Name Type Description
showtoc bool? flag to display a table of contents in the exported document
format {pdf, html}? format to export: pdf | html (default: pdf)
authenticate bool? Force authentication for request (default: false)
stylesheet string? name of custom stylesheet to apply (stored in site/properties with namespace 'mindtouch.prince.stylesheet#

Return Codes

Name Value Description
OK 200 The request completed successfully
Bad Request 400 Invalid input parameter or request body
Forbidden 403 Read access to the page is required
Not Found 404 Requested page could not be found

Message Format

None. The output is a PDF file.

Implementation Notes


Curl Code Sample: Retrieve a Page in PDF

The following command retrieves page "foo" in PDF format:

Sample Code

curl -u username:password -i http://mindtouch.address/@api/deki/pages/=foo/pdf

Implementation notes 

curl flags

Provides external user authentication. Note that if anonymous access is available and authentication is not forced, this flag may be omitted.
Outputs the HTTP response headers. Useful for debugging.


Note that a PDF file, not an XML document, is returned. If the output is not directed somewhere, a bunch of junk will be printed in console.


To view a list of all pages, follow the instructions here.


  • Was this article helpful?