Skip to main content
Objects are the schema layer of Supersonic. Every entity in your CRM (companies, contacts, deals, projects) is an object type with configurable fields.

​
Tools

ToolDescriptionKey Params
objects.listList all object types in the workspace—
objects.getGet a single object type by slugslug
objects.createCreate a new object typename, slug, icon
objects.updateUpdate an object type’s name or settingsslug, name, icon
objects.add_fieldAdd a field to an object typeslug, name, field_type, config
objects.update_fieldUpdate a field’s name, type, or configslug, field_id, name, config
objects.remove_fieldRemove a field from an object typeslug, field_id

​
Field Types

text number decimal currency date datetime boolean email url phone select multi_select relation
Use select or multi_select with a config.options array to define dropdown choices. Use relation to link object types together.

​
Examples

​
Create a “Deals” object type and add fields

{
  "tool": "objects.create",
  "params": {
    "name": "Deals",
    "slug": "deals",
    "icon": "dollar-sign"
  }
}

​
List all object types

{
  "tool": "objects.list",
  "params": {}
}
Response: 
{
  "success": true,
  "data": [
    { "slug": "companies", "name": "Companies", "field_count": 12 },
    { "slug": "contacts", "name": "Contacts", "field_count": 9 },
    { "slug": "deals", "name": "Deals", "field_count": 7 }
  ]
}