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.
API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.
In: header
Path Parameters
The workspace slug — the {slug} segment of your Clarify workspace URL.
The object type: a built-in entity (person, company, deal, …) or a custom object (c_*).
The unique ID of the list.
Query Parameters
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_datee7c9a1f4-2b8d-4c6e-9f0a-5d3b7e1c8a42,Acme Renewal Q1,In progress,50000,2026-03-31Update a layout
Replaces the layout's `tree` and returns the updated layout. For list layouts (`list__<entity>`), folder names are trimmed of edge whitespace and zero-width characters, 1 to 100 characters, and unique ignoring case, a list sits in at most one folder, and each newly linked list must be a published dynamic list of that entity. Violations already in the stored tree do not block an edit, but new ones return 400, an unknown entity returns 404, and a concurrent edit returns 409.
Create a list
Creates a list on the given object type. A `dynamic` list derives its membership from the SQL `query`; a `static` list starts empty. Returns the created list.