Export engagements as CSV (GET /api/v1/engagements/export)

Needs a token with the read:engagements scope (or write:engagements). 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/engagements/export

GET

/api/v1/engagements/export

The list as a CSV file (UTF-8 with BOM), without paging. With ids every status is included. Same filters as list_engagements.

Authorization

bearerAuth

headerAuthorizationBearer <token>

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

Query Parameters

q?string

Search text.

client_id?string

Only this client's.

status?string

Comma-separated: scheduled, active, ended, cancelled. Default: scheduled and active.

ids?string

Comma-separated engagement ids.

attention?string

Only engagements needing this attention.

Value in"under_pace""ending_soon""overage""to_invoice"

sort?string

Default ends.

Default"ends"

Value in"ends""-created_at""title""client"

Response Body

The CSV file.

response?filetext/csv

Formatbinary

Example Request

curl -X GET 'https://app.helvetly.com/api/v1/engagements/export'

Example Request

curl -X GET 'https://app.helvetly.com/api/v1/engagements/export'

Example ResponseSchema

"string"

"string"

Export engagements as CSV

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Query Parameters

Response Body