Schema API

Guide

Fibery Schema is the metadata describing Types (Databases) and their Fields. Basically, it's everything you see on the Workspace Map screen and a few auxiliary Types (Databases):

Screenshot 2024-01-12 at 12.36.30 PM.png

Get Schema

Get all Types (Databases), Fields and their metadata.

In Fibery UI Type = Database, App=Space. To find out why, check Terminology.

Take a look at the Type and Field sections for the metadata description.

Fibery Schema for a median account takes a few hundred kilobytes.

Command parameters

Parameter (required in bold)	Default	Description	Example
`with-description?`	false	Whether to include type descriptions in response	true

# JavaScript

const Fibery = require('fibery-unofficial');
const fibery = new Fibery({host: "YOUR_ACCOUNT.fibery.io", token: YOUR_TOKEN});
const schema = await fibery.getSchema();

# cURL

curl -X POST https://YOUR_ACCOUNT.fibery.io/api/commands \
  -H 'Authorization: Token YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{ "command": "fibery.schema/query" }'

Result (cURL):


{
  "success": true,
  "result": {
    "fibery/id": "fd5d9550-3779-11e9-9162-04d77e8d50cb",
    "fibery/types": [
      {
        "fibery/name": "software-development/user-story",
        "fibery/fields": [
          {
            "fibery/name": "fibery/modification-date",
            "fibery/type": "fibery/date-time",
            "fibery/meta": {
              "fibery/modification-date?": true,
              "fibery/readonly?": true,
              "fibery/default-value": "$now",
              "fibery/secured?": false,
              "fibery/required?": true,
              "ui/object-editor-order": 8
            },
            "fibery/id": "e36a91b1-3f4b-11e9-8051-8fb5f642f8a5"
          },
          {
            "fibery/name": "assignments/assignees",
            "fibery/type": "fibery/user",
            "fibery/meta": {
              "fibery/collection?": true,
              "ui/object-editor-order": 4,
              "fibery/relation": "c3e75ca4-8d15-11e9-b98a-9abbdf4720ab"
            },
            "fibery/id": "2cd92374-3839-11e9-9162-04d77e8d50cb"
          }
          #...other Fields
        ],
        "fibery/meta": {
          "fibery/primitive?": false,
          "fibery/domain?": true,
          "ui/color": "#068cba",
          "app/mixins": {
            "fibery/rank-mixin": true,
            "assignments/assignments-mixin": true,
            "Files/Files-mixin": true,
            "workflow/workflow": true,
            "comments/comments-mixin": true
          },
          "fibery/secured?": true
        },
        "fibery/id": "2c4213ae-3839-11e9-9162-04d77e8d50cb"
      }
      #...other Types
    ],
    "fibery/meta": {
      "fibery/version": "1.0.62",
      "fibery/rel-version": "1.0.6",
      "fibery/maintenance?": false,
      "maintenance?": false
    }
  }
}