Skip to main content
GET
/
v1
/
schemas
/
{schema_id}
const schema = await client.schemas.get("schema_abc123");

console.log(schema.name);
for (const col of schema.columns) {
  console.log(`${col.key}: ${col.type}`);
}

{
  "id": "schema_abc123",
  "name": "Electronics Catalog",
  "description": "Schema for consumer electronics",
  "is_default": false,
  "columns": [
    { "key": "product_name", "label": "Product Name", "type": "text", "required": true },
    { "key": "price", "label": "Price", "type": "number" }
  ],
  "created_at": "2025-03-01T10:00:00.000Z",
  "updated_at": "2025-03-01T10:00:00.000Z"
}

​
Path parameters

​
schema_id
string
required
The unique identifier of the schema.

​
Response

​
id
string
Unique schema identifier.
​
name
string
Schema name.
​
description
string | null
Schema description.
​
is_default
boolean
Whether this is the default schema.
​
columns
array
​
created_at
string
ISO 8601 timestamp.
​
updated_at
string
ISO 8601 timestamp.
const schema = await client.schemas.get("schema_abc123");

console.log(schema.name);
for (const col of schema.columns) {
  console.log(`${col.key}: ${col.type}`);
}

{
  "id": "schema_abc123",
  "name": "Electronics Catalog",
  "description": "Schema for consumer electronics",
  "is_default": false,
  "columns": [
    { "key": "product_name", "label": "Product Name", "type": "text", "required": true },
    { "key": "price", "label": "Price", "type": "number" }
  ],
  "created_at": "2025-03-01T10:00:00.000Z",
  "updated_at": "2025-03-01T10:00:00.000Z"
}