---
title: "List canonical schema contracts"
method: GET
path: "/api/v1/data/schemas"
tags: ["Data"]
---

# List canonical schema contracts

`GET /api/v1/data/schemas`

## Request

- Base URL: `https://www.homecastr.com`
- URL: `https://www.homecastr.com/api/v1/data/schemas`
- Auth: none required

Schema-bundle catalog for canonical dataset, panel, forecast, benchmark, provenance, and artifact contracts.

## Query parameters

- `schema_id` string
- `data_family` string

## Response `200`

Canonical schema catalog

- object
  - `schema_id` string
  - `schema_version` string
  - `data_snapshot_id` string
  - `filters` object
  - `records` DataSchemaRecord[]
    - `canonical_schema_id` string, required
    - `schema_key` string, required
    - `title` string, required
    - `description` string, required
    - `json_type` string, nullable
    - `property_count` integer, required
    - `required_fields` string[], required
    - `referenced_by_families` string[], required
    - `artifact_id` string, required
    - `_links` object, required
  - `page` object
  - `provenance` DataProvenanceSummary
    - `provenance_id` string, required
    - `data_snapshot_id` string, required
    - `publication_date` string, date, nullable
    - `retrieval_date` string, date, nullable
    - `model_version` string, nullable
    - `license_note` string, required
  - `access` DataAccessSummary
    - `visibility` 'public' | 'metadata_only' | 'restricted' | 'unavailable', required
    - `support_level` string, required
    - `sensitivity` string, required
    - `training_eligibility` 'benchmark_only' | 'consumer_feed' | 'training_candidate' | 'holdback', required
    - `license_status` string, required
  - `_links` object

## Other responses

- `404`: Unknown schema_id

---

[API](https://skmtc.dev/homecastr/apis/homecastr-api.md) · [All operations](https://skmtc.dev/homecastr/apis/homecastr-api/llms.txt) · [OpenAPI document](https://skmtc.dev/homecastr/apis/homecastr-api/revisions/5776141a0e7f?raw)