> ## Documentation Index
> Fetch the complete documentation index at: https://docs.supersonic.cv/llms.txt
> Use this file to discover all available pages before exploring further.

# Records

> Create, read, update, delete, search, and link records across any object type.

Records are the rows in your object types. A company, a contact, a deal — each is a record with dynamic fields defined by its object type.

## Tools

| Tool                  | Description                           | Key Params                                                 |
| --------------------- | ------------------------------------- | ---------------------------------------------------------- |
| `records.list`        | List records for an object type       | `object_type_slug`, `filters`, `sort`, `page`, `page_size` |
| `records.get`         | Get a single record by ID             | `object_type_slug`, `record_id`                            |
| `records.create`      | Create a new record                   | `object_type_slug`, `data`                                 |
| `records.update`      | Update a record's fields              | `object_type_slug`, `record_id`, `data`                    |
| `records.delete`      | Soft-delete a record                  | `object_type_slug`, `record_id`                            |
| `records.search`      | Full-text search across records       | `query`, `object_type_slug` (optional)                     |
| `records.link`        | Create a relation between two records | `from_record_id`, `to_record_id`                           |
| `records.unlink`      | Remove a relation between two records | `from_record_id`, `to_record_id`                           |
| `records.bulk_create` | Create multiple records at once       | `object_type_slug`, `records`                              |

<Note>
  `records.search` searches across all object types by default. Pass `object_type_slug` to narrow results to a single type.
</Note>

## Examples

### Create a company record

```json theme={null}
{
  "tool": "records.create",
  "params": {
    "object_type_slug": "companies",
    "data": {
      "Name": "Acme Corp",
      "Domain": "acme.com",
      "Industry": "Technology",
      "Employee Count": 250
    }
  }
}
```

Response:

```json theme={null}
{
  "success": true,
  "data": {
    "id": "rec_8f3a1b2c",
    "object_type_slug": "companies",
    "data": {
      "Name": "Acme Corp",
      "Domain": "acme.com",
      "Industry": "Technology",
      "Employee Count": 250
    },
    "created_at": "2026-03-23T10:15:00Z"
  }
}
```

### Search for records

```json theme={null}
{
  "tool": "records.search",
  "params": {
    "query": "acme",
    "object_type_slug": "companies"
  }
}
```

### Bulk create contacts and link to a company

<CodeGroup>
  ```json Bulk Create Contacts theme={null}
  {
    "tool": "records.bulk_create",
    "params": {
      "object_type_slug": "contacts",
      "records": [
        {
          "data": {
            "Name": "Jane Smith",
            "Email": "jane@acme.com",
            "Title": "CEO"
          }
        },
        {
          "data": {
            "Name": "Bob Johnson",
            "Email": "bob@acme.com",
            "Title": "CTO"
          }
        }
      ]
    }
  }
  ```

  ```json Link Contact to Company theme={null}
  {
    "tool": "records.link",
    "params": {
      "from_record_id": "rec_contact_01",
      "to_record_id": "rec_8f3a1b2c"
    }
  }
  ```
</CodeGroup>
