Schema

Learn how to read the workspace schema using the Fibery API.

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

The API uses type for Database and app for Space. See Terminology.

Get Schema

Get all Databases, Fields and their metadata.

Take a look at the Databases and Fields sections for the metadata description.

Fibery Schema for a typical workspace takes a few hundred kilobytes.

Command parameters

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

JavaScript

const response = await fetch('https://YOUR_ACCOUNT.fibery.io/api/commands', {
  method: 'POST',
  headers: {
    'Authorization': 'Token YOUR_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ command: 'fibery.schema/query' })
});
const data = await response.json();

Response:

{
  "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 Databases
    ],
    "fibery/meta": {
      "fibery/version": "1.0.62",
      "fibery/rel-version": "1.0.6",
      "fibery/maintenance?": false,
      "maintenance?": false
    }
  }
}