Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.breakcold.com/llms.txt

Use this file to discover all available pages before exploring further.

An object is a type of CRM record. New workspaces start with system objects such as person, company, and deal, and teams can add custom objects for their own workflows. In the API, objects are identified by either:
  • objectTypeId: the internal object ID.
  • objectTypeSlug: the object slug, such as person, company, or deal.
A record is one item inside an object. A person, a company, and a deal are all records, but each belongs to a different object type. Record responses include the object they belong to, their display name, archive state, timestamps, and their attribute values under fields. 
{
  "id": "record_id",
  "workspaceId": "workspace_id",
  "objectTypeId": "object_type_id",
  "objectTypeSlug": "person",
  "displayName": "Ada Lovelace",
  "fields": {
    "name": "Ada Lovelace",
    "email": {
      "value": "ada@example.com",
      "isPrimary": true
    }
  },
  "isArchived": false,
  "createdAt": 1760000000000,
  "updatedAt": 1760000000000
}
Use objectTypeSlug when you want readable requests, and objectTypeId when you already store Breakcold IDs in your system. For example, list people with /records?workspaceId=YOUR_WORKSPACE_ID&objectTypeSlug=person. Records are archived instead of permanently deleted in API v1. Archived records are hidden from default record lists unless you request them with archived=true.