Skip to Content
HelvetlyDocs
API referenceClients

Export clients as CSV

Needs a token with the read:clients scope (or write:clients). Authentication

Try in Playground sends a real request to app.helvetly.com with a token you paste. It stays in this browser tab only (session storage) and goes to no one else.

GET
/api/v1/clients/export

Streams the clients matching the filters (the same filters as list_clients, plus ids) as a CSV file, one row per client: number, name, preferred_name, type, active, draft, contact and address columns, tags joined by ';', the primary contact's name, created_at and updated_at. Text starting with = + - or @ is prefixed with an apostrophe against spreadsheet formulas. Not paged. Read-only; safe to retry.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A personal API token, hvt_…, with scopes such as read:* or write:invoices

Query Parameters

search?string

Matches name, number, email, city and more.

status?string

Comma-separated: active, inactive, draft, complete.

type?string

Companies or people.

Value in"company""person"
tag?string

A tag (case-insensitive); repeatable.

country?string

Comma-separated ISO alpha-2 codes.

ids?string

Comma-separated client ids: export only these.

sort?string

One of number, name, email, city, created_at, updated_at; prefix - for descending. Default -created_at.

Response Body

A CSV file (UTF-8).

response?filetext/csv
Formatbinary
Example Request
curl -X GET 'https://app.helvetly.com/api/v1/clients/export'
Example Response
"string"