Get & Delete
Retrieve a reference data table by ID to inspect its column schema and row count, or delete it permanently. Deleting a table does not remove matching configs that reference it.
Retrieve the full details of a single reference data table, including its column schema, row count, source type, and HATEOAS links. Use this endpoint to verify a table exists and inspect its structure before creating a matching configuration.
The response includes the same fields as the list endpoint but for a single table. The columns array shows the derived column names and types, which you need when defining field_mappings in a matching config — the target field in each mapping must match a column name from this response.
Deleting a reference data table removes the table and all its rows permanently. Matching configurations that reference the deleted table are not automatically removed — they will fail on the next run with a 404 error. Update or delete orphaned configs after removing a table.
A common pattern is to fetch the table detail, inspect the columns array, then use those column names as target values when creating field mappings in a matching config. The links.rows URL provides quick access to paginated row data for verification.
/v1/reference-data/:idResponse (GET)
Response fields
cURL — Get table
Response
{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"name": "Vendor Master List",
"source_type": "csv",
"row_count": 1250,
"columns": [
{ "name": "vendor_id", "type": "string" },
{ "name": "vendor_name", "type": "string" },
{ "name": "country", "type": "string" },
{ "name": "tax_id", "type": "string" }
],
"created_at": "2024-09-15T10:00:00.000Z",
"links": {
"self": "/v1/reference-data/b2c3d4e5-f6a7-8901-bcde-f12345678901",
"rows": "/v1/reference-data/b2c3d4e5-f6a7-8901-bcde-f12345678901/rows"
}
}/v1/reference-data/:idResponse (DELETE)
Response fields
cURL — Delete table
Response (DELETE)
{ "deleted": true }Errors
Error responses