Export customers (synchronous CSV)

GET 
/v1/exports/people

Generates and returns the customers CSV inline (text/csv; charset=utf-8 with BOM, Content-Disposition: attachment). Columns: nome, documento, tipo_documento, email, telefone, classificacao, external_id, tags, criado_em. Capped at 10k rows; beyond that use the asynchronous export (POST /exports/jobs). Requires the export access level (or all) — read and write are not enough.

Request

Responses

200

CSV file (text/csv; charset=utf-8 with BOM so Excel renders accents correctly; Content-Disposition: attachment).

401

Missing, invalid, expired or revoked token.

403

The token lacks the scope required by this operation.

404

Resource not found or outside your organization.

413

Request body larger than 2 MB.

429

Rate limit exceeded (600 per minute per key; 60 invalid attempts per minute per IP). Wait for Retry-After.

500

Internal error. Retry; if it persists, contact support.