v2

latestOpenAPI 3.1.02026-07-26391214472.7 KB

nlq

Export Preview Csv

Re-run the NLQ filter and stream the matching records as CSV.

Applies the same access_grants + FLS enforcement as submit_query. Capped at 10 000 rows — the frontend shows a toast when the cap is hit so users know their export isn't complete.

post/api/v1/nlq/export

Headers

authorizationstring nullable

X-API-Keystring nullable

Request body

object_typestring required

Object api_name, e.g. 'Lead'.

filter_treeobject nullable

FilterGroup tree, same shape submit_query accepts.

limitinteger

sort_fieldstring nullable

sort_dirstring nullable

partition_bystring[] nullable

n_per_groupinteger nullable

Response

Successful Response

{"stackTrail":"paths:/api/v1/nlq/export:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}