Create Placement Export Request

Submits an asynchronous request to export placement data for the given tenant. The request is queued for processing, and the response returns a correlation identifier used to track the request through the export pipeline.

When the export completes, the PartnerExportReadyEvent webhook is delivered to the partner. The resulting batch can then be retrieved using the Get Partner Export Batch Paged Data endpoint.

⚠️

This API comes with additional fees. Please reach out to your Avionté Representative to discuss gaining access.

Query Params
int32
0 to 5
Defaults to 0

The number of years back that will be searched, relative to the request date. For example, a value of 3 entered on 3/10/2026 will return placements active between 3/10/2023 and 3/10/2026. The maximum value is 5. The default value is 0; when 0, only currently active placements are returned.

Headers
uuid

Unique request identifier (UUID) used to correlate request data with log entries and events.

integer

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

string

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Responses

401

Unauthorized

403

Access Denied

405

Unsupported method

406

Unsupported format(s) indicated by Accept header

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

Service Unavailable

504

Gateway Timeout

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json