Combined
API referenceEndpointsCatalogue

List Catalog

Discover granted Sources, datasets, fields, logical SQL names, and freshness before querying.

GET
/v1/catalog

Discover granted Sources, datasets, fields, logical SQL names, and freshness before querying.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

accountId*string

Account UUID that defines the tenant and authorization scope.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/catalog?accountId=00000000-0000-4000-8000-000000000001"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "connectorKey": "string",      "state": "healthy",      "lastSuccessAt": "2019-08-24T14:15:22Z",      "logicalName": "string",      "datasets": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "sourceId": "797f5a94-3689-4ac8-82fd-d749511ea2b2",          "logicalSchema": "string",          "logicalTable": "string",          "lastSuccessAt": "2019-08-24T14:15:22Z",          "fields": [            {              "logicalName": "string",              "duckdbType": "string",              "nullable": true,              "classification": "public",              "description": "string"            }          ]        }      ]    }  ],  "correlationId": "string"}

List Accounts GET

List accounts visible to the authenticated principal.

Query Sql POST

Execute one bounded, read-only SELECT over granted catalog relations. Use positional parameters for values and maxRows to bound output. An optional Idempotency-Key can recover the identical query after an ambiguous transport failure.