Skip to main content
POST
Use this endpoint to start a new data export. The run is processed asynchronously — poll Get data export run until the status is Completed and a fileUri is available.
This endpoint does not require an x-user-id header. Exports cover all users for the authenticated partner.

​
Activity window options

Send an empty request body {} to export activity since the latest completed run’s activityTo through the new run’s initiation time. On the first export, all historical activity is included (no lower bound).
Only one active run (Pending or InProgress) is allowed at a time. A concurrent request returns 409 with the existing run.

Authorizations

​
Authorization
string
header
required

Auth0-issued access token that includes the wealthyhood:nbg scope.

Body

application/json

Optional activity window for the export. Omit both fields (or send an empty object) for the default incremental window. When specifying a custom window, both fields are required.

​
activityFrom
string<date-time>

Lower bound (exclusive) for activity included in the export. Must be provided together with activityTo.

Example:

"2025-01-01T00:00:00.000Z"

​
activityTo
string<date-time>

Upper bound (inclusive) for activity included in the export. Must be provided together with activityFrom. Cannot be in the future.

Example:

"2025-01-31T23:59:59.999Z"

Response

Export run accepted and queued for processing.

​
id
string
required

Unique identifier for the export run.

Example:

"674a1b2c3d4e5f6789012345"

​
status
enum<string>
required

Current processing status of the export run.

Available options:
Pending,
InProgress,
Completed,
Failed
Example:

"Pending"

​
initiatedAt
string<date-time>
required

ISO 8601 timestamp when the export run was initiated.

Example:

"2025-01-16T01:00:00.000Z"

​
schemaVersion
string
required

Schema version used for the export file (semantic versioning).

Example:

"1.1.1"

​
activityTo
string<date-time>
required

Resolved upper bound (inclusive) for activity in this export. Defaults to the run's initiation time when not explicitly requested.

Example:

"2025-01-16T01:00:00.000Z"

​
exportedAt
string<date-time>

ISO 8601 timestamp when the export completed. Present when status is Completed.

Example:

"2025-01-16T02:00:00.000Z"

​
fileUri
string<uri>

URL to download the exported JSON file. Present when status is Completed.

Example:

"https://data-exports.wealthyhood.cloud/nbg/2026/01/16/export.json"

​
error
string

Error message when status is Failed.

Example:

"Unknown error during data export"

​
activityFrom
string<date-time>

Resolved lower bound (exclusive) for activity in this export. Omitted on the first incremental run when no previous completed export exists.

Example:

"2025-01-15T10:00:00.000Z"