Discover record schema | Runtype Documentation

curl -G https://api.runtype.com/v1/records/schema \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d type=type

{
  "fields": [
    {
      "name": "email",
      "type": "string",
      "description": "User email address",
      "required": true,
      "example": "user@example.com"
    },
    {
      "name": "createdAt",
      "type": "string",
      "format": "date-time",
      "description": "Record creation timestamp",
      "required": true,
      "example": "2024-06-01T12:00:00Z"
    },
    {
      "name": "isActive",
      "type": "boolean",
      "description": "Indicates if the user is active",
      "required": false,
      "example": true
    }
  ],
  "sampledAt": "2024-06-10T15:45:00Z",
  "sampledRecords": 50,
  "totalRecords": 1200,
  "type": "user"
}

Discover available metadata fields for a record type by sampling records.

Authentication

AuthorizationBearer

API key or Clerk session token

Query parameters

typestringRequired

samplestringOptional

Response

Schema field discovery result

fieldslist of any

sampledAtstring

sampledRecordsinteger

totalRecordsinteger

typestring

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

$	curl -G https://api.runtype.com/v1/records/schema \
>	-H "Authorization: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d type=type

1	{
2	"fields": [
3	{
4	"name": "email",
5	"type": "string",
6	"description": "User email address",
7	"required": true,
8	"example": "user@example.com"
9	},
10	{
11	"name": "createdAt",
12	"type": "string",
13	"format": "date-time",
14	"description": "Record creation timestamp",
15	"required": true,
16	"example": "2024-06-01T12:00:00Z"
17	},
18	{
19	"name": "isActive",
20	"type": "boolean",
21	"description": "Indicates if the user is active",
22	"required": false,
23	"example": true
24	}
25	],
26	"sampledAt": "2024-06-10T15:45:00Z",
27	"sampledRecords": 50,
28	"totalRecords": 1200,
29	"type": "user"
30	}