Raw Data

Export a RAW table with cursor-based pagination

Returns a paginated page of rows from the specified RAW table. Use cursor (from next_cursor in the previous response) to fetch the next page. Maximum page size is controlled by MAX_RAW_PAGE_SIZE (default: 10000). When next_cursor is null, all rows have been exported. Tables without a primary key do not support cursor-based pagination. The response header X-Snapshot-At contains the ISO-8601 timestamp of the last successful sync for this table (omitted if no sync has occurred yet). All rows within a single cursor sequence are consistent as of that snapshot.

GET

raw

{table_name}

curl --request GET \
  --url https://api.example.com/raw/{table_name} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.example.com/raw/{table_name}', 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://api.example.com/raw/{table_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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://api.example.com/raw/{table_name}"

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

	req.Header.Add("X-API-Key", "<api-key>")

	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://api.example.com/raw/{table_name}")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "data": [
    {
      "contract_id": 1,
      "tenant": "Müller GmbH"
    }
  ],
  "count": 1,
  "next_cursor": "eyJjb2wiOiAiY29udHJhY3RfaWQiLCAidmFsIjogMX0=",
  "table_name": "ixhaus_contracts",
  "total_rows": 12500
}

Authorizations

X-API-Key

string

header

required

Path Parameters

table_name

string

required

Name of the RAW table to export

Query Parameters

limit

integer

default:1000

Rows per page. Maximum: 10000.

Required range: 1 <= x <= 10000

cursor

string

Pagination cursor from next_cursor of the previous response. Omit for the first page. When the response contains next_cursor: null, all rows have been exported.

Response

Successful Response

data

Data · object[]

required

count

integer

required

next_cursor

string | null

required

table_name

string

required

total_rows

integer | null

required

⌘I

Export a RAW table with cursor-based pagination

curl --request GET \
  --url https://api.example.com/raw/{table_name} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.example.com/raw/{table_name}', 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://api.example.com/raw/{table_name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$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://api.example.com/raw/{table_name}"

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

	req.Header.Add("X-API-Key", "<api-key>")

	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://api.example.com/raw/{table_name}")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

{
  "data": [
    {
      "contract_id": 1,
      "tenant": "Müller GmbH"
    }
  ],
  "count": 1,
  "next_cursor": "eyJjb2wiOiAiY29udHJhY3RfaWQiLCAidmFsIjogMX0=",
  "table_name": "ixhaus_contracts",
  "total_rows": 12500
}

Overview

Endpoints

Export a RAW table with cursor-based pagination

Authorizations

Path Parameters

Query Parameters

Response