POST /projects/{project}/export/database

curl --request POST \
  --url https://api-zangtable.com/projects/{project}/export/database \
  --header 'Authorization: <authorization>'

import requests

url = "https://api-zangtable.com/projects/{project}/export/database"

headers = {"Authorization": "<authorization>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<authorization>'}};

fetch('https://api-zangtable.com/projects/{project}/export/database', 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-zangtable.com/projects/{project}/export/database",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$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-zangtable.com/projects/{project}/export/database"

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

	req.Header.Add("Authorization", "<authorization>")

	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-zangtable.com/projects/{project}/export/database")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'

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

{
  "ok": true,
  "data": {},
  "error": {},
  "request_id": "<string>"
}

POST

https://api-zangtable.com

projects

{project}

export

database

POST /projects/{project}/export/database

curl --request POST \
  --url https://api-zangtable.com/projects/{project}/export/database \
  --header 'Authorization: <authorization>'

import requests

url = "https://api-zangtable.com/projects/{project}/export/database"

headers = {"Authorization": "<authorization>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<authorization>'}};

fetch('https://api-zangtable.com/projects/{project}/export/database', 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-zangtable.com/projects/{project}/export/database",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$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-zangtable.com/projects/{project}/export/database"

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

	req.Header.Add("Authorization", "<authorization>")

	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-zangtable.com/projects/{project}/export/database")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'

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

{
  "ok": true,
  "data": {},
  "error": {},
  "request_id": "<string>"
}

Creates a database export for selected tables.

Endpoint details

string

required

Bearer pat_... (Project API Token). Keep this token on your backend/server.

string

required

Project slug. This acts as the Project ID in API paths.

boolean

required

true for a successful response and false for an error response.

object | null

Endpoint-specific response data when ok is true; null on errors.

object | null

Error code and message when ok is false; null on success.

string

required

Request identifier you can use when troubleshooting a specific API call.

Authentication

Project API Token.

Parameters

Body optional: format zip, zip-csv, or json, default zip; include_tables optional array; exclude_tables optional array; table_options optional object keyed by table name; file_name optional.

Request examples

Basic request:

curl -X POST "$BASE_URL/projects/{project}/export/database" \
  -H 'Authorization: Bearer pat_PROJECT_TOKEN' \
  -H 'Content-Type: application/json' \
  --data '{}'

Full request:

curl -X POST "$BASE_URL/projects/{project}/export/database" \
  -H 'Authorization: Bearer pat_PROJECT_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'X-Operation-Key: edit-profile-email' \
  -H 'X-Operation-Run-Id: oprun_client_20260602_001' \
  --data '{"format":"json","include_tables":["contacts","companies"],"exclude_tables":[],"table_options":{"contacts":{"columns":["id","email"],"filters":{"status":"active"},"sort":"id","order":"asc","limit":1000,"offset":0}},"file_name":"crm_database"}'

Response examples

Success:

{
  "ok": true,
  "data": {
    "export": {
      "id": "exp_20260601_182345_a1b2c3d4e5",
      "kind": "database_export",
      "scope": "project",
      "project": "example_project",
      "table": null,
      "format": "zip",
      "download_name": "example_project_database_export.zip",
      "download_url": "/projects/example_project/export/download/exp_20260601_182345_a1b2c3d4e5",
      "storage_backend": "local",
      "content_type": "application/zip",
      "row_count": null,
      "table_count": 2,
      "size_bytes": 2048,
      "status": "ready",
      "status_reason": null,
      "missing_at": null,
      "created_at": "2026-06-02T01:23:45Z",
      "expires_at": null
    }
  },
  "error": null,
  "request_id": "req_20260602T012345_123456Z_abc123def456",
  "operation_key": "edit-profile-email",
  "operation_run_id": "oprun_20260602T012300_000000Z_a1b2c3d4e5f6",
  "operation_grouping_status": "accepted_provided_run",
  "meta": {
    "generated_at": "2026-06-02T01:23:45Z"
  }
}

Error or alternate response:

{
  "ok": false,
  "data": null,
  "error": {
    "code": "no_tables_selected",
    "message": "No tables were selected for export."
  },
  "request_id": "req_20260602T012345_123456Z_abc123def456",
  "meta": {
    "generated_at": "2026-06-02T01:23:45Z"
  }
}

Overview

Projects

Project API Tokens

Tables

Columns

Query and indexes

Records

Exports

POST /projects/{project}/export/database

Endpoint details

Authentication

Parameters

Request examples

Response examples

​Endpoint details

​Authentication

​Parameters

​Request examples

​Response examples

Endpoint details

Authentication

Parameters

Request examples

Response examples