Skip to main content

Get Record Set

Retrieve a single record set by ID with its layer, source reference, record count, and field count. Requires read scope for the workspace.

Retrieve the full metadata of a specific record set by its UUID. The response includes the value plane layer, source entity reference, record and field counts, and timestamps. Use this endpoint to inspect a record set before fetching its fields or records.

The layer field tells you where this record set sits in the pipeline progression. The source_type and source_id fields let you trace the record set back to the extraction, job, or resolution run that created it. The record_count and field_count give you a quick summary of the dataset size without fetching the actual records.

GET/v1/record-sets/{id}

Response

Response fields

idstringRecord set UUID.
namestringHuman-readable name.
layerstringValue plane layer: capture, structured, resolved, or product.
source_typestringOrigin type that created this record set.
source_idstringUUID of the source entity.
record_countintegerTotal number of records.
field_countintegerNumber of defined fields.
created_atstringISO 8601 creation timestamp.
updated_atstringISO 8601 last update timestamp.

curl

Response

{
  "id": "rs-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Resolution Run 2024-10-15",
  "layer": "resolved",
  "source_type": "resolution",
  "source_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "record_count": 142,
  "field_count": 12,
  "created_at": "2024-10-15T11:30:00.000Z",
  "updated_at": "2024-10-15T11:35:42.000Z"
}

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.

Related

List Record Sets
List Record Set Fields
List Record Set Records