Exports

Export a client’s benefits and plans

Generates an export of the given benefits/plans in the requested format and returns a presigned download URL. The file belongs to the client (tagged via clientCompanyId). Returns a presigned downloadUrl — HTTP GET it to download the file (expires ~1 hour after issue).

post/v1/clients/{clientId}/exports

Request

  • Base URL
    https://api.pasito.ai
  • Auth
    HTTP bearer

Path parameters

clientIdstring required

Client id (e.g. com_a1b2c3d4e5f6g7).

Request body

format'csv' | 'json' | 'excel' | 'parquet' required

Output format.

companyBenefitIdsstring[]

Export all plans under these benefits (cben_ ids).

planIdsstring[]

Export these specific plans (ipn_ ids).

Response

Default Response

exportIdstring required

The created export file id.

format'csv' | 'json' | 'excel' | 'parquet' required
fileNamestring required
downloadUrlstring required

Presigned download URL for the generated file — HTTP GET it to download (no auth header needed; it's presigned). Expires ~1 hour after issue. The file is also stored for the client (via clientCompanyId).

Changes

No recorded changes to this operation across all 1 revision of this API.