Breakcold is organized around a workspace CRM model. Most API calls either receive aDocumentation Index
Fetch the complete documentation index at: https://docs.breakcold.com/llms.txt
Use this file to discover all available pages before exploring further.
workspaceId directly or derive the workspace from an existing resource ID, such as a recordId, taskId, noteId, conversationId, or messageId.
An organization is the top-level account boundary. Billing, API keys, and organization-level access all belong to an organization.
A workspace belongs to one organization and contains CRM data: records, objects, attributes, tasks, notes, inbox conversations, and messages. When you list or create records, pass the target workspaceId. When you work from an existing resource, such as /records/{recordId}/tasks, the API resolves the workspace from that resource.
A user is a teammate in Breakcold. Users can belong to organizations and workspaces with roles such as owner, admin, manager, member, or viewer. Personal API keys act with the permissions of the user who created them, plus any scope and workspace limits configured on the key.
API v1 does not create organizations, workspaces, or users. It uses them to decide which data your key can access and where new records, tasks, and notes should be created.