Clarify APIList Rows
Export a list’s rows as CSV
Streams the rows of a list as a `text/csv` file download. The first row is a header of field names. Pass a `sql` statement in the body to export a custom query instead of the list’s own rows.
Authorization
apiKey Authorization<token>
API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.
In: header
Path Parameters
workspace*string
The workspace slug — the {slug} segment of your Clarify workspace URL.
object*string
The object type: a built-in entity (person, company, deal, …) or a custom object (c_*).
list*string
The unique ID of the list.
Query Parameters
silent?boolean
When true, suppresses in-app and Slack notifications for this mutation.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
text/csv
curl -X POST "https://example.com/workspaces/string/objects/string/lists/string/rows/csv" \ -H "Content-Type: application/json" \ -d '{ "sql": "SELECT * FROM deal WHERE amount >= 50000" }'"_id,name,stage,amount,close_date\ne7c9a1f4-2b8d-4c6e-9f0a-5d3b7e1c8a42,Acme Renewal Q1,In progress,50000,2026-03-31"