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 work — schema → schema_detailed → query (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)
schema_detailed
Returns field definitions and enum values for specific databases in YAML format.
Parameters
Returns — Per-database YAML with field names, types, and metadata comments:
read-only, formula, collection, UI title, default.
Example
- Fields marked
read-onlyorformula:cannot be written. - Fields marked
collectionrequireadd_collection_items/remove_collection_itemsto modify. workflow/statefields requireset_stateto modify.Collaboration~Documents/Documentfields requireset_document_contentorappend_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.
Returns — fibery/id, user/name, user/email, fibery/role, fibery/admin?.
Example output
Querying & Searching
query
Executes a Fibery Query API command against any database. Supports field selection, filtering, sorting, pagination, sub-queries, and aggregation.
Parameters
query object fields
Field selection — basic
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
Filter combinators
q/and and q/or take multiple filter clauses as operands:
q/where must use $param references. Inline literals will cause an error.
Constraint — q/limit is required in every sub-query.
Example — bugs currently In Progress with assignees
search
Searches workspace content using BM-25 keyword matching against entity titles, descriptions, document content, and comments.
Parameters
Returns — Matching items with
kind ("entity" or "view"), id, publicId, title, score, highlight, space.
Note — Highlights use <elastic_highlight> tags around matched terms.
Example
search_guide
Retrieves information from the Fibery User Guide via keyword search.
Parameters
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
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
query_views
Returns saved views (boards, grids, timelines, documents, etc.) matching optional filters.
Parameters
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
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
Field value formats
Constraints
fibery/idcannot be set; it is returned after creation.Collaboration~Documents/Documentfields: useset_document_content.- Collection fields: use
add_collection_items. workflow/state: useset_state.- Array values are never accepted; use
add_collection_items.
fibery/id.
Example — create a bug
update_entities
Updates specified fields on existing entities. Only provided fields are changed; all other fields are left untouched.
Parameters
Constraints — Same as
create_entities: document fields, collections, and workflow state each have their own dedicated tools.
Example — mark a bug as urgent
delete_entities
Permanently deletes entities by their UUIDs. This action cannot be undone.
Parameters
Prerequisite — Use
query to find entity IDs before deleting.
set_state
Sets the workflow/state of a single entity.
Parameters
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
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
get_entity_links
Generates Fibery web links for entities by their public IDs.
Parameters
Note — Public IDs are strings like
"13961", not UUIDs. Retrieve them via query by selecting "fibery/public-id".
Example
Documents
get_documents_content
Returns the Markdown content of one or more entity documents by their secrets.
Parameters
How to get a document secret — Query the entity and select the document field’s secret path:
set_document_content
Replaces the full content of a Collaboration~Documents/Document field on an entity.
Parameters
Supported Markdown extensions — Standard Markdown plus Fibery callouts:
append_document_content
Appends Markdown content to the end of an existing document field. Does not replace existing content.
Parameters
Collections
add_collection_items
Adds items to an entity’s collection field (e.g., assignees, tags, linked bugs).
Parameters
Example — assign a user to a bug
remove_collection_items
Removes items from an entity’s collection field.
Parameters
Spaces
create_space
Creates a new space in the workspace.
Parameters
Prerequisite — Call
schema to check for name conflicts.
Example
delete_space
Deletes a space and all its databases. Restorable via Activity Log.
Parameters
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
Database definition
Auto-created fields —
fibery/id, fibery/public-id, system timestamps, \{Space\}/Name, \{Space\}/Description.
Constraint — Names may contain only letters, numbers, and spaces. No /, \, ., &, ?, !, etc.
Example
rename_databases
Renames one or more databases. Changing the space prefix moves the database to a different space.
Parameters
Rename operation
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
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
Field definition
Supported
fieldType values
Example — add a URL field and a money field to bugs
rename_fields
Renames one or more fields.
Parameters
Rename operation
delete_fields
Deletes one or more fields. Restorable via Activity Log.
Parameters
Field reference
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
Relation definition
Example — link bugs to customer requests
create_single_select_fields
Creates one or more single-select fields with predefined options.
Parameters
Field definition
Example — add severity field to bugs
update_single_select_fields
Updates options of existing single-select fields.
Parameters
Update operation
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
Constraint — Only one workflow field per database. Always addressed as
"workflow/state" in queries.
Example — add workflow to a new database
update_workflow_field
Updates the states of an existing workflow field.
Parameters
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
create_formula_field
Creates a calculated formula field. The formula expression is generated automatically from a natural-language description.
Parameters
Note — Formula fields are always read-only. The generated formula appears in
schema_detailed under the formula: comment.
Example — count open bugs per feature
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
create_files_fields
Creates file attachment fields.
Parameters
Field definition
create_avatars_fields
Enables avatar/profile picture attachments on entities. Creates an "avatar/avatars" field automatically.
Parameters
delete_avatars_fields
Removes the "avatar/avatars" field. Restorable via Activity Log.
Parameters
create_comments_fields
Enables comments on entities. Creates a "comments/comments" field automatically.
Parameters
delete_comments_fields
Removes the "comments/comments" field. Restorable via Activity Log.
Parameters
create_icon_fields
Enables emoji icons on entities. Creates an "icon/icon" field automatically.
Parameters
delete_icon_fields
Removes the "icon/icon" field. Restorable via Activity Log.
Parameters
Views
create_view
Creates a new view in the workspace.
Parameters
View types
FieldUnit format (used in fields arrays inside config)
"db-badge" and "db-badge-abbr" are also valid field values.
FilterNode nodeType values and their operators
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 / list —
items[](ItemConfig with optionalgroupBy),rowHeight("short","medium","tall","extra-tall"),hideEmptyParentGroups - board —
x[](AxisConfig, required),y[](optional),items[],cardSize("compact","comfortable","spacious") - timeline / gantt —
items[]withstartDate,endDate,dependencyField;milestones[];dependencyDateShiftingMode("none","consume-gap","preserve-gap") - calendar —
items[]withstartDate,endDate - map —
items[]withlocation;style("default","muted","satellite") - feed —
items[]withpost(document field);postWidth("narrow","medium","full") - gallery —
items[]withcover(file field),fillCover;cardSize("compact","medium","full") - form —
database,fields[]withfield,displayName,required,description,hidden,defaultValue - document — No config needed; use
contentparameter
forDatabase, field (relation or enum field only), hideEmptyLanes.
update_view
Updates an existing view. Only provided fields are changed.
Parameters
delete_views
Deletes views by UUID. Entity data is not affected. Restorable via Activity Log.
Parameters
Files & Import
add_file_from_url
Downloads a file from a URL and attaches it to an entity’s file field.
Parameters
Example
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.
get_import_link
Generates a URL to the Fibery import wizard for a given connector and target.
Parameters
Prerequisite — Call
get_connectors_list first to obtain valid connectorId values.
