Get Record Set

Retrieve a single record set by UUID: its value plane layer, source kind, lifecycle status, record and field counts, and links to fields, records, and export.

Retrieve a single record set by its UUID. A record set is a table-like collection of structured records at one value plane layer, and this endpoint returns its full metadata: the layer, the source kind and ID, the lifecycle status, record and field counts, and links to the fields, records, and export endpoints. Use it to inspect a record set before fetching its contents.

The layer field tells you where this record set sits in the pipeline progression from capture to product. The kind and source_id fields trace the record set back to the structuring job, resolution run, or data product that created it. The record_count and field_count summarize the dataset size without fetching the actual records.

GET/v1/record-sets/{id}

Path parameters

id*uuidRecord set UUID. Must belong to your organization.

Response

Response fields

idstringRecord set UUID.

namestringHuman-readable name.

layerstringValue plane layer: capture, structured, resolved, or product.

kindstringSource kind that created this record set (e.g. structuring_run, resolution_run, data_product).

source_idstring | nullUUID of the source entity.

statusstringLifecycle state of the record set (active by default).

record_countintegerTotal number of records.

field_countintegerNumber of defined fields.

created_atstringISO 8601 creation timestamp.

linksobjectRelated resource URLs (self, fields, records, export).

curl

Response

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Resolution Run 2024-10-15",
  "layer": "resolved",
  "kind": "resolution_run",
  "source_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "status": "active",
  "record_count": 142,
  "field_count": 12,
  "created_at": "2024-10-15T11:30:00.000Z",
  "links": {
    "self": "/v1/record-sets/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "fields": "/v1/record-sets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/fields",
    "records": "/v1/record-sets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/records",
    "export": "/v1/record-sets/a1b2c3d4-e5f6-7890-abcd-ef1234567890/export"
  }
}

The links object gives you ready-made URLs for the three follow-up reads: fields (the column schema), records (paginated rows with cell values), and export (all rows in one call). Follow them instead of constructing paths by hand.

Errors

Error responses

401unauthorizedMissing or invalid API key.

404not_foundRecord set not found or does not belong to your organization.

429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

List Record Sets

List Record Set Fields

List Record Set Records