v12

latestOpenAPI 3.1.0AGPL-3.0raw.githubusercontent.com2026-05-286377631.6 MB
/api/document

POST /api/document/{document-id}/card/{card-id}/query/{export-format}

Download query results for a Card embedded in a Document.

Returns query results in the requested format. The user must have read access to the document to download results. If the card's query fails, standard query error responses are returned.

Route parameters:

  • document-id: ID of the document containing the card
  • card-id: ID of the card to download results from
  • export-format: Output format (csv, xlsx, json)

Body parameters (snake_case):

  • parameters: Optional query parameters (array of maps or JSON string)
  • format_rows: Whether to apply formatting to results (boolean, default false)
  • pivot_results: Whether to pivot results (boolean, default false)
post/api/document/{document-id}/card/{card-id}/query/{export-format}

Path parameters

document-idinteger required

value must be an integer greater than zero.

card-idinteger required

value must be an integer greater than zero.

export-formatstring required

Request body

format_rowsboolean required
pivot_resultsboolean required

Response

Successful response