Employers

Export employers

Changed on

Exports the account’s employers. format=json returns an inline list of export rows (max 10,000; fields mirror the CSV columns, camelCase). format=csv (default) returns 202 with an exports.generate operation — poll it, then download the CSV from GET /v1/operations/{id}/download once it succeeds. Requires employers.read.

get/employers/export

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/employers/export
  • Auth: HTTP bearer

Query parameters

format'csv' | 'json'

Export format. json streams an inline list of employer export rows (capped at 10,000 rows); csv (default) starts an async exports.generate operation.

Response

Inline JSON export (format=json).

object'list' required
urlstring required
hasMoreboolean required
nextCursorstring nullable required

Example response

{
  "url": "/v1/employers/export"
}

Changes