The REST query API (
/api/v1) is in early access and not yet open for external use. The code exists and the contract below reflects the current behavior. For external consumption now, use the OData feed.
Early access
This contract is documented for planning and transparency. Do not build critical integrations on the REST API until it is released. To read tables today, prefer OData.
Lists the tables in the published marts (*_gold and *_silver datasets) of the workspace resolved from the API key. Read-only, scoped to the workspace.
Summary#
| Method · route | GET /api/v1/tables |
| Base | https://ingestia.io |
| Auth | API key (Authorization: Bearer ing_live_… or ?api_key=) |
| Role (RBAC) | data export (member+); data key = owner |
| Cost | R$ 0 (listing the catalog does not trigger a paid job) |
| Statuses | 200 · 401 · 403 · 429 · 402 · 503 |
Parameters#
No query parameters. It also responds to OPTIONS (CORS preflight) with 204.
Response headers#
X-Ingestia-Access-Scope: workspace(the key reads the entire workspace).Content-Type: application/json; charset=utf-8.
Example#
curl -H "Authorization: Bearer ing_live_EXEMPLO" \
https://ingestia.io/api/v1/tablesconst res = await fetch("https://ingestia.io/api/v1/tables", {
headers: { Authorization: "Bearer ing_live_EXEMPLO" },
});
const tabelas = await res.json();import requests
res = requests.get(
"https://ingestia.io/api/v1/tables",
headers={"Authorization": "Bearer ing_live_EXEMPLO"},
)
tabelas = res.json()200 response#
[
{
"dataset": "prd_aurora_gold",
"table": "vendas",
"layer": "gold",
"columns": [
{ "name": "data", "type": "DATE" },
{ "name": "total", "type": "NUMERIC" }
]
}
]With no datalake provisioned (demo), the route returns a clearly simulated catalog so you can validate the integration — it never fakes real data.
Errors#
| Code | When |
|---|---|
401 | missing/invalid/revoked key |
403 | insufficient role/scope (e.g., viewer service principal) |
429 | rate limit exceeded (includes Retry-After) |
402 | workspace with overdue payment/suspended |
503 | limiter unavailable (fail-closed) or datalake not provisioned |
Format: { "error": "mensagem em português" } (a message in Portuguese). Full catalog in
Errors and limits.
Security#
- Only exposes published marts (gold/silver) — never the bronze layer.
- Columns marked as PII do not appear in the catalog.
- Workspace scope: the key never resolves to another customer.
Related#
Last reviewed: 2026-09-08.