Objects

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

Tools

Tool	Description	Key Params
`objects.list`	List all object types in the workspace	—
`objects.get`	Get a single object type by slug	`slug`
`objects.create`	Create a new object type	`name`, `slug`, `icon`
`objects.update`	Update an object type’s name or settings	`slug`, `name`, `icon`
`objects.add_field`	Add a field to an object type	`slug`, `name`, `field_type`, `config`
`objects.update_field`	Update a field’s name, type, or config	`slug`, `field_id`, `name`, `config`
`objects.remove_field`	Remove a field from an object type	`slug`, `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"
  }
}

{
  "tool": "objects.add_field",
  "params": {
    "slug": "deals",
    "name": "Deal Value",
    "field_type": "currency",
    "config": {
      "currency": "USD",
      "required": true
    }
  }
}

{
  "tool": "objects.add_field",
  "params": {
    "slug": "deals",
    "name": "Priority",
    "field_type": "select",
    "config": {
      "options": ["Low", "Medium", "High"]
    }
  }
}

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 }
  ]
}

Overview

Records

Lists

Views

Notes

Tasks

Analytics

Reports

Timeline

Graph

Objects

Tools

Field Types

Examples

Create a “Deals” object type and add fields

List all object types

​Tools

​Field Types

​Examples

​Create a “Deals” object type and add fields

​List all object types

Tools

Field Types

Examples

Create a “Deals” object type and add fields

List all object types