---
title: "Get Scaffold Sample Data"
method: GET
path: "/v1/public/templates/scaffolds/{template_id}/sample-data"
tags: ["Public Templates API", "Public Scaffolds"]
---

# Get Scaffold Sample Data

`GET /v1/public/templates/scaffolds/{template_id}/sample-data`

## Request

- Base URL: `https://api.mixpeek.com`
- URL: `https://api.mixpeek.com/v1/public/templates/scaffolds/{template_id}/sample-data`
- Auth: none required

Live per-collection document counts of the scaffold's golden sample
namespace (public, no auth required).

Powers the Studio pre-clone preview: what a user actually gets when they
clone this scaffold with sample data. Counts are live-derived server-side
(cached ~10 min) because golden namespaces are not readable with normal
org keys.

## Path parameters

- `template_id` string, required: Scaffold template ID

## Response `200`

Successful Response

- ScaffoldSampleDataResponse: Live contents of a scaffold's golden sample namespace. Ground truth for the Studio pre-clone preview: golden namespaces 404 for normal org keys (they belong to the Demos org and are not the shared ``sample-data`` remap), so the counts must be server-derived. Curated copy (``whats_inside``) can lie; these counts cannot — a dark golden shows its real zeros here.
  - `template_id` string, required
  - `sample_namespace_id` string, nullable
  - `available` boolean, required: False when the scaffold has no sample namespace or it could not be read; collections/total are then empty.
  - `total_documents` integer
  - `collections` ScaffoldSampleCollection[]
    - `collection_id` string, required
    - `collection_name` string, nullable
    - `document_count` integer, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity
- `429`: Too Many Requests
- `500`: Internal Server Error
- `503`: Service Unavailable

## Changes

- **2026-10-09** `61a175e8eb9a`: 1 warning, 5 info
  - removed the optional property `detail` from the response with the `422` status
  - added the non-success response with the status `429`
  - added the non-success response with the status `503`
  - added the optional property `success` to the response with the `422` status
  - …2 more
- **2026-07-26** `7cb051533311`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/mixpeek/apis/mixpeek-api/changes/v1/public/templates/scaffolds/:template_id/sample-data/get.md)

---

[API](https://skmtc.dev/mixpeek/apis/mixpeek-api.md) - [All operations](https://skmtc.dev/mixpeek/apis/mixpeek-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mixpeek/apis/mixpeek-api/revisions/790bc16455f6?raw)