Get data export run

GET

b2b

data-exports

{id}

Get data export run

curl --request GET \
  --url https://{host}/b2b/data-exports/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{host}/b2b/data-exports/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/b2b/data-exports/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/b2b/data-exports/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/b2b/data-exports/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "674a1b2c3d4e5f6789012345",
  "status": "Pending",
  "initiatedAt": "2025-01-16T01:00:00.000Z",
  "schemaVersion": "1.1.1",
  "activityFrom": "2025-01-15T10:00:00.000Z",
  "activityTo": "2025-01-16T01:00:00.000Z"
}

Poll this endpoint after creating a data export run until the status reaches Completed or Failed. When the run completes successfully, the response includes fileUri — a URL to the exported JSON file. The activityFrom and activityTo fields match the activity window written to the export file metadata.

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Unique identifier of the data export run.

Example:

"674a1b2c3d4e5f6789012345"

Response

Export run retrieved successfully.

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"

Get data export run

curl --request GET \
  --url https://{host}/b2b/data-exports/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{host}/b2b/data-exports/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/b2b/data-exports/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/b2b/data-exports/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{host}/b2b/data-exports/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "674a1b2c3d4e5f6789012345",
  "status": "Pending",
  "initiatedAt": "2025-01-16T01:00:00.000Z",
  "schemaVersion": "1.1.1",
  "activityFrom": "2025-01-15T10:00:00.000Z",
  "activityTo": "2025-01-16T01:00:00.000Z"
}

Data Warehouse

Data Exports

Authorizations

Path Parameters

Response