Skip to main content

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.

Deleting a reference data table is permanent and cannot be undone. Matching configs that reference the deleted table will fail on their next run. Delete or update orphaned configs to avoid errors.
GET/v1/reference-data/:id

Response (GET)

Response fields

idstringReference data table UUID.
namestringTable name.
source_typestringHow the table was created (json, csv, xlsx).
row_countintegerNumber of rows in the table.
columnsarrayColumn definitions with name and inferred type.
created_atstringISO 8601 creation timestamp.
links.selfstringURL to this table.
links.rowsstringURL to paginate through the table rows.

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"
  }
}
DELETE/v1/reference-data/:id

Response (DELETE)

Response fields

deletedbooleanAlways true on success.

cURL — Delete table

Response (DELETE)

{ "deleted": true }

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundNo reference data table with this ID exists for your workspace.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.