Export data

Export the content body of a data entry in either HTML or Markdown format. Use the type path parameter to specify the desired format: html or markdown.

This is the only GET endpoint that returns the content body of a data entry. List data and Get data return metadata only (no body text).

Returns the same identifying fields as Get data, plus either content_html or content_markdown with the full text content.

Including file content: pass ?include_file_content=true to also read the extracted text of attached document files (PDF, DOCX, PPTX, XLSX) from the search index — in the plain export, attached files appear only as links. The response then additionally includes:

  • content_text — the entry's full indexed body: its own text with file text inlined, plus any survey content. Each file's pages are preceded by a <file name> - <page number> header, so content can be attributed to its source file.
  • files — the entry's attached files with a per-file text_status (ready / pending / failed / unsupported / unavailable).
  • indexed — when false, the entry has not reached the search index yet and content_text is empty; retry shortly.
  • truncated — when true, the indexed body exceeded the search index's size limit and content_text is incomplete.

Attached file text is returned under note:read: files are part of the data entry, and their visibility is implied by the entry's visibility. (file:read gates binary file egress via the file download API, not extracted text.)

With include_file_content=true, returns 403 when the workspace has export disabled (HIPAA restriction), and when any attached file is past its retention window: retention removes the file's bytes but its extracted text remains in the search index, so the flag is refused rather than returning content the files list would label unavailable. The plain export (without the flag) is unaffected in both cases.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of the data.

string
enum
required
Allowed:
Query Params
string
enum

When true, the response additionally includes the extracted text of attached document files (PDF, DOCX, PPTX, XLSX) read from the search index: content_text, files (with per-file text_status), indexed, and truncated. Defaults to false.

Allowed:
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json