Get Database Schema

Gets database schema by id.

A schema defines a collection's fields, types, and validation. Schemas support drafts, versions, and publishing. This method returns a single database schema by id.

This method is on the runtime API surface (norbix.api.database) — call it from your app.

These examples assume the SDK is installed and your credentials are set as environment variables — each client reads them automatically, so the constructors below take no arguments. See Install a Norbix SDK.

JavaScript / TypeScript

import { Norbix } from '@norbix.ai/ts';
const norbix = new Norbix();

const result = await norbix.api.database.getDatabaseSchema({
  id: 'sch_4kX9mQvR2tYw7ZbC1dFgHj',
});

.NET

using Norbix.Sdk;
using Norbix.Sdk.Types.Api;

using var client = new NorbixClient();

var result = await client.Database.GetDatabaseSchemaAsync(new GetDatabaseSchemaRequest
{
    Id = "sch_4kX9mQvR2tYw7ZbC1dFgHj",
});

Python

from norbix_python import NorbixApi

norbix = NorbixApi()

result = norbix.database.get_database_schema(
    id="sch_4kX9mQvR2tYw7ZbC1dFgHj",
)

Go

c, _ := norbix.New(norbix.Options{})
ctx := context.Background()

var result map[string]any
err := c.API.Database.GetDatabaseSchema(ctx, "sch_4kX9mQvR2tYw7ZbC1dFgHj", nil, &result)

Dart / Flutter

import 'package:norbix/norbix_api.dart';

final api = NorbixApi();

final result = await api.database.getDatabaseSchema(id: 'sch_4kX9mQvR2tYw7ZbC1dFgHj');

Swift

import NorbixSwift

let client = Norbix()

let result = try await client.api.database.getDatabaseSchema([
    "id": "sch_4kX9mQvR2tYw7ZbC1dFgHj",
])

Kotlin

import dev.norbix.sdk.api.NorbixApi

val api = NorbixApi()

val result = api.database.getDatabaseSchema(mapOf(
    "id" to "sch_4kX9mQvR2tYw7ZbC1dFgHj",
))

CLI

norbix db schema sch_4kX9mQvR2tYw7ZbC1dFgHj

In the dashboard

Manage this visually in Norbix Cloud — see Database → Schemas.

API reference

Full request and response for this endpoint: Get Database Schema.