Skip to main content

Get Data Product

Retrieve a single data product by ID with its schema reference, source run, status, and metadata. Requires read scope for the workspace.

Retrieve the full details of a specific data product by its UUID. The response includes the product name, description, associated schema and source run references, current status, and timestamps. Use this endpoint to inspect a product before fetching its result rows.

The schema_id field references the user schema that defines the output columns. The run_id field references the job run that produced the underlying extracted data. Together these let you trace the full lineage of the data product back to the original documents.

GET/v1/data-products/{id}

Response

Response fields

idstringData product UUID.
namestringHuman-readable product name.
descriptionstring | nullOptional description.
schema_idstringUUID of the user schema.
run_idstringUUID of the source job run.
statusstringProduct status: active, draft, or archived.
created_atstringISO 8601 creation timestamp.
updated_atstringISO 8601 last update timestamp.

curl

Response

{
  "id": "d1a2b3c4-e5f6-7890-abcd-ef1234567890",
  "name": "Q4 Invoice Extract",
  "description": "Structured invoice data from Q4 batch",
  "schema_id": "s1a2b3c4-e5f6-7890-abcd-ef1234567890",
  "run_id": "r1a2b3c4-e5f6-7890-abcd-ef1234567890",
  "status": "active",
  "created_at": "2024-11-01T14:20:00.000Z",
  "updated_at": "2024-11-01T14:25:30.000Z"
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundData product not found or does not belong to your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.