Skip to main content
https://cdn.jsdelivr.net/gh/jdecked/twemoji@latest/assets/svg/1f913.svg
This reference is for the nerds who want to know all the internals.

Common Concepts

Database name — Always "Space/Database" format, e.g. "SoftDev/bug", "Product Management/feature". Names are case-sensitive. Field name — Always "Space/FieldName" format. The space prefix does not necessarily match the database’s own space. Fields inherited from system apps use their own prefixes: user/name, assignments/assignees, workflow/state, comments/comments, icon/icon. Always derive field names from schema_detailed output, never guess them. fibery/id — Internal UUID for an entity (e.g., "5766cc9a-ae80-4893-82d3-db8b78fdfa13"). Required for updates, state changes, and document operations. Retrieved via query. fibery/public-id — Human-readable string ID (e.g., "13961"). Used in web URLs and get_entity_links. System fields — Auto-populated and read-only: fibery/id, fibery/public-id, fibery/creation-date, fibery/modification-date, fibery/created-by, fibery/modified-by. Formula fields — Always read-only. Identified by the formula: comment in schema_detailed output. Typical sequence for entity workschemaschema_detailedquery (to get IDs) → write tools.

Workspace & Schema

schema

Returns the high-level structure of the workspace: all spaces and their databases, without field details. Parameters — None. Returns — All spaces and database names in the workspace. Example output (excerpt)
space SoftDev {
    database SoftDev/Commit
    database SoftDev/Deployment
    database SoftDev/Dev Task
    database SoftDev/bug
}

space Product Management {
    database Product Management/Insight
    database Product Management/Product Area
    database Product Management/feature
}
Note — Call this first before any other tool. It is the source of truth for valid database names.

schema_detailed

Returns field definitions and enum values for specific databases in YAML format. Parameters
NameTypeRequiredDescription
databasesstring[]YesDatabase names in "Space/Database" format
includeRelatedDatabasesbooleanNoAlso include related databases with their fields. Default: false
Returns — Per-database YAML with field names, types, and metadata comments: read-only, formula, collection, UI title, default. Example
{
  "databases": [
    "SoftDev/bug"
  ],
  "includeRelatedDatabases": false
}
Example output (excerpt)
SoftDev/bug: # Bug is an issue in a product.
  fields:
    fibery/id: fibery/uuid                # read-only
    fibery/public-id: fibery/text         # read-only
    fibery/creation-date: fibery/date-time # read-only; default: $now
    user/name: fibery/text                # UI title
    user/Owner: fibery/user               # default: $my-id
    user/urgent: fibery/bool
    user/Product Area: Product Management/Product Area
    user/feature: Product Management/feature
    SoftDev/Regression: fibery/bool
    SoftDev/Created By AI: fibery/bool
    SoftDev/Dev Task: SoftDev/Dev Task
    assignments/assignees: fibery/user    # collection
    workflow/state: workflow/state_SoftDev/bug # default: Icebox
    comments/comments: comments/comment  # collection
Key reading rules for this output
  • Fields marked read-only or formula: cannot be written.
  • Fields marked collection require add_collection_items / remove_collection_items to modify.
  • workflow/state fields require set_state to modify.
  • Collaboration~Documents/Document fields require set_document_content or append_document_content.
  • The field name as shown (including its space prefix) is exactly what goes in q/select, update_entities, etc.

get_me

Returns information about the currently authenticated user. Parameters — None. Returnsfibery/id, user/name, user/email, fibery/role, fibery/admin?. Example output
{
  "fibery/admin?": true,
  "user/email": "michael@fibery.io",
  "fibery/role": "role/admin",
  "fibery/id": "0000000",
  "user/name": "Michael Dubakov"
}

Querying & Searching

query

Executes a Fibery Query API command against any database. Supports field selection, filtering, sorting, pagination, sub-queries, and aggregation. Parameters
NameTypeRequiredDescription
queryobjectYesQuery definition (see below)
paramsobjectNoParameter values referenced in q/where via $param syntax. Default: \{\}
query object fields
FieldTypeRequiredDescription
q/fromstringYesSource database, e.g. "SoftDev/bug"
q/selectobject | string[]YesFields to retrieve
q/wherearrayNoFilter expression
q/order-byarrayNoSort criteria
q/limitnumberNoResults per page. Default: 100. Max: 1000
q/offsetnumberNoResults to skip for pagination. Default: 0
Field selection — basic
{
  "Name": "user/name"
}
Field selection — related entity field
{
  "OwnerName": [
    "user/Owner",
    "user/name"
  ]
}
Field selection — sub-query (q/limit is required)
{
  "Assignees": {
    "q/from": "assignments/assignees",
    "q/select": {
      "Who": "user/name"
    },
    "q/limit": 10
  }
}
Field selection — aggregation
{
  "TotalBugs": [
    "q/count",
    "fibery/id"
  ]
}
Available aggregate functions: q/count, q/sum, q/avg, q/min, q/max. q/sum/q/avg/q/min/q/max require a numeric sub-field: ["q/sum", ["Related Field", "Number Field"]]. Filter operators by field type
Field typeOperators
Number, Date=, !=, <, <=, >, >=, q/null?
Textq/equals-ignoring-case?, q/not-equals-ignoring-case?, q/contains, q/not-contains, q/starts-with-ignoring-case?, q/ends-with-ignoring-case?, q/null-or-empty?
Boolean / null check["=", ["q/null?", ["FieldPath"]], "$boolParam"]
Referenceq/in, q/not-in, q/count
Date-range start/end["q/start", ["FieldPath"]], ["q/end", ["FieldPath"]]
Location["q/address", ["FieldPath"]] — parses to string, then use text operators
Filter combinators q/and and q/or take multiple filter clauses as operands:
["q/and", ["=", ["State"], "$state"], [">", ["Priority"], "$min"]]
Constraint — All filter values in q/where must use $param references. Inline literals will cause an error. Constraintq/limit is required in every sub-query. Example — bugs currently In Progress with assignees
{
  "query": {
    "q/from": "SoftDev/bug",
    "q/select": {
      "Name": [
        "user/name"
      ],
      "Status": [
        "workflow/state",
        "enum/name"
      ],
      "PublicId": [
        "fibery/public-id"
      ],
      "Urgent": [
        "user/urgent"
      ],
      "Assignees": {
        "q/from": "assignments/assignees",
        "q/select": {
          "Who": "user/name"
        },
        "q/limit": 10
      }
    },
    "q/where": [
      "q/equals-ignoring-case?",
      [
        "workflow/state",
        "enum/name"
      ],
      "$status"
    ],
    "q/order-by": [
      [
        [
          "fibery/creation-date"
        ],
        "q/desc"
      ]
    ],
    "q/limit": 20
  },
  "params": {
    "$status": "In Progress"
  }
}
Example output
[
  {
    "Name": "Inline comment icons shift to a wrong position",
    "Status": "In Progress",
    "PublicId": "13959",
    "Urgent": false,
    "Assignees": [
      {
        "Who": "Nastya Karabitskaya"
      }
    ]
  }
]
Example — count all bugs
{
  "query": {
    "q/from": "SoftDev/bug",
    "q/select": [
      "q/count",
      "fibery/id"
    ]
  }
}
Example — recent features with owner and planned dates
{
  "query": {
    "q/from": "Product Management/feature",
    "q/select": {
      "Name": [
        "Product Management/name"
      ],
      "Status": [
        "workflow/state",
        "enum/name"
      ],
      "Owner": [
        "Product Management/owner",
        "user/name"
      ],
      "PlannedDates": [
        "Product Management/planned-dates"
      ]
    },
    "q/order-by": [
      [
        [
          "fibery/creation-date"
        ],
        "q/desc"
      ]
    ],
    "q/limit": 5
  }
}
Example output
[
  {
    "Name": "Handle Large Datasets in Tables",
    "Status": "Icebox",
    "Owner": "Victor Zhuk",
    "PlannedDates": null
  },
  {
    "Name": "Migrate on history v2 routes",
    "Status": "In Progress",
    "Owner": "Eugene Kisel",
    "PlannedDates": null
  }
]
Searches workspace content using BM-25 keyword matching against entity titles, descriptions, document content, and comments. Parameters
NameTypeRequiredDescription
querystringYesSearch query string
databasestringNoLimit results to a specific database
limitnumberNoMax results. Default: 20. Max: 100
viewTypestringNoFilter by view type: document, grid, list, board, timeline, calendar, map, feed, gallery, gantt, form, report
Returns — Matching items with kind ("entity" or "view"), id, publicId, title, score, highlight, space. Note — Highlights use <elastic_highlight> tags around matched terms. Example
{
  "query": "whiteboard",
  "limit": 3
}
Example output
{
  "items": [
    {
      "kind": "entity",
      "id": "78558418-4910-44a0-a19b-3fea99c0553d",
      "publicId": "3193",
      "title": "Whiteboards, Whiteboards, Whiteboards!",
      "score": 1256419.8,
      "highlight": {
        "kind": "title",
        "value": "<elastic_highlight>Whiteboards</elastic_highlight>, ..."
      },
      "space": "Administrative"
    }
  ]
}

search_guide

Retrieves information from the Fibery User Guide via keyword search. Parameters
NameTypeRequiredDescription
querystringYesQuestion or topic to search for
Returns — Sorted list of relevant text fragments from the official Fibery User Guide. Note — Returns platform documentation only; does not search workspace content.

search_history

Searches the workspace activity history for entity and schema changes. Parameters
NameTypeDescription
databasestringFilter by database name
actionsstring[]Filter by action: created, updated, deleted, collectionItemAdded, collectionItemRemoved, archived, restored, permissionsChanged
schemaChangestring[]Filter by schema change: fieldChange, databaseChange, spaceChange
entityIdstring (UUID)Filter by fibery/id
entityPublicIdstringFilter by public ID (requires database)
entityNamestringSubstring match on entity name. Minimum 3 characters
entityStatestring[]Filter by state: EXIST, DELETED, ARCHIVED
authorUserIdstring (UUID)Filter by author’s fibery/id
sincestring (ISO 8601)Start of time range. Default: 24 hours ago
untilstring (ISO 8601)End of time range. Default: now
limitnumberMax items. Default: 50. Max: 100
sinceItemstringCursor from previous result’s sinceItem field, for pagination
Returns — History events. Each event includes id, date, action, url, database, entity (with id, name, publicId), author, fromService, and changes array (each change has field, fieldTitle, to). Example — recent bugs created today
{
  "database": "SoftDev/bug",
  "actions": [
    "created"
  ],
  "limit": 3
}
Example output
{
  "items": [
    {
      "id": "124888481",
      "date": "2026-03-18T15:12:18.183Z",
      "action": "created",
      "url": "https://the.fibery.io/SoftDev/bug/13961",
      "database": "SoftDev/bug",
      "databaseTitle": "Bug",
      "entity": {
        "id": "0000",
        "name": "Links and entities in the embedded view are not clickable",
        "publicId": "13961"
      },
      "author": {
        "id": "d125f600-...",
        "name": "Alex Tsayun"
      },
      "fromService": null,
      "changes": [
        {
          "field": "user/name",
          "fieldTitle": "Name",
          "to": "Links and entities..."
        },
        {
          "field": "user/urgent",
          "fieldTitle": "Urgent",
          "to": "false"
        }
      ]
    }
  ],
  "hasNext": true,
  "sinceItem": "124888481"
}
Example — paginating with sinceItem
{
  "database": "SoftDev/bug",
  "actions": [
    "created"
  ],
  "sinceItem": "124888481",
  "limit": 50
}

query_views

Returns saved views (boards, grids, timelines, documents, etc.) matching optional filters. Parameters
NameTypeDescription
viewTypestringFilter by view type
textstringSearch in view name or description
idstring (UUID)Filter by fibery/id
publicIdstringFilter by public ID
withConfigbooleanInclude view config. Default: true. Set false when returning many results
Returns — View objects: type, name, description, space, config (if requested), and content for document views.

fetch_view_data

Executes a view’s configured query and returns the entities it would display, with the view’s own filters, fields, and sort order applied. Parameters
NameTypeRequiredDescription
publicIdstringYesPublic ID of the view (from query_views)
limitnumberNoMax entities to return. Default: 100
offsetnumberNoEntities to skip. Default: 0
Prerequisite — Call query_views first to find the view’s publicId. Note — Unlike query, this executes the view’s saved configuration rather than a custom query.

Entities

create_entities

Creates one or more entities in a database. Parameters
NameTypeRequiredDescription
databasestringYesFull database name
entitiesobject[]YesArray of field-value maps. Keys in "Space/FieldName" format from schema_detailed
Field value formats
Field typeValue format
Textstring
Number (int, decimal)number
Booleanboolean
DateISO date string: "2026-04-01"
Date-range\{ "start": "YYYY-MM-DD", "end": "YYYY-MM-DD" \} — end date is exclusive
Single-select / single-relationUUID string of the target entity
Location\{ "longitude": number, "latitude": number, "fullAddress": string, "addressParts": \{ "place", "district", "region", "country" \} \}
Constraints
  • fibery/id cannot be set; it is returned after creation.
  • Collaboration~Documents/Document fields: use set_document_content.
  • Collection fields: use add_collection_items.
  • workflow/state: use set_state.
  • Array values are never accepted; use add_collection_items.
Returns — Created entity objects including their generated fibery/id. Example — create a bug
{
  "database": "SoftDev/bug",
  "entities": [
    {
      "user/name": "Form fields lose value on tab switch",
      "user/urgent": true,
      "SoftDev/Regression": false
    }
  ]
}
Example — create a feature with planned dates
{
  "database": "Product Management/feature",
  "entities": [
    {
      "Product Management/name": "Bulk export to CSV",
      "Product Management/planned-dates": {
        "start": "2026-04-01",
        "end": "2026-04-15"
      }
    }
  ]
}

update_entities

Updates specified fields on existing entities. Only provided fields are changed; all other fields are left untouched. Parameters
NameTypeRequiredDescription
databasestringYesFull database name
entitiesobject[]YesField-value maps. Each must include "id" (UUID)
Constraints — Same as create_entities: document fields, collections, and workflow state each have their own dedicated tools. Example — mark a bug as urgent
{
  "database": "SoftDev/bug",
  "entities": [
    {
      "id": "5766cc9a-ae80-4893-82d3-db8b78fdfa13",
      "user/urgent": true
    }
  ]
}

delete_entities

Permanently deletes entities by their UUIDs. This action cannot be undone. Parameters
NameTypeRequiredDescription
databasestringYesFull database name
idsstring[] (UUID)YesArray of fibery/id values
Prerequisite — Use query to find entity IDs before deleting.

set_state

Sets the workflow/state of a single entity. Parameters
NameTypeRequiredDescription
databasestringYesFull database name
entityIdstring (UUID)Yesfibery/id of the entity
statestringYesState name, e.g. "In Progress", "Done", "Won't Fix"
Note — Only one workflow field exists per database. Available state names come from schema_detailed under the workflow/state field’s values: section. Example — move bug to Done
{
  "database": "SoftDev/bug",
  "entityId": "5766cc9a-ae80-4893-82d3-db8b78fdfa13",
  "state": "Done"
}
Available states for SoftDev/bug (from live schema): Icebox, Ready for Dev, In Progress, Implemented, In Testing, Tested, Done, Won't Fix Available states for Product Management/feature (from live schema): Icebox, Next, Ready for Dev, In Progress, Implemented, In Testing, Tested, Done, Abandoned Generates Fibery web links for entities by their public IDs. Parameters
NameTypeRequiredDescription
databasestringYesFull database name
entityPublicIdsstring[]YesArray of public ID strings (e.g., ["13961", "13960"])
Note — Public IDs are strings like "13961", not UUIDs. Retrieve them via query by selecting "fibery/public-id". Example
{
  "database": "SoftDev/bug",
  "entityPublicIds": [
    "13961",
    "13960"
  ]
}

Documents

get_documents_content

Returns the Markdown content of one or more entity documents by their secrets. Parameters
NameTypeRequiredDescription
secretsstring[]YesDocument secrets
reducePromptstringNoSummarization instruction for large documents. Default: "Summarize this document in 2-3 paragraphs max."
How to get a document secret — Query the entity and select the document field’s secret path:
{
  "query": {
    "q/from": "SoftDev/bug",
    "q/select": {
      "Name": [
        "user/name"
      ],
      "DocSecret": [
        "user/Description",
        "Collaboration~Documents/secret"
      ]
    },
    "q/limit": 1
  }
}

set_document_content

Replaces the full content of a Collaboration~Documents/Document field on an entity. Parameters
NameTypeRequiredDescription
databasestringYesFull database name
fieldstringYesDocument field name (e.g., "user/Description", "Product Management/description")
entityIdstring (UUID)Yesfibery/id of the entity
contentstringYesFull replacement content in Markdown. "" clears the document
Supported Markdown extensions — Standard Markdown plus Fibery callouts:
> [//]: # (callout;icon-type=icon;icon=info-circle;color=#199EE3)
> Callout body here
Example — set a bug description
{
  "database": "SoftDev/bug",
  "field": "user/Description",
  "entityId": "5766cc9a-ae80-4893-82d3-db8b78fdfa13",
  "content": "## Steps to Reproduce\n\n1. Open any embedded view\n2. Enter lock mode\n3. Click a link\n\n## Expected\nLink opens. **Actual:** Nothing happens."
}

append_document_content

Appends Markdown content to the end of an existing document field. Does not replace existing content. Parameters
NameTypeRequiredDescription
databasestringYesFull database name
fieldstringYesDocument field name
entityIdstring (UUID)Yesfibery/id of the entity
contentstringYesMarkdown content to append

Collections

add_collection_items

Adds items to an entity’s collection field (e.g., assignees, tags, linked bugs). Parameters
NameTypeRequiredDescription
databasestringYesFull database name
fieldstringYesCollection field name (e.g., "assignments/assignees", "user/bugs")
entityIdstring (UUID)Yesfibery/id of the entity
itemsstring[] (UUID)Yesfibery/id values to add
Example — assign a user to a bug
{
  "database": "SoftDev/bug",
  "field": "assignments/assignees",
  "entityId": "5766cc9a-ae80-4893-82d3-db8b78fdfa13",
  "items": [
    "1d525780-5dcb-11e8-90b6-c6e140253257"
  ]
}

remove_collection_items

Removes items from an entity’s collection field. Parameters
NameTypeRequiredDescription
databasestringYesFull database name
fieldstringYesCollection field name
entityIdstring (UUID)Yesfibery/id of the entity
itemsstring[] (UUID)Yesfibery/id values to remove

Spaces

create_space

Creates a new space in the workspace. Parameters
NameTypeRequiredDescription
namestringYesSpace name. Letters, numbers, and spaces only
descriptionstringNoSpace description
colorstringNoHex color code, e.g. "#4CAF50"
Prerequisite — Call schema to check for name conflicts. Example
{
  "name": "Engineering",
  "description": "Engineering projects and tasks",
  "color": "#2978FB"
}

delete_space

Deletes a space and all its databases. Restorable via Activity Log. Parameters
NameTypeRequiredDescription
namestringYesExact space name
Constraint — System spaces (fibery/user, fibery/file, comments, highlights, vacations) cannot be deleted.

Databases

create_databases

Creates one or more databases within existing spaces. Parameters
NameTypeRequiredDescription
databasesobject[]YesArray of database definitions
Database definition
NameTypeRequiredDescription
namestringYes"Space/Database" format. Space must already exist
descriptionstringNoDatabase description
colorstringNoHex color code
Auto-created fieldsfibery/id, fibery/public-id, system timestamps, \{Space\}/Name, \{Space\}/Description. Constraint — Names may contain only letters, numbers, and spaces. No /, \, ., &, ?, !, etc. Example
{
  "databases": [
    {
      "name": "SoftDev/Sprint",
      "description": "Two-week development sprints",
      "color": "#673db6"
    }
  ]
}

rename_databases

Renames one or more databases. Changing the space prefix moves the database to a different space. Parameters
NameTypeRequiredDescription
databasesobject[]YesArray of rename operations
Rename operation
NameTypeRequiredDescription
oldNamestringYesCurrent full database name
newNamestringYesNew full database name
Note — Fibery automatically updates formula and relation references after rename. External API scripts using the old name will break.

delete_databases

Deletes one or more databases. Restorable via Activity Log. Parameters
NameTypeRequiredDescription
databasesstring[]YesArray of full database names

Fields

Naming restrictions (all field types)

Field names may contain only letters, numbers, and spaces. Special characters (/, \, ., &, ,, ?, !, etc.) are not allowed in user-created names.

create_primitive_fields

Creates one or more primitive (scalar) fields in databases. Parameters
NameTypeRequiredDescription
fieldsobject[]YesArray of field definitions
Field definition
NameTypeRequiredDescription
databasestringYesFull database name
namestringYes"Space/FieldName" — space must match the database’s space
fieldTypestringYesSee types below
descriptionstringNoField description
metaobjectNoField-type-specific metadata
Supported fieldType values
TypeDescriptionKey meta options
fibery/textTextui/type: "text", "email", "url", "phone"
fibery/intInteger
fibery/decimalDecimalui/number-format: "Number", "Money", "Percent"; ui/number-currency-code (ISO 4217); ui/number-precision: 0–8; ui/number-thousand-separator?; ui/number-unit
fibery/boolCheckbox
fibery/dateDate
fibery/date-timeDate and time
fibery/date-rangeDate range
fibery/date-time-rangeDate and time range
fibery/locationLocation/address
Collaboration~Documents/DocumentRich text document
Example — add a URL field and a money field to bugs
{
  "fields": [
    {
      "database": "SoftDev/bug",
      "name": "SoftDev/Reproduction Link",
      "fieldType": "fibery/text",
      "meta": {
        "ui/type": "url"
      }
    },
    {
      "database": "SoftDev/bug",
      "name": "SoftDev/Fix Cost",
      "fieldType": "fibery/decimal",
      "meta": {
        "ui/number-format": "Money",
        "ui/number-currency-code": "USD",
        "ui/number-precision": 2
      }
    }
  ]
}

rename_fields

Renames one or more fields. Parameters
NameTypeRequiredDescription
fieldsobject[]YesRename operations
Rename operation
NameTypeRequiredDescription
databasestringYesFull database name
oldNamestringYesCurrent field name
newNamestringYesNew field name (same "Space/" prefix, different suffix)

delete_fields

Deletes one or more fields. Restorable via Activity Log. Parameters
NameTypeRequiredDescription
fieldsobject[]YesField references
Field reference
NameTypeRequiredDescription
databasestringYesFull database name
fieldstringYesField name in "Space/Field" format
Note — Deleting a relation field also removes its counterpart in the related database.

create_relation_fields

Creates a relation between two databases. One relation definition creates a field in both databases. Parameters
NameTypeRequiredDescription
fieldsobject[]YesRelation definitions
Relation definition
NameTypeRequiredDescription
databasestringYesSource database
relationDatabasestringYesTarget database
namestringYesField name in source database
relationFieldNamestringYesField name in target database. Use "user/FieldName" prefix when target is fibery/user
cardinalitystringYes"one-to-one", "one-to-many", "many-to-one", "many-to-many"
descriptionstringNoField description
Example — link bugs to customer requests
{
  "fields": [
    {
      "database": "SoftDev/bug",
      "relationDatabase": "Customer Success/Customer Request",
      "name": "SoftDev/Customer Requests",
      "relationFieldName": "Customer Success/Related Bugs",
      "cardinality": "many-to-many"
    }
  ]
}

create_single_select_fields

Creates one or more single-select fields with predefined options. Parameters
NameTypeRequiredDescription
fieldsobject[]YesField definitions
Field definition
NameTypeRequiredDescription
databasestringYesFull database name
namestringYesField name
optionsobject[]YesOptions: \{ "name": string, "color"?: string, "icon"?: string, "value"?: number \}
defaultOptionstringNoOption name to use as default for new entities
allowNumberValueForOptionbooleanNoEnable numeric values per option. Default: false
Example — add severity field to bugs
{
  "fields": [
    {
      "database": "SoftDev/bug",
      "name": "SoftDev/Severity",
      "options": [
        {
          "name": "Critical",
          "color": "#d40915"
        },
        {
          "name": "High",
          "color": "#fc551f"
        },
        {
          "name": "Medium",
          "color": "#fba32f"
        },
        {
          "name": "Low",
          "color": "#99a2ab"
        }
      ],
      "defaultOption": "Medium"
    }
  ]
}

update_single_select_fields

Updates options of existing single-select fields. Parameters
NameTypeRequiredDescription
fieldsobject[]YesUpdate operations
Update operation
NameTypeRequiredDescription
databasestringYesFull database name
namestringYesField name
updateobjectYesFull replacement: \{ "options": [...] \}. Incremental: \{ "addOptions": [...], "updateOptions": [...], "removeOptions": ["name"] \}
defaultOptionstring | nullNoNew default option. null clears the default
Note — Incremental operations execute in order: remove → update → add. updateOptions matches by name; it can change color, icon, or numeric value, but not the option name itself.

create_multi_select_fields

Creates one or more multi-select fields. Same parameters as create_single_select_fields, without defaultOption.

update_multi_select_fields

Updates options of existing multi-select fields. Same parameters as update_single_select_fields, without defaultOption.

create_workflow_field

Creates a workflow (state) field for tracking entities through lifecycle stages. Parameters
NameTypeRequiredDescription
databasestringYesFull database name
optionsobject[]YesStates: \{ "name": string, "type": "Not started" | "Started" | "Finished", "color"?: string \}
defaultOptionstringYesState name for new entities
Constraint — Only one workflow field per database. Always addressed as "workflow/state" in queries. Example — add workflow to a new database
{
  "database": "SoftDev/Sprint",
  "options": [
    {
      "name": "Planning",
      "type": "Not started",
      "color": "#99a2ab"
    },
    {
      "name": "Active",
      "type": "Started",
      "color": "#8ec351"
    },
    {
      "name": "Review",
      "type": "Started",
      "color": "#fba32f"
    },
    {
      "name": "Done",
      "type": "Finished",
      "color": "#4a4a4a"
    }
  ],
  "defaultOption": "Planning"
}

update_workflow_field

Updates the states of an existing workflow field. Parameters
NameTypeRequiredDescription
databasestringYesFull database name
updateobjectYesFull replacement: \{ "options": [...] \}. Incremental: \{ "addOptions": [...], "updateOptions": [...], "removeOptions": [...] \}
defaultOptionstringNoNew default state. Unchanged if not provided
Constraint — The current default state cannot be removed until a new default is set.

delete_workflow_field

Deletes the workflow field from a database. Restorable via Activity Log. Parameters
NameTypeRequiredDescription
databasestringYesFull database name

create_formula_field

Creates a calculated formula field. The formula expression is generated automatically from a natural-language description. Parameters
NameTypeRequiredDescription
databasestringYesFull database name
namestringYesField name in "Space/Field" format
descriptionstringYesNatural-language description of what to calculate
Note — Formula fields are always read-only. The generated formula appears in schema_detailed under the formula: comment. Example — count open bugs per feature
{
  "database": "Product Management/feature",
  "name": "Product Management/Open Bug Count",
  "description": "Count of linked bugs whose state is not Done, Tested, or Won't Fix"
}

update_formula_field

Updates an existing formula field by regenerating its expression. The new formula must produce a compatible type with the existing field. Parameters
NameTypeRequiredDescription
databasestringYesFull database name
namestringYesName of the existing formula field
descriptionstringYesNew description for the formula

create_files_fields

Creates file attachment fields. Parameters
NameTypeRequiredDescription
fieldsobject[]YesField definitions
Field definition
NameTypeRequiredDescription
databasestringYesFull database name
namestringYesField name
allowMultipleFilesbooleanYesAllow multiple attachments
descriptionstringNoField description

create_avatars_fields

Enables avatar/profile picture attachments on entities. Creates an "avatar/avatars" field automatically. Parameters
NameTypeRequiredDescription
databasesstring[]YesFull database names

delete_avatars_fields

Removes the "avatar/avatars" field. Restorable via Activity Log. Parameters
NameTypeRequiredDescription
databasesstring[]YesFull database names

create_comments_fields

Enables comments on entities. Creates a "comments/comments" field automatically. Parameters
NameTypeRequiredDescription
databasesstring[]YesFull database names

delete_comments_fields

Removes the "comments/comments" field. Restorable via Activity Log. Parameters
NameTypeRequiredDescription
databasesstring[]YesFull database names

create_icon_fields

Enables emoji icons on entities. Creates an "icon/icon" field automatically. Parameters
NameTypeRequiredDescription
databasesstring[]YesFull database names

delete_icon_fields

Removes the "icon/icon" field. Restorable via Activity Log. Parameters
NameTypeRequiredDescription
databasesstring[]YesFull database names

Views

create_view

Creates a new view in the workspace. Parameters
NameTypeRequiredDescription
viewTypestringYesSee view types below
namestringYesView name
configobjectNoView configuration (structure varies by type)
contentstringNoMarkdown content (document views only)
descriptionstringNoShort Markdown description
spacestringNoSpace to create the view in. Defaults to inferred from databases in config. Use "Private" for private space
View types
TypeDescription
gridSpreadsheet-like table, supports hierarchical grouping
listSimple linear list
boardKanban board, grouped by relation or enum field
timelineHorizontal time-bar view
calendarDate-based calendar
mapGeographic map (requires location fields)
feedRich-text document feed
galleryCard gallery with optional cover images
ganttHierarchical grid + timeline
formData-entry form for creating entities
documentStandalone rich-text document
FieldUnit format (used in fields arrays inside config)
{
  "field": "Space/FieldName",
  "showCount": true
}
"db-badge" and "db-badge-abbr" are also valid field values. FilterNode nodeType values and their operators
nodeTypeOperators
textcontains, does-not-contain, is, is-not, starts-with, ends-with, is-empty, is-not-empty
numberequals, does-not-equal, greater-than, greater-than-or-equal, less-than, less-than-or-equal, is-empty, is-not-empty
boolis
dateis, is-before, is-after, is-on-or-before, is-on-or-after, is-empty, is-not-empty
referenceis-empty, is-not-empty
collectionis-empty, is-not-empty, contains-me, does-not-contain-me
single-selectis, is-not, is-any-of, is-none-of, is-empty, is-not-empty
workflowis, is-not, is-any-of, is-none-of, is-empty, is-not-empty
multi-selectis-empty, is-not-empty, contains-any-of, contains-none-of, contains, does-not-contain
logicalCombines filters with and / or
For single-select and workflow filter values, pass arrays of option/state UUIDs. For date-range field paths, use ["q/start", "Space/Dates"]. Config structure by view type
  • grid / listitems[] (ItemConfig with optional groupBy), rowHeight ("short", "medium", "tall", "extra-tall"), hideEmptyParentGroups
  • boardx[] (AxisConfig, required), y[] (optional), items[], cardSize ("compact", "comfortable", "spacious")
  • timeline / ganttitems[] with startDate, endDate, dependencyField; milestones[]; dependencyDateShiftingMode ("none", "consume-gap", "preserve-gap")
  • calendaritems[] with startDate, endDate
  • mapitems[] with location; style ("default", "muted", "satellite")
  • feeditems[] with post (document field); postWidth ("narrow", "medium", "full")
  • galleryitems[] with cover (file field), fillCover; cardSize ("compact", "medium", "full")
  • formdatabase, fields[] with field, displayName, required, description, hidden, defaultValue
  • document — No config needed; use content parameter
AxisConfig (board, timeline, gallery) — extends ItemConfig with forDatabase, field (relation or enum field only), hideEmptyLanes.

update_view

Updates an existing view. Only provided fields are changed. Parameters
NameTypeRequiredDescription
viewTypestringYesView type (required for routing)
idstring (UUID)Yesfibery/id of the view (from query_views)
namestringNoNew name
descriptionstringNoNew description
configobjectNoUpdated configuration
contentstringNoNew Markdown content (document views only)
appendbooleanNoIf true, appends content instead of replacing (document views only)
spacestringNoMove the view to a different space

delete_views

Deletes views by UUID. Entity data is not affected. Restorable via Activity Log. Parameters
NameTypeRequiredDescription
idsstring[] (UUID)YesView fibery/id values

Files & Import

add_file_from_url

Downloads a file from a URL and attaches it to an entity’s file field. Parameters
NameTypeRequiredDescription
databasestringYesFull database name
fieldstringYesFile field name (e.g., "Files/Files")
entityIdstring (UUID)Yesfibery/id of the entity
urlstring (URI)YesHTTPS URL to download from
fileNamestringYesName to assign the attached file
Example
{
  "database": "SoftDev/bug",
  "field": "Files/Files",
  "entityId": "5766cc9a-ae80-4893-82d3-db8b78fdfa13",
  "url": "https://example.com/screenshots/bug-13961.png",
  "fileName": "bug-13961-screenshot.png"
}

get_connectors_list

Returns all available built-in connectors (import integrations) in the workspace. Parameters — None. Returns — Connectors with name, id, and supported modes (one-time import and/or continuous sync). Note — When the desired source is not listed, use the csv connector as a fallback. Generates a URL to the Fibery import wizard for a given connector and target. Parameters
NameTypeRequiredDescription
spaceNamestringYesTarget space name
isSyncbooleanYestrue for continuous sync; false for one-time import
connectorIdstringYesConnector ID from get_connectors_list
dbNamestringNoExisting database name to import into. Omit to create a new database
Prerequisite — Call get_connectors_list first to obtain valid connectorId values.

Tool Quick Reference

ToolCategoryDescription
get_meWorkspaceCurrent user info
schemaWorkspaceAll spaces and databases
schema_detailedWorkspaceFields, types, enums for specific databases
queryQueryingFlexible entity query with filtering, sorting, pagination, sub-queries
searchQueryingBM-25 keyword search across workspace content
search_guideQueryingSearch the Fibery User Guide documentation
search_historyQueryingActivity log: creates, updates, deletes, schema changes
query_viewsQueryingFind saved views by type or name
fetch_view_dataQueryingExecute a saved view’s query and return its entities
create_entitiesEntitiesCreate new entities
update_entitiesEntitiesUpdate entity fields
delete_entitiesEntitiesPermanently delete entities
set_stateEntitiesSet workflow/state
get_entity_linksEntitiesGenerate web links by public ID
get_documents_contentDocumentsRead document field content as Markdown
set_document_contentDocumentsReplace full document field content
append_document_contentDocumentsAppend to document field content
add_collection_itemsCollectionsAdd items to a collection field
remove_collection_itemsCollectionsRemove items from a collection field
create_spaceSpacesCreate a new space
delete_spaceSpacesDelete a space and all its databases
create_databasesDatabasesCreate new databases in a space
rename_databasesDatabasesRename or move databases between spaces
delete_databasesDatabasesDelete databases
create_primitive_fieldsFieldsCreate scalar fields (text, number, date, bool, etc.)
rename_fieldsFieldsRename fields
delete_fieldsFieldsDelete fields
create_relation_fieldsFieldsCreate relations between databases
create_single_select_fieldsFieldsCreate single-select enum fields
update_single_select_fieldsFieldsAdd, update, or remove single-select options
create_multi_select_fieldsFieldsCreate multi-select enum fields
update_multi_select_fieldsFieldsAdd, update, or remove multi-select options
create_workflow_fieldFieldsCreate a workflow/state field
update_workflow_fieldFieldsAdd, update, or remove workflow states
delete_workflow_fieldFieldsDelete the workflow field
create_formula_fieldFieldsCreate a calculated formula field from a description
update_formula_fieldFieldsUpdate a formula field’s expression
create_files_fieldsFieldsCreate file attachment fields
create_avatars_fieldsFieldsEnable avatar attachments on entities
delete_avatars_fieldsFieldsDisable avatar attachments
create_comments_fieldsFieldsEnable comments on entities
delete_comments_fieldsFieldsDisable comments
create_icon_fieldsFieldsEnable emoji icons on entities
delete_icon_fieldsFieldsDisable emoji icons
create_viewViewsCreate a new view
update_viewViewsUpdate an existing view
delete_viewsViewsDelete views
add_file_from_urlFilesDownload and attach a file to an entity
get_connectors_listImportList available import connectors
get_import_linkImportGenerate an import wizard URL