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 endpoint returns a single database schema by id.

Gets database schema by id

get

Authorizations

Bearer

HTTPRequired

JWT Bearer Authorization

Query parameters

Idstring · nullableRequired

Schema id from get_database_schemas.

versioninteger · int32 · nullableOptional

Optional published version number to pin; omit for the latest published version.

Header parameters

norbix-project-idstring · nullableRequired

ID of your project. Can be passed in a header as norbix-project-id.

norbix-envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

CultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

TimeZoneIdstring · nullableOptional

TimeZone

CorrelationIdstring · nullableOptional

CorrelationId for each request

Responses

200

OK

application/json

get/{version}/database/schemas/{id}

HTTPcURLJavaScriptPython

GET /{version}/database/schemas/{id}?Id=text HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "item": {
    "viewId": "text",
    "schemaName": "text",
    "schemaSlug": "text",
    "version": 10,
    "metaSchemaVersion": 10,
    "publishedAt": "text",
    "triggers": []
  }
}

In the dashboard

Manage this visually in Norbix Cloud — see Database.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Get Database Schema in the SDK reference, with examples in every language.