{ "openapi": "3.1.0", "info": { "title": "Breakcold Public API", "version": "1.0.0", "description": "Contract-first public API for Breakcold records, tasks, notes, inbox, and MCP tools." }, "servers": [ { "url": "https://rest.breakcold.com/api/v1", "description": "Universal endpoint (routes to your region automatically)" } ], "tags": [ { "name": "Workspaces" }, { "name": "CRM" }, { "name": "Records" }, { "name": "Tasks" }, { "name": "Notes" }, { "name": "Inbox" }, { "name": "Meetings" }, { "name": "Webhooks" } ], "paths": { "/workspaces": { "get": { "tags": ["Workspaces"], "summary": "List authorized workspaces", "description": "List workspaces the authenticated public API actor can access in the current organization.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0 tokens120 requests/min per route/org
", "operationId": "listAuthorizedWorkspaces", "security": [ { "ApiKeyBearer": [] }, { "BreakcoldOAuth": [] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "organizationId": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "description": { "type": "string" }, "role": { "type": ["string", "null"], "enum": [ "owner", "admin", "manager", "member", "viewer", null ], "description": "Effective role for user actors. Application and agent actors return null." }, "isInheritedAccess": { "type": "boolean" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "organizationId", "name", "role", "isInheritedAccess", "createdAt", "updatedAt" ] } }, "pagination": { "type": "object", "properties": { "cursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["cursor", "hasMore"] } }, "required": ["data", "pagination"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "workspaces.list", "scopes": [], "automation": { "kind": "search", "resource": "workspaces", "noun": "Workspace", "label": "List authorized workspaces", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "none", "tokenCost": 0, "display": "0 tokens" }, "mcpTool": "workspaces_list" } } }, "/crm/objects": { "get": { "tags": ["CRM"], "summary": "List CRM objects", "description": "List CRM object types in a workspace.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "listCrmObjects", "security": [ { "ApiKeyBearer": ["crm:metadata:read"] }, { "BreakcoldOAuth": ["crm:metadata:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 6 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "objects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "slug": { "type": "string" }, "name": { "type": "string" }, "nameSingular": { "type": "string" }, "namePlural": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "isSystem": { "type": "boolean" }, "isActive": { "type": "boolean" }, "order": { "type": "number" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "slug", "nameSingular", "namePlural", "isSystem", "isActive", "order", "createdAt", "updatedAt" ] } } }, "required": ["objects"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.objects.list", "scopes": ["crm:metadata:read"], "automation": { "kind": "search", "resource": "crm", "noun": "CRM", "label": "List CRM objects", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "crm_objects_list" } }, "post": { "tags": ["CRM"], "summary": "Create a CRM object", "description": "Create a custom CRM object type with default fields and view.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "createCrmObject", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "slug": { "type": "string" }, "name": { "type": "string" }, "nameSingular": { "type": "string" }, "namePlural": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "isSystem": { "type": "boolean" }, "isActive": { "type": "boolean" }, "order": { "type": "number" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "slug", "nameSingular", "namePlural", "isSystem", "isActive", "order", "createdAt", "updatedAt" ] } }, "required": ["object"] } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "slug": { "type": "string" }, "name": { "type": "string" }, "nameSingular": { "type": "string" }, "namePlural": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "isSystem": { "type": "boolean" }, "isActive": { "type": "boolean" }, "order": { "type": "number" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "slug", "nameSingular", "namePlural", "isSystem", "isActive", "order", "createdAt", "updatedAt" ] } }, "required": ["object"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.objects.create", "scopes": ["crm:metadata:write"], "automation": { "kind": "create", "resource": "crm", "noun": "CRM", "label": "Create a CRM object", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_objects_create" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaceId": { "type": "string", "minLength": 6 }, "slug": { "type": "string" }, "nameSingular": { "type": "string" }, "namePlural": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" } }, "required": [ "workspaceId", "slug", "nameSingular", "namePlural" ] } } } } } }, "/crm/objects/reorder": { "post": { "tags": ["CRM"], "summary": "Reorder CRM objects", "description": "Replace the display order for CRM object types.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "reorderCrmObjects", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "objectTypeIds": { "type": "array", "items": { "type": "string", "minLength": 6 } } }, "required": ["objectTypeIds"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.objects.reorder", "scopes": ["crm:metadata:write"], "automation": { "kind": "action", "resource": "crm", "noun": "CRM", "label": "Reorder CRM objects", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_objects_reorder" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeIds": { "type": "array", "items": { "type": "string", "minLength": 6 } } }, "required": ["workspaceId", "objectTypeIds"] } } } } } }, "/crm/objects/{objectTypeId}": { "get": { "tags": ["CRM"], "summary": "Get a CRM object", "description": "Fetch one CRM object type.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "getCrmObject", "security": [ { "ApiKeyBearer": ["crm:metadata:read"] }, { "BreakcoldOAuth": ["crm:metadata:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "objectTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "slug": { "type": "string" }, "name": { "type": "string" }, "nameSingular": { "type": "string" }, "namePlural": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "isSystem": { "type": "boolean" }, "isActive": { "type": "boolean" }, "order": { "type": "number" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "slug", "nameSingular", "namePlural", "isSystem", "isActive", "order", "createdAt", "updatedAt" ] } }, "required": ["object"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.objects.get", "scopes": ["crm:metadata:read"], "automation": { "kind": "search", "resource": "crm", "noun": "CRM", "label": "Get a CRM object", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "crm_objects_get" } }, "patch": { "tags": ["CRM"], "summary": "Update a CRM object", "description": "Update custom CRM object metadata and active state.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "updateCrmObject", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "objectTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "slug": { "type": "string" }, "name": { "type": "string" }, "nameSingular": { "type": "string" }, "namePlural": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "isSystem": { "type": "boolean" }, "isActive": { "type": "boolean" }, "order": { "type": "number" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "slug", "nameSingular", "namePlural", "isSystem", "isActive", "order", "createdAt", "updatedAt" ] } }, "required": ["object"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.objects.update", "scopes": ["crm:metadata:write"], "automation": { "kind": "action", "resource": "crm", "noun": "CRM", "label": "Update a CRM object", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_objects_update" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "nameSingular": { "type": "string" }, "namePlural": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "isActive": { "type": "boolean" } } } } } } }, "delete": { "tags": ["CRM"], "summary": "Delete a CRM object", "description": "Permanently delete a custom CRM object type together with its custom field definitions, field options, and saved views.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "deleteCrmObject", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "objectTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deletedId": { "type": "string", "minLength": 6 } }, "required": ["deletedId"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.objects.delete", "scopes": ["crm:metadata:write"], "automation": { "kind": "action", "resource": "crm", "noun": "CRM", "label": "Delete a CRM object", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_objects_delete" }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/crm/objects/{objectTypeId}/fields": { "get": { "tags": ["CRM"], "summary": "List CRM fields", "description": "List field definitions for one CRM object type.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "listCrmFields", "security": [ { "ApiKeyBearer": ["crm:metadata:read"] }, { "BreakcoldOAuth": ["crm:metadata:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "objectTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "fieldType": { "type": "string" }, "isSystem": { "type": "boolean" }, "isRequired": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isMultiple": { "type": "boolean" }, "isPrimary": { "type": "boolean" }, "showInCreateModal": { "type": "boolean" }, "order": { "type": "number" }, "defaultValue": {}, "validation": { "type": "object", "additionalProperties": true }, "targetObjectTypeId": { "type": "string", "minLength": 6 }, "relationDefinitionId": { "type": "string", "minLength": 6 }, "relationSide": { "type": "string", "enum": ["A", "B"] }, "notifyOnAssign": { "type": "boolean" }, "interactionRollupMode": { "type": "string", "enum": [ "none", "direct", "direct_with_target_rollups" ] }, "defaultValueTemplate": { "type": "string" }, "isComputed": { "type": "boolean" }, "computeExpression": { "type": "string" }, "isIdentifier": { "type": "boolean" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "slug", "name", "fieldType", "isSystem", "isRequired", "isHidden", "isMultiple", "isPrimary", "order", "createdAt", "updatedAt" ] } } }, "required": ["fields"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.fields.list", "scopes": ["crm:metadata:read"], "automation": { "kind": "search", "resource": "crm", "noun": "CRM", "label": "List CRM fields", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "crm_fields_list" } }, "post": { "tags": ["CRM"], "summary": "Create a CRM field", "description": "Create a field definition for a CRM object type.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "createCrmField", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "objectTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "field": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "fieldType": { "type": "string" }, "isSystem": { "type": "boolean" }, "isRequired": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isMultiple": { "type": "boolean" }, "isPrimary": { "type": "boolean" }, "showInCreateModal": { "type": "boolean" }, "order": { "type": "number" }, "defaultValue": {}, "validation": { "type": "object", "additionalProperties": true }, "targetObjectTypeId": { "type": "string", "minLength": 6 }, "relationDefinitionId": { "type": "string", "minLength": 6 }, "relationSide": { "type": "string", "enum": ["A", "B"] }, "notifyOnAssign": { "type": "boolean" }, "interactionRollupMode": { "type": "string", "enum": [ "none", "direct", "direct_with_target_rollups" ] }, "defaultValueTemplate": { "type": "string" }, "isComputed": { "type": "boolean" }, "computeExpression": { "type": "string" }, "isIdentifier": { "type": "boolean" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "slug", "name", "fieldType", "isSystem", "isRequired", "isHidden", "isMultiple", "isPrimary", "order", "createdAt", "updatedAt" ] } }, "required": ["field"] } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "field": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "fieldType": { "type": "string" }, "isSystem": { "type": "boolean" }, "isRequired": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isMultiple": { "type": "boolean" }, "isPrimary": { "type": "boolean" }, "showInCreateModal": { "type": "boolean" }, "order": { "type": "number" }, "defaultValue": {}, "validation": { "type": "object", "additionalProperties": true }, "targetObjectTypeId": { "type": "string", "minLength": 6 }, "relationDefinitionId": { "type": "string", "minLength": 6 }, "relationSide": { "type": "string", "enum": ["A", "B"] }, "notifyOnAssign": { "type": "boolean" }, "interactionRollupMode": { "type": "string", "enum": [ "none", "direct", "direct_with_target_rollups" ] }, "defaultValueTemplate": { "type": "string" }, "isComputed": { "type": "boolean" }, "computeExpression": { "type": "string" }, "isIdentifier": { "type": "boolean" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "slug", "name", "fieldType", "isSystem", "isRequired", "isHidden", "isMultiple", "isPrimary", "order", "createdAt", "updatedAt" ] } }, "required": ["field"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.fields.create", "scopes": ["crm:metadata:write"], "automation": { "kind": "create", "resource": "crm", "noun": "CRM", "label": "Create a CRM field", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_fields_create" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "fieldType": { "type": "string" }, "isRequired": { "type": "boolean" }, "isMultiple": { "type": "boolean" }, "showInCreateModal": { "type": "boolean" }, "defaultValue": {}, "validation": { "type": "object", "additionalProperties": true }, "targetObjectTypeId": { "type": "string", "minLength": 6 }, "notifyOnAssign": { "type": "boolean" }, "interactionRollupMode": { "type": "string" }, "relationCardinality": { "type": "string" }, "inverseName": { "type": "string" }, "inverseSlug": { "type": "string" }, "defaultValueTemplate": { "type": "string" }, "isComputed": { "type": "boolean" }, "computeExpression": { "type": "string" }, "isIdentifier": { "type": "boolean" }, "options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "fieldDefinitionId": { "type": "string", "minLength": 6 }, "value": { "type": "string" }, "label": { "type": "string" }, "color": { "type": "string" }, "order": { "type": "number" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "required": [ "id", "fieldDefinitionId", "value", "label", "order", "isDefault", "isActive" ] } } }, "required": ["slug", "name", "fieldType"] } } } } } }, "/crm/objects/{objectTypeId}/fields/reorder": { "post": { "tags": ["CRM"], "summary": "Reorder CRM fields", "description": "Replace the field order for one CRM object type.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "reorderCrmFields", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "objectTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldDefinitionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } } }, "required": ["fieldDefinitionIds"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.fields.reorder", "scopes": ["crm:metadata:write"], "automation": { "kind": "action", "resource": "crm", "noun": "CRM", "label": "Reorder CRM fields", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_fields_reorder" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldDefinitionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } } }, "required": ["fieldDefinitionIds"] } } } } } }, "/crm/fields/{fieldDefinitionId}": { "get": { "tags": ["CRM"], "summary": "Get a CRM field", "description": "Fetch one CRM field definition.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "getCrmField", "security": [ { "ApiKeyBearer": ["crm:metadata:read"] }, { "BreakcoldOAuth": ["crm:metadata:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "fieldDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "field": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "fieldType": { "type": "string" }, "isSystem": { "type": "boolean" }, "isRequired": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isMultiple": { "type": "boolean" }, "isPrimary": { "type": "boolean" }, "showInCreateModal": { "type": "boolean" }, "order": { "type": "number" }, "defaultValue": {}, "validation": { "type": "object", "additionalProperties": true }, "targetObjectTypeId": { "type": "string", "minLength": 6 }, "relationDefinitionId": { "type": "string", "minLength": 6 }, "relationSide": { "type": "string", "enum": ["A", "B"] }, "notifyOnAssign": { "type": "boolean" }, "interactionRollupMode": { "type": "string", "enum": [ "none", "direct", "direct_with_target_rollups" ] }, "defaultValueTemplate": { "type": "string" }, "isComputed": { "type": "boolean" }, "computeExpression": { "type": "string" }, "isIdentifier": { "type": "boolean" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "slug", "name", "fieldType", "isSystem", "isRequired", "isHidden", "isMultiple", "isPrimary", "order", "createdAt", "updatedAt" ] } }, "required": ["field"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.fields.get", "scopes": ["crm:metadata:read"], "automation": { "kind": "search", "resource": "crm", "noun": "CRM", "label": "Get a CRM field", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "crm_fields_get" } }, "patch": { "tags": ["CRM"], "summary": "Update a CRM field", "description": "Update a CRM field definition.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "updateCrmField", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "fieldDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "field": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "fieldType": { "type": "string" }, "isSystem": { "type": "boolean" }, "isRequired": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isMultiple": { "type": "boolean" }, "isPrimary": { "type": "boolean" }, "showInCreateModal": { "type": "boolean" }, "order": { "type": "number" }, "defaultValue": {}, "validation": { "type": "object", "additionalProperties": true }, "targetObjectTypeId": { "type": "string", "minLength": 6 }, "relationDefinitionId": { "type": "string", "minLength": 6 }, "relationSide": { "type": "string", "enum": ["A", "B"] }, "notifyOnAssign": { "type": "boolean" }, "interactionRollupMode": { "type": "string", "enum": [ "none", "direct", "direct_with_target_rollups" ] }, "defaultValueTemplate": { "type": "string" }, "isComputed": { "type": "boolean" }, "computeExpression": { "type": "string" }, "isIdentifier": { "type": "boolean" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "slug", "name", "fieldType", "isSystem", "isRequired", "isHidden", "isMultiple", "isPrimary", "order", "createdAt", "updatedAt" ] } }, "required": ["field"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.fields.update", "scopes": ["crm:metadata:write"], "automation": { "kind": "action", "resource": "crm", "noun": "CRM", "label": "Update a CRM field", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_fields_update" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "isRequired": { "type": "boolean" }, "isHidden": { "type": "boolean" }, "isMultiple": { "type": "boolean" }, "showInCreateModal": { "type": "boolean" }, "defaultValue": {}, "validation": { "type": "object", "additionalProperties": true }, "targetObjectTypeId": { "type": "string", "minLength": 6 }, "notifyOnAssign": { "type": "boolean" }, "interactionRollupMode": { "type": "string" }, "defaultValueTemplate": { "type": "string" }, "isComputed": { "type": "boolean" }, "computeExpression": { "type": "string" }, "isIdentifier": { "type": "boolean" } } } } } } }, "delete": { "tags": ["CRM"], "summary": "Delete a CRM field", "description": "Permanently delete a custom CRM field definition, its field options and stored values or relations, and remove it from saved view configurations.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "deleteCrmField", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "fieldDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deletedId": { "type": "string", "minLength": 6 } }, "required": ["deletedId"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.fields.delete", "scopes": ["crm:metadata:write"], "automation": { "kind": "action", "resource": "crm", "noun": "CRM", "label": "Delete a CRM field", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_fields_delete" }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/crm/fields/{fieldDefinitionId}/options": { "get": { "tags": ["CRM"], "summary": "List CRM field options", "description": "List options for a select or multiselect CRM field.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "listCrmFieldOptions", "security": [ { "ApiKeyBearer": ["crm:metadata:read"] }, { "BreakcoldOAuth": ["crm:metadata:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "fieldDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "options": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "fieldDefinitionId": { "type": "string", "minLength": 6 }, "value": { "type": "string" }, "label": { "type": "string" }, "color": { "type": "string" }, "order": { "type": "number" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "required": [ "id", "fieldDefinitionId", "value", "label", "order", "isDefault", "isActive" ] } } }, "required": ["options"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.field_options.list", "scopes": ["crm:metadata:read"], "automation": { "kind": "search", "resource": "crm", "noun": "CRM", "label": "List CRM field options", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "crm_field_options_list" } }, "post": { "tags": ["CRM"], "summary": "Create a CRM field option", "description": "Create an option for a select or multiselect CRM field.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "createCrmFieldOption", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "fieldDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "option": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "fieldDefinitionId": { "type": "string", "minLength": 6 }, "value": { "type": "string" }, "label": { "type": "string" }, "color": { "type": "string" }, "order": { "type": "number" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "required": [ "id", "fieldDefinitionId", "value", "label", "order", "isDefault", "isActive" ] } }, "required": ["option"] } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "option": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "fieldDefinitionId": { "type": "string", "minLength": 6 }, "value": { "type": "string" }, "label": { "type": "string" }, "color": { "type": "string" }, "order": { "type": "number" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "required": [ "id", "fieldDefinitionId", "value", "label", "order", "isDefault", "isActive" ] } }, "required": ["option"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.field_options.create", "scopes": ["crm:metadata:write"], "automation": { "kind": "create", "resource": "crm", "noun": "CRM", "label": "Create a CRM field option", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_field_options_create" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "color": { "type": "string" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "required": ["value", "label"] } } } } } }, "/crm/fields/{fieldDefinitionId}/options/reorder": { "post": { "tags": ["CRM"], "summary": "Reorder CRM field options", "description": "Replace the option order for a select or multiselect CRM field.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "reorderCrmFieldOptions", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "fieldDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "optionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } } }, "required": ["optionIds"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.field_options.reorder", "scopes": ["crm:metadata:write"], "automation": { "kind": "action", "resource": "crm", "noun": "CRM", "label": "Reorder CRM field options", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_field_options_reorder" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "optionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } } }, "required": ["optionIds"] } } } } } }, "/crm/fields/{fieldDefinitionId}/options/{fieldOptionId}": { "patch": { "tags": ["CRM"], "summary": "Update a CRM field option", "description": "Update an option for a select or multiselect CRM field.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "updateCrmFieldOption", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "fieldDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldOptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "option": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "fieldDefinitionId": { "type": "string", "minLength": 6 }, "value": { "type": "string" }, "label": { "type": "string" }, "color": { "type": "string" }, "order": { "type": "number" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "required": [ "id", "fieldDefinitionId", "value", "label", "order", "isDefault", "isActive" ] } }, "required": ["option"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.field_options.update", "scopes": ["crm:metadata:write"], "automation": { "kind": "action", "resource": "crm", "noun": "CRM", "label": "Update a CRM field option", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_field_options_update" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "color": { "type": "string" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" } } } } } } }, "delete": { "tags": ["CRM"], "summary": "Delete a CRM field option", "description": "Delete an option from a select or multiselect CRM field.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "deleteCrmFieldOption", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "fieldDefinitionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "fieldOptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deletedId": { "type": "string", "minLength": 6 } }, "required": ["deletedId"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.field_options.delete", "scopes": ["crm:metadata:write"], "automation": { "kind": "action", "resource": "crm", "noun": "CRM", "label": "Delete a CRM field option", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_field_options_delete" }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/crm/objects/{objectTypeId}/views": { "get": { "tags": ["CRM"], "summary": "List CRM record views", "description": "List saved record views for one CRM object type.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "listCrmRecordViews", "security": [ { "ApiKeyBearer": ["crm:metadata:read"] }, { "BreakcoldOAuth": ["crm:metadata:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "objectTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "views": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "emoji": { "type": "string" }, "type": { "type": "string", "enum": ["table", "kanban"] }, "isDefault": { "type": "boolean" }, "order": { "type": "number" }, "createdBy": { "type": "string", "minLength": 6 }, "kanbanFieldDefinitionId": { "type": "string", "minLength": 6 }, "kanbanWinOptionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "kanbanLossOptionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "name", "type", "isDefault", "config", "createdAt", "updatedAt" ] } } }, "required": ["views"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.record_views.list", "scopes": ["crm:metadata:read"], "automation": { "kind": "search", "resource": "crm", "noun": "CRM", "label": "List CRM record views", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "crm_record_views_list" } }, "post": { "tags": ["CRM"], "summary": "Create a CRM record view", "description": "Create a saved record view for one CRM object type.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "createCrmRecordView", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "objectTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "emoji": { "type": "string" }, "type": { "type": "string", "enum": ["table", "kanban"] }, "isDefault": { "type": "boolean" }, "order": { "type": "number" }, "createdBy": { "type": "string", "minLength": 6 }, "kanbanFieldDefinitionId": { "type": "string", "minLength": 6 }, "kanbanWinOptionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "kanbanLossOptionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "name", "type", "isDefault", "config", "createdAt", "updatedAt" ] } }, "required": ["view"] } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "emoji": { "type": "string" }, "type": { "type": "string", "enum": ["table", "kanban"] }, "isDefault": { "type": "boolean" }, "order": { "type": "number" }, "createdBy": { "type": "string", "minLength": 6 }, "kanbanFieldDefinitionId": { "type": "string", "minLength": 6 }, "kanbanWinOptionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "kanbanLossOptionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "name", "type", "isDefault", "config", "createdAt", "updatedAt" ] } }, "required": ["view"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.record_views.create", "scopes": ["crm:metadata:write"], "automation": { "kind": "create", "resource": "crm", "noun": "CRM", "label": "Create a CRM record view", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_record_views_create" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "emoji": { "type": "string" }, "type": { "type": "string", "enum": ["table", "kanban"] }, "isDefault": { "type": "boolean" }, "kanbanFieldDefinitionId": { "type": "string", "minLength": 6 }, "kanbanWinOptionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "kanbanLossOptionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." } }, "required": ["name"] } } } } } }, "/crm/objects/{objectTypeId}/views/reorder": { "post": { "tags": ["CRM"], "summary": "Reorder CRM record views", "description": "Replace the saved view order for one CRM object type.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "reorderCrmRecordViews", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "objectTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "viewIds": { "type": "array", "items": { "type": "string", "minLength": 6 } } }, "required": ["viewIds"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.record_views.reorder", "scopes": ["crm:metadata:write"], "automation": { "kind": "action", "resource": "crm", "noun": "CRM", "label": "Reorder CRM record views", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_record_views_reorder" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "viewIds": { "type": "array", "items": { "type": "string", "minLength": 6 } } }, "required": ["viewIds"] } } } } } }, "/crm/views/{viewId}": { "get": { "tags": ["CRM"], "summary": "Get a CRM record view", "description": "Fetch one saved record view.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "getCrmRecordView", "security": [ { "ApiKeyBearer": ["crm:metadata:read"] }, { "BreakcoldOAuth": ["crm:metadata:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "viewId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "emoji": { "type": "string" }, "type": { "type": "string", "enum": ["table", "kanban"] }, "isDefault": { "type": "boolean" }, "order": { "type": "number" }, "createdBy": { "type": "string", "minLength": 6 }, "kanbanFieldDefinitionId": { "type": "string", "minLength": 6 }, "kanbanWinOptionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "kanbanLossOptionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "name", "type", "isDefault", "config", "createdAt", "updatedAt" ] } }, "required": ["view"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.record_views.get", "scopes": ["crm:metadata:read"], "automation": { "kind": "search", "resource": "crm", "noun": "CRM", "label": "Get a CRM record view", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "crm_record_views_get" } }, "patch": { "tags": ["CRM"], "summary": "Update a CRM record view", "description": "Update record view metadata and replace the full saved config.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "updateCrmRecordView", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "viewId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "emoji": { "type": "string" }, "type": { "type": "string", "enum": ["table", "kanban"] }, "isDefault": { "type": "boolean" }, "order": { "type": "number" }, "createdBy": { "type": "string", "minLength": 6 }, "kanbanFieldDefinitionId": { "type": "string", "minLength": 6 }, "kanbanWinOptionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "kanbanLossOptionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "name", "type", "isDefault", "config", "createdAt", "updatedAt" ] } }, "required": ["view"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.record_views.update", "scopes": ["crm:metadata:write"], "automation": { "kind": "action", "resource": "crm", "noun": "CRM", "label": "Update a CRM record view", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_record_views_update" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "emoji": { "type": "string" }, "type": { "type": "string", "enum": ["table", "kanban"] }, "isDefault": { "type": "boolean" }, "kanbanFieldDefinitionId": { "anyOf": [ { "type": "string", "minLength": 6 }, { "type": "null" } ] }, "kanbanWinOptionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "kanbanLossOptionIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." } } } } } } }, "delete": { "tags": ["CRM"], "summary": "Delete a CRM record view", "description": "Delete a saved record view.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "deleteCrmRecordView", "security": [ { "ApiKeyBearer": ["crm:metadata:write"] }, { "BreakcoldOAuth": ["crm:metadata:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "viewId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deletedId": { "type": "string", "minLength": 6 } }, "required": ["deletedId"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "crm.record_views.delete", "scopes": ["crm:metadata:write"], "automation": { "kind": "action", "resource": "crm", "noun": "CRM", "label": "Delete a CRM record view", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "crm_record_views_delete" }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/inbox/views": { "get": { "tags": ["Inbox"], "summary": "List inbox views", "description": "List inbox views visible to the effective actor user.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "listInboxViews", "security": [ { "ApiKeyBearer": ["inbox:views:read"] }, { "BreakcoldOAuth": ["inbox:views:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 6 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "views": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "emoji": { "type": "string" }, "isSystem": { "type": "boolean" }, "systemViewKey": { "type": "string" }, "visibility": { "type": "string", "enum": ["personal", "workspace", "restricted"] }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." }, "createdByUserId": { "type": "string", "minLength": 6 }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "name", "isSystem", "visibility", "config", "createdAt", "updatedAt" ] } } }, "required": ["views"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.views.list", "scopes": ["inbox:views:read"], "automation": { "kind": "search", "resource": "inbox", "noun": "Inbox", "label": "List inbox views", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "inbox_views_list" } }, "post": { "tags": ["Inbox"], "summary": "Create an inbox view", "description": "Create an inbox saved view for the effective actor user.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "createInboxView", "security": [ { "ApiKeyBearer": ["inbox:views:write"] }, { "BreakcoldOAuth": ["inbox:views:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "emoji": { "type": "string" }, "isSystem": { "type": "boolean" }, "systemViewKey": { "type": "string" }, "visibility": { "type": "string", "enum": ["personal", "workspace", "restricted"] }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." }, "createdByUserId": { "type": "string", "minLength": 6 }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "name", "isSystem", "visibility", "config", "createdAt", "updatedAt" ] } }, "required": ["view"] } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "emoji": { "type": "string" }, "isSystem": { "type": "boolean" }, "systemViewKey": { "type": "string" }, "visibility": { "type": "string", "enum": ["personal", "workspace", "restricted"] }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." }, "createdByUserId": { "type": "string", "minLength": 6 }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "name", "isSystem", "visibility", "config", "createdAt", "updatedAt" ] } }, "required": ["view"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.views.create", "scopes": ["inbox:views:write"], "automation": { "kind": "create", "resource": "inbox", "noun": "Inbox", "label": "Create an inbox view", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "inbox_views_create" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaceId": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "emoji": { "type": "string" }, "visibility": { "type": "string", "enum": ["personal", "workspace", "restricted"] }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." } }, "required": ["workspaceId", "name"] } } } } } }, "/inbox/views/sidebar": { "get": { "tags": ["Inbox"], "summary": "Get inbox view sidebar", "description": "Fetch inbox view sidebar layout for the effective actor user.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "getInboxViewsSidebar", "security": [ { "ApiKeyBearer": ["inbox:views:read"] }, { "BreakcoldOAuth": ["inbox:views:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 6 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "views": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "emoji": { "type": "string" }, "isSystem": { "type": "boolean" }, "systemViewKey": { "type": "string" }, "visibility": { "type": "string", "enum": ["personal", "workspace", "restricted"] }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." }, "createdByUserId": { "type": "string", "minLength": 6 }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "name", "isSystem", "visibility", "config", "createdAt", "updatedAt" ] } }, "folders": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "layout": { "type": "array", "items": { "type": "object", "properties": { "position": { "type": "number" }, "itemType": { "type": "string", "enum": ["view", "folder"] }, "viewId": { "type": "string", "minLength": 6 }, "folderId": { "type": "string", "minLength": 6 }, "parentFolderId": { "type": "string", "minLength": 6 }, "isCollapsed": { "type": "boolean" } }, "required": ["position", "itemType"] } } }, "required": ["views", "folders", "layout"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.views.sidebar.get", "scopes": ["inbox:views:read"], "automation": { "kind": "search", "resource": "inbox", "noun": "Inbox", "label": "Get inbox view sidebar", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "inbox_views_sidebar_get" } } }, "/inbox/views/sidebar/reorder": { "post": { "tags": ["Inbox"], "summary": "Reorder inbox view sidebar", "description": "Replace inbox view sidebar order for the effective actor user.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "reorderInboxViewsSidebar", "security": [ { "ApiKeyBearer": ["inbox:views:write"] }, { "BreakcoldOAuth": ["inbox:views:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } }, "required": ["ok"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.views.sidebar.reorder", "scopes": ["inbox:views:write"], "automation": { "kind": "action", "resource": "inbox", "noun": "Inbox", "label": "Reorder inbox view sidebar", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "inbox_views_sidebar_reorder" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaceId": { "type": "string", "minLength": 6 }, "items": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": ["view", "folder"] }, "id": { "type": "string", "minLength": 6 }, "parentFolderId": { "type": "string", "minLength": 6 } }, "required": ["type", "id"] } } }, "required": ["workspaceId", "items"] } } } } } }, "/inbox/views/{viewId}": { "get": { "tags": ["Inbox"], "summary": "Get an inbox view", "description": "Fetch one inbox saved view visible to the effective actor user.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "getInboxView", "security": [ { "ApiKeyBearer": ["inbox:views:read"] }, { "BreakcoldOAuth": ["inbox:views:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "viewId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "emoji": { "type": "string" }, "isSystem": { "type": "boolean" }, "systemViewKey": { "type": "string" }, "visibility": { "type": "string", "enum": ["personal", "workspace", "restricted"] }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." }, "createdByUserId": { "type": "string", "minLength": 6 }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "name", "isSystem", "visibility", "config", "createdAt", "updatedAt" ] } }, "required": ["view"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.views.get", "scopes": ["inbox:views:read"], "automation": { "kind": "search", "resource": "inbox", "noun": "Inbox", "label": "Get an inbox view", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "inbox_views_get" } }, "patch": { "tags": ["Inbox"], "summary": "Update an inbox view", "description": "Update inbox view metadata and replace the full saved config.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "updateInboxView", "security": [ { "ApiKeyBearer": ["inbox:views:write"] }, { "BreakcoldOAuth": ["inbox:views:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "viewId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "emoji": { "type": "string" }, "isSystem": { "type": "boolean" }, "systemViewKey": { "type": "string" }, "visibility": { "type": "string", "enum": ["personal", "workspace", "restricted"] }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." }, "createdByUserId": { "type": "string", "minLength": 6 }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "name", "isSystem", "visibility", "config", "createdAt", "updatedAt" ] } }, "required": ["view"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.views.update", "scopes": ["inbox:views:write"], "automation": { "kind": "action", "resource": "inbox", "noun": "Inbox", "label": "Update an inbox view", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "inbox_views_update" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "emoji": { "type": "string" }, "visibility": { "type": "string", "enum": ["personal", "workspace", "restricted"] }, "config": { "type": "object", "additionalProperties": true, "description": "Full saved view config. Record views support columns, filters, sorts, groupBy, and kanban settings. Inbox views support filters and sorts." } } } } } } }, "delete": { "tags": ["Inbox"], "summary": "Delete an inbox view", "description": "Delete a custom inbox view visible to the effective actor user.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "deleteInboxView", "security": [ { "ApiKeyBearer": ["inbox:views:write"] }, { "BreakcoldOAuth": ["inbox:views:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "viewId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deletedId": { "type": "string", "minLength": 6 } }, "required": ["deletedId"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.views.delete", "scopes": ["inbox:views:write"], "automation": { "kind": "action", "resource": "inbox", "noun": "Inbox", "label": "Delete an inbox view", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "inbox_views_delete" }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/records": { "get": { "tags": ["Records"], "summary": "List records", "description": "List or search records in one workspace and object type.\n\nSearch modes:\n- `searchScope=display` (default) searches only the record display name. This preserves the original API behavior and is best when you want a precise name lookup.\n- `searchScope=all` searches the display name plus indexed text-like field values on the record: text, textarea, email, phone, URL/social fields, location, select, and multiselect labels. It does not search notes, tasks, conversations, relation target names, numbers, dates, booleans, members, or files.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "listRecords", "security": [ { "ApiKeyBearer": ["records:read"] }, { "BreakcoldOAuth": ["records:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 6 } }, { "name": "objectTypeId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 6 } }, { "name": "objectTypeSlug", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "viewId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 6 } }, { "name": "archived", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "search", "in": "query", "required": false, "description": "Search text. By default this matches the record display name only; set `searchScope=all` to also search indexed text-like field values.", "schema": { "type": "string" } }, { "name": "searchScope", "in": "query", "required": false, "description": "`display` searches only record display names. `all` searches display names plus indexed text-like field values: text, textarea, email, phone, URL/social fields, location, select, and multiselect labels.", "schema": { "type": "string", "enum": ["display", "all"], "default": "display" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "objectTypeSlug": { "type": "string" }, "displayName": { "type": "string" }, "fields": { "type": "object", "additionalProperties": true, "description": "Map of field slug to value. Values follow the field type: strings for text/social fields, numbers for numeric/date fields, booleans for checkbox, { amount, currencyCode } for currency, { optionId } for select, arrays for multi-value fields. Multiselect fields accept an array of raw option ids or { optionId } objects." }, "isArchived": { "type": "boolean" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." }, "archivedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "isArchived", "createdAt", "updatedAt" ] } }, "pagination": { "type": "object", "properties": { "cursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["cursor", "hasMore"] } }, "required": ["data", "pagination"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "records.list", "scopes": ["records:read"], "automation": { "kind": "search", "resource": "records", "noun": "Record", "label": "List records", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "records_list" } }, "post": { "tags": ["Records"], "summary": "Create a record", "description": "Create a CRM record atomically with non-empty initial field values. Required fields are enforced, workspace-configured automatic enrichment may start, and matching active webhooks receive the record-created event at their external URLs. REST callers should send an Idempotency-Key header so retries return the original result.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "createRecord", "security": [ { "ApiKeyBearer": ["records:write"] }, { "BreakcoldOAuth": ["records:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "objectTypeSlug": { "type": "string" }, "displayName": { "type": "string" }, "fields": { "type": "object", "additionalProperties": true, "description": "Map of field slug to value. Values follow the field type: strings for text/social fields, numbers for numeric/date fields, booleans for checkbox, { amount, currencyCode } for currency, { optionId } for select, arrays for multi-value fields. Multiselect fields accept an array of raw option ids or { optionId } objects." }, "isArchived": { "type": "boolean" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." }, "archivedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "isArchived", "createdAt", "updatedAt" ] } }, "required": ["record"] } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "objectTypeSlug": { "type": "string" }, "displayName": { "type": "string" }, "fields": { "type": "object", "additionalProperties": true, "description": "Map of field slug to value. Values follow the field type: strings for text/social fields, numbers for numeric/date fields, booleans for checkbox, { amount, currencyCode } for currency, { optionId } for select, arrays for multi-value fields. Multiselect fields accept an array of raw option ids or { optionId } objects." }, "isArchived": { "type": "boolean" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." }, "archivedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "isArchived", "createdAt", "updatedAt" ] } }, "required": ["record"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "records.create", "scopes": ["records:write"], "automation": { "kind": "create", "resource": "records", "noun": "Record", "label": "Create a record", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "records_create" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "objectTypeSlug": { "type": "string" }, "fields": { "type": "object", "additionalProperties": true, "description": "Non-empty map of field slug to initial value. Every field configured as required for the target object must be supplied unless it has a configured default. When creating a deal from a person, include the deal's contact relation field with that person's record id.", "minProperties": 1 } }, "required": ["workspaceId", "fields"] }, "example": { "workspaceId": "workspace_id", "objectTypeSlug": "person", "fields": { "name": "Ada Lovelace", "email": "ada@example.com" } } } } } } }, "/records/{recordId}": { "get": { "tags": ["Records"], "summary": "Get a record", "description": "Fetch a CRM record with field values.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "getRecord", "security": [ { "ApiKeyBearer": ["records:read"] }, { "BreakcoldOAuth": ["records:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "objectTypeSlug": { "type": "string" }, "displayName": { "type": "string" }, "fields": { "type": "object", "additionalProperties": true, "description": "Map of field slug to value. Values follow the field type: strings for text/social fields, numbers for numeric/date fields, booleans for checkbox, { amount, currencyCode } for currency, { optionId } for select, arrays for multi-value fields. Multiselect fields accept an array of raw option ids or { optionId } objects." }, "isArchived": { "type": "boolean" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." }, "archivedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "isArchived", "createdAt", "updatedAt" ] } }, "required": ["record"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "records.get", "scopes": ["records:read"], "automation": { "kind": "search", "resource": "records", "noun": "Record", "label": "Get a record", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "records_get" } }, "patch": { "tags": ["Records"], "summary": "Update a record", "description": "Update CRM record field values. Multiselect fields append by default; pass multiselectMode: \"replace\" to set them to exactly the provided options (omitted options are removed, [] clears the field). Identity-field changes may start workspace-configured automatic enrichment, and matching active webhooks receive field-update events at their external URLs. Permanent delete is not available in v1.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "updateRecord", "security": [ { "ApiKeyBearer": ["records:write"] }, { "BreakcoldOAuth": ["records:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "objectTypeSlug": { "type": "string" }, "displayName": { "type": "string" }, "fields": { "type": "object", "additionalProperties": true, "description": "Map of field slug to value. Values follow the field type: strings for text/social fields, numbers for numeric/date fields, booleans for checkbox, { amount, currencyCode } for currency, { optionId } for select, arrays for multi-value fields. Multiselect fields accept an array of raw option ids or { optionId } objects." }, "isArchived": { "type": "boolean" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." }, "archivedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "isArchived", "createdAt", "updatedAt" ] } }, "required": ["record"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "records.update", "scopes": ["records:write"], "automation": { "kind": "action", "resource": "records", "noun": "Record", "label": "Update a record", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "records_update" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fields": { "type": "object", "additionalProperties": true, "description": "Map of field slug to value. Values follow the field type: strings for text/social fields, numbers for numeric/date fields, booleans for checkbox, { amount, currencyCode } for currency, { optionId } for select, arrays for multi-value fields. Multiselect fields accept an array of raw option ids or { optionId } objects." }, "multiselectMode": { "type": "string", "enum": ["append", "replace"], "default": "append", "description": "How multiselect field values are written. \"append\" (default) adds the provided options to existing ones. \"replace\" sets the field to exactly the provided options (omitted options removed; [] clears the field)." } }, "required": ["fields"] } } } } } }, "/records/{recordId}/archive": { "post": { "tags": ["Records"], "summary": "Archive a record", "description": "Archive a CRM record without permanently deleting it.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "archiveRecord", "security": [ { "ApiKeyBearer": ["records:write"] }, { "BreakcoldOAuth": ["records:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "objectTypeSlug": { "type": "string" }, "displayName": { "type": "string" }, "fields": { "type": "object", "additionalProperties": true, "description": "Map of field slug to value. Values follow the field type: strings for text/social fields, numbers for numeric/date fields, booleans for checkbox, { amount, currencyCode } for currency, { optionId } for select, arrays for multi-value fields. Multiselect fields accept an array of raw option ids or { optionId } objects." }, "isArchived": { "type": "boolean" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." }, "archivedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "isArchived", "createdAt", "updatedAt" ] } }, "required": ["record"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "records.archive", "scopes": ["records:write"], "automation": { "kind": "action", "resource": "records", "noun": "Record", "label": "Archive a record", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "records_archive" }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/records/{recordId}/restore": { "post": { "tags": ["Records"], "summary": "Restore a record", "description": "Restore an archived CRM record.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "restoreRecord", "security": [ { "ApiKeyBearer": ["records:write"] }, { "BreakcoldOAuth": ["records:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "objectTypeId": { "type": "string", "minLength": 6 }, "objectTypeSlug": { "type": "string" }, "displayName": { "type": "string" }, "fields": { "type": "object", "additionalProperties": true, "description": "Map of field slug to value. Values follow the field type: strings for text/social fields, numbers for numeric/date fields, booleans for checkbox, { amount, currencyCode } for currency, { optionId } for select, arrays for multi-value fields. Multiselect fields accept an array of raw option ids or { optionId } objects." }, "isArchived": { "type": "boolean" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." }, "archivedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "objectTypeId", "isArchived", "createdAt", "updatedAt" ] } }, "required": ["record"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "records.restore", "scopes": ["records:write"], "automation": { "kind": "action", "resource": "records", "noun": "Record", "label": "Restore a record", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "records_restore" }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/records/{recordId}/tasks": { "get": { "tags": ["Tasks"], "summary": "List record tasks", "description": "List tasks linked to a record.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "listRecordTasks", "security": [ { "ApiKeyBearer": ["tasks:read"] }, { "BreakcoldOAuth": ["tasks:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "includeCompleted", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "recordId": { "type": "string", "minLength": 6 }, "title": { "type": "string" }, "descriptionHtml": { "type": "string" }, "descriptionPlain": { "type": "string" }, "status": { "type": "string", "enum": ["todo", "done"] }, "dueAt": { "type": "number", "description": "Unix timestamp in ms." }, "assigneeUserIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "linkedResources": { "type": "array", "items": { "type": "object", "properties": { "resourceType": { "type": "string" }, "resourceId": { "type": "string" }, "label": { "type": "string" }, "channel": { "type": "string" } }, "required": ["resourceType", "resourceId"] } }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "title", "status", "createdAt", "updatedAt" ] } }, "pagination": { "type": "object", "properties": { "cursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["cursor", "hasMore"] } }, "required": ["data", "pagination"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "tasks.list", "scopes": ["tasks:read"], "automation": { "kind": "search", "resource": "tasks", "noun": "Task", "label": "List record tasks", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "tasks_list" } }, "post": { "tags": ["Tasks"], "summary": "Create a record task", "description": "Create a task linked to a record.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "createRecordTask", "security": [ { "ApiKeyBearer": ["tasks:write"] }, { "BreakcoldOAuth": ["tasks:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "recordId": { "type": "string", "minLength": 6 }, "title": { "type": "string" }, "descriptionHtml": { "type": "string" }, "descriptionPlain": { "type": "string" }, "status": { "type": "string", "enum": ["todo", "done"] }, "dueAt": { "type": "number", "description": "Unix timestamp in ms." }, "assigneeUserIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "linkedResources": { "type": "array", "items": { "type": "object", "properties": { "resourceType": { "type": "string" }, "resourceId": { "type": "string" }, "label": { "type": "string" }, "channel": { "type": "string" } }, "required": ["resourceType", "resourceId"] } }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "title", "status", "createdAt", "updatedAt" ] } }, "required": ["task"] } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "recordId": { "type": "string", "minLength": 6 }, "title": { "type": "string" }, "descriptionHtml": { "type": "string" }, "descriptionPlain": { "type": "string" }, "status": { "type": "string", "enum": ["todo", "done"] }, "dueAt": { "type": "number", "description": "Unix timestamp in ms." }, "assigneeUserIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "linkedResources": { "type": "array", "items": { "type": "object", "properties": { "resourceType": { "type": "string" }, "resourceId": { "type": "string" }, "label": { "type": "string" }, "channel": { "type": "string" } }, "required": ["resourceType", "resourceId"] } }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "title", "status", "createdAt", "updatedAt" ] } }, "required": ["task"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "tasks.create", "scopes": ["tasks:write"], "automation": { "kind": "create", "resource": "tasks", "noun": "Task", "label": "Create a record task", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "tasks_create" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "descriptionHtml": { "type": "string" }, "descriptionPlain": { "type": "string" }, "dueAt": { "type": "number", "description": "Unix timestamp in ms." }, "assigneeUserIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "conversationId": { "type": "string", "minLength": 6 } }, "required": ["title"] } } } } } }, "/tasks/{taskId}": { "patch": { "tags": ["Tasks"], "summary": "Update a task", "description": "Update task details.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "updateTask", "security": [ { "ApiKeyBearer": ["tasks:write"] }, { "BreakcoldOAuth": ["tasks:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "recordId": { "type": "string", "minLength": 6 }, "title": { "type": "string" }, "descriptionHtml": { "type": "string" }, "descriptionPlain": { "type": "string" }, "status": { "type": "string", "enum": ["todo", "done"] }, "dueAt": { "type": "number", "description": "Unix timestamp in ms." }, "assigneeUserIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "linkedResources": { "type": "array", "items": { "type": "object", "properties": { "resourceType": { "type": "string" }, "resourceId": { "type": "string" }, "label": { "type": "string" }, "channel": { "type": "string" } }, "required": ["resourceType", "resourceId"] } }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "title", "status", "createdAt", "updatedAt" ] } }, "required": ["task"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "tasks.update", "scopes": ["tasks:write"], "automation": { "kind": "action", "resource": "tasks", "noun": "Task", "label": "Update a task", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "tasks_update" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "descriptionHtml": { "type": "string" }, "descriptionPlain": { "type": "string" }, "status": { "type": "string", "enum": ["todo", "done"] }, "dueAt": { "type": ["number", "null"] }, "assigneeUserIds": { "type": "array", "items": { "type": "string", "minLength": 6 } } } } } } } }, "delete": { "tags": ["Tasks"], "summary": "Delete a task", "description": "Soft-delete a task. Deleted tasks are excluded from task lists and cannot be restored through the public API.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "deleteTask", "security": [ { "ApiKeyBearer": ["tasks:write"] }, { "BreakcoldOAuth": ["tasks:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deletedId": { "type": "string", "minLength": 6 } }, "required": ["deletedId"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "tasks.delete", "scopes": ["tasks:write"], "automation": { "kind": "action", "resource": "tasks", "noun": "Task", "label": "Delete a task", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "tasks_delete" }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/tasks/{taskId}/complete": { "post": { "tags": ["Tasks"], "summary": "Complete a task", "description": "Mark a task as done.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "completeTask", "security": [ { "ApiKeyBearer": ["tasks:write"] }, { "BreakcoldOAuth": ["tasks:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "taskId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "task": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "recordId": { "type": "string", "minLength": 6 }, "title": { "type": "string" }, "descriptionHtml": { "type": "string" }, "descriptionPlain": { "type": "string" }, "status": { "type": "string", "enum": ["todo", "done"] }, "dueAt": { "type": "number", "description": "Unix timestamp in ms." }, "assigneeUserIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "linkedResources": { "type": "array", "items": { "type": "object", "properties": { "resourceType": { "type": "string" }, "resourceId": { "type": "string" }, "label": { "type": "string" }, "channel": { "type": "string" } }, "required": ["resourceType", "resourceId"] } }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "title", "status", "createdAt", "updatedAt" ] } }, "required": ["task"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "tasks.complete", "scopes": ["tasks:write"], "automation": { "kind": "action", "resource": "tasks", "noun": "Task", "label": "Complete a task", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "tasks_complete" }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/records/{recordId}/custom-activities": { "post": { "tags": ["Records"], "summary": "Create a custom activity", "description": "Create a custom activity linked to a CRM record and notify any other workspace users supplied as participants, including by email when their notification preferences enable it.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "createRecordCustomActivity", "security": [ { "ApiKeyBearer": ["records:write"] }, { "BreakcoldOAuth": ["records:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "activity": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "title": { "type": "string" }, "descriptionHtml": { "type": "string" }, "descriptionPlain": { "type": "string" }, "startAt": { "type": "number", "description": "Unix timestamp in ms." }, "endAt": { "type": "number", "description": "Unix timestamp in ms." }, "primaryRecordId": { "type": "string", "minLength": 6 }, "linkedRecordIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "participantUserIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "createdByUserId": { "type": "string", "minLength": 6 }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "title", "startAt", "linkedRecordIds", "participantUserIds", "createdAt", "updatedAt" ] } }, "required": ["activity"] } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "activity": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "title": { "type": "string" }, "descriptionHtml": { "type": "string" }, "descriptionPlain": { "type": "string" }, "startAt": { "type": "number", "description": "Unix timestamp in ms." }, "endAt": { "type": "number", "description": "Unix timestamp in ms." }, "primaryRecordId": { "type": "string", "minLength": 6 }, "linkedRecordIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "participantUserIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "createdByUserId": { "type": "string", "minLength": 6 }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "title", "startAt", "linkedRecordIds", "participantUserIds", "createdAt", "updatedAt" ] } }, "required": ["activity"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "custom_activities.create", "scopes": ["records:write"], "automation": { "kind": "create", "resource": "custom_activities", "noun": "Record", "label": "Create a custom activity", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "custom_activities_create" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "descriptionHtml": { "type": "string" }, "descriptionPlain": { "type": "string" }, "startAt": { "type": "number", "description": "Unix timestamp in ms." }, "endAt": { "type": "number", "description": "Unix timestamp in ms." }, "linkedRecordIds": { "type": "array", "items": { "type": "string", "minLength": 6 } }, "participantUserIds": { "type": "array", "items": { "type": "string", "minLength": 6 } } }, "required": ["title"] } } } } } }, "/records/{recordId}/notes": { "get": { "tags": ["Notes"], "summary": "List record notes", "description": "List notes linked to a record.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "listRecordNotes", "security": [ { "ApiKeyBearer": ["notes:read"] }, { "BreakcoldOAuth": ["notes:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "recordId": { "type": "string", "minLength": 6 }, "title": { "type": "string" }, "content": { "type": "string" }, "contentPlain": { "type": "string" }, "author": { "type": "object", "properties": { "type": { "type": "string", "enum": ["user", "application", "agent", "ai"] }, "id": { "type": "string", "minLength": 6 }, "name": { "type": "string" } }, "required": ["type", "name"] }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "title", "content", "createdAt", "updatedAt" ] } }, "pagination": { "type": "object", "properties": { "cursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["cursor", "hasMore"] } }, "required": ["data", "pagination"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "notes.list", "scopes": ["notes:read"], "automation": { "kind": "search", "resource": "notes", "noun": "Note", "label": "List record notes", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "notes_list" } }, "post": { "tags": ["Notes"], "summary": "Create a record note", "description": "Create a note linked to a record. If the workspace has a matching active webhook, the note-created event is delivered to its external URL.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "createRecordNote", "security": [ { "ApiKeyBearer": ["notes:write"] }, { "BreakcoldOAuth": ["notes:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "recordId": { "type": "string", "minLength": 6 }, "title": { "type": "string" }, "content": { "type": "string" }, "contentPlain": { "type": "string" }, "author": { "type": "object", "properties": { "type": { "type": "string", "enum": ["user", "application", "agent", "ai"] }, "id": { "type": "string", "minLength": 6 }, "name": { "type": "string" } }, "required": ["type", "name"] }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "title", "content", "createdAt", "updatedAt" ] } }, "required": ["note"] } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "recordId": { "type": "string", "minLength": 6 }, "title": { "type": "string" }, "content": { "type": "string" }, "contentPlain": { "type": "string" }, "author": { "type": "object", "properties": { "type": { "type": "string", "enum": ["user", "application", "agent", "ai"] }, "id": { "type": "string", "minLength": 6 }, "name": { "type": "string" } }, "required": ["type", "name"] }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "title", "content", "createdAt", "updatedAt" ] } }, "required": ["note"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "notes.create", "scopes": ["notes:write"], "automation": { "kind": "create", "resource": "notes", "noun": "Note", "label": "Create a record note", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "notes_create" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "content": { "type": "string" }, "contentPlain": { "type": "string" } }, "required": ["title", "content"] } } } } } }, "/notes/{noteId}": { "get": { "tags": ["Notes"], "summary": "Get a note", "description": "Fetch a note by ID.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "getNote", "security": [ { "ApiKeyBearer": ["notes:read"] }, { "BreakcoldOAuth": ["notes:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "noteId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "recordId": { "type": "string", "minLength": 6 }, "title": { "type": "string" }, "content": { "type": "string" }, "contentPlain": { "type": "string" }, "author": { "type": "object", "properties": { "type": { "type": "string", "enum": ["user", "application", "agent", "ai"] }, "id": { "type": "string", "minLength": 6 }, "name": { "type": "string" } }, "required": ["type", "name"] }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "title", "content", "createdAt", "updatedAt" ] } }, "required": ["note"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "notes.get", "scopes": ["notes:read"], "automation": { "kind": "search", "resource": "notes", "noun": "Note", "label": "Get a note", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "notes_get" } }, "patch": { "tags": ["Notes"], "summary": "Update a note", "description": "Update note content. If the workspace has a matching active webhook, the note-updated event is delivered to its external URL.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "updateNote", "security": [ { "ApiKeyBearer": ["notes:write"] }, { "BreakcoldOAuth": ["notes:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "noteId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "recordId": { "type": "string", "minLength": 6 }, "title": { "type": "string" }, "content": { "type": "string" }, "contentPlain": { "type": "string" }, "author": { "type": "object", "properties": { "type": { "type": "string", "enum": ["user", "application", "agent", "ai"] }, "id": { "type": "string", "minLength": 6 }, "name": { "type": "string" } }, "required": ["type", "name"] }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "title", "content", "createdAt", "updatedAt" ] } }, "required": ["note"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "notes.update", "scopes": ["notes:write"], "automation": { "kind": "action", "resource": "notes", "noun": "Note", "label": "Update a note", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "notes_update" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string" }, "content": { "type": "string" }, "contentPlain": { "type": "string" } } } } } } } }, "/inbox/conversations": { "get": { "tags": ["Inbox"], "summary": "List workspace conversations", "description": "List or search inbox conversations in a workspace. Optionally apply a saved inbox view and filter by record-link state.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "searchInboxConversations", "security": [ { "ApiKeyBearer": ["inbox:read"] }, { "BreakcoldOAuth": ["inbox:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 6 } }, { "name": "viewId", "in": "query", "required": false, "schema": { "type": "string", "minLength": 6 } }, { "name": "hasLinkedRecords", "in": "query", "required": false, "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "nowMs", "in": "query", "required": false, "schema": { "type": "number" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "channel": { "type": "string", "enum": [ "email", "linkedin", "telegram", "whatsapp" ] }, "subject": { "type": "string" }, "lifecycle": { "type": "string" }, "mailbox": { "type": "string" }, "lastMessageAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "lastMessageSnippet": { "type": "string" }, "isClosed": { "type": "boolean" }, "hasAttachments": { "type": "boolean" }, "hasLinkedRecords": { "type": "boolean" }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "displayName": { "type": "string" }, "handle": { "type": "string" }, "email": { "type": "string" }, "isSender": { "type": "boolean" }, "isWorkspaceMember": { "type": "boolean" } }, "required": ["id"] } }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": ["id"] } } }, "required": [ "id", "workspaceId", "channel", "lastMessageAtMs", "isClosed" ] } }, "pagination": { "type": "object", "properties": { "cursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["cursor", "hasMore"] } }, "required": ["data", "pagination"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.conversations.search", "scopes": ["inbox:read"], "automation": { "kind": "search", "resource": "inbox", "noun": "Inbox", "label": "List workspace conversations", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "inbox_conversations_search" } }, "post": { "tags": ["Inbox"], "summary": "Compose and send a new inbox message", "description": "Send a new email, LinkedIn, Telegram, or WhatsApp message immediately and create or upsert the resulting inbox conversation.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "composeInboxConversation", "security": [ { "ApiKeyBearer": ["inbox:send"] }, { "BreakcoldOAuth": ["inbox:send"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "conversation": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "channel": { "type": "string", "enum": ["email", "linkedin", "telegram", "whatsapp"] }, "subject": { "type": "string" }, "lifecycle": { "type": "string" }, "mailbox": { "type": "string" }, "lastMessageAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "lastMessageSnippet": { "type": "string" }, "isClosed": { "type": "boolean" }, "hasAttachments": { "type": "boolean" }, "hasLinkedRecords": { "type": "boolean" }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "displayName": { "type": "string" }, "handle": { "type": "string" }, "email": { "type": "string" }, "isSender": { "type": "boolean" }, "isWorkspaceMember": { "type": "boolean" } }, "required": ["id"] } }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": ["id"] } } }, "required": [ "id", "workspaceId", "channel", "lastMessageAtMs", "isClosed" ] }, "message": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "conversationId": { "type": "string", "minLength": 6 }, "channel": { "type": "string", "enum": ["email", "linkedin", "telegram", "whatsapp"] }, "direction": { "type": "string", "enum": ["inbound", "outbound", "system"] }, "textPlain": { "type": "string" }, "textHtml": { "type": "string" }, "subject": { "type": "string" }, "sentAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "receivedAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "attachmentCount": { "type": "number" } }, "required": [ "id", "workspaceId", "conversationId", "direction", "sentAtMs" ] }, "providerMessageId": { "type": "string" } }, "required": ["conversation", "message"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.conversations.compose", "scopes": ["inbox:send"], "automation": { "kind": "action", "resource": "inbox", "noun": "Inbox", "label": "Compose and send a new inbox message", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "inbox_conversations_compose" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaceId": { "type": "string", "minLength": 6 }, "workspaceIntegrationAccountId": { "type": "string", "minLength": 6 }, "channel": { "type": "string", "enum": ["email", "linkedin", "telegram", "whatsapp"] }, "textPlain": { "type": "string" }, "textHtml": { "type": "string" }, "recordId": { "type": "string", "minLength": 6 }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "storageId": { "type": "string", "minLength": 6 }, "filename": { "type": "string" }, "mimeType": { "type": "string" } }, "required": ["storageId", "filename", "mimeType"] } }, "email": { "type": "object", "properties": { "to": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "required": ["email"] } }, "cc": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "required": ["email"] } }, "bcc": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "required": ["email"] } }, "subject": { "type": "string" }, "trackingOptions": { "type": "object", "properties": { "trackOpens": { "type": "boolean" }, "trackLinks": { "type": "boolean" } }, "required": ["trackOpens", "trackLinks"] } }, "required": ["to"] }, "socialIdentifier": { "type": "string", "description": "Recipient identifier for social channels, such as the provider username, account identifier, or phone number expected by the selected LinkedIn, Telegram, or WhatsApp account." } }, "required": [ "workspaceId", "workspaceIntegrationAccountId", "channel", "textPlain" ] } } } } } }, "/inbox/send-accounts": { "get": { "tags": ["Inbox"], "summary": "List send accounts", "description": "List inbox accounts the authenticated public API actor can send from in a workspace, optionally filtered by channel.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "listInboxSendAccounts", "security": [ { "ApiKeyBearer": ["inbox:send"] }, { "BreakcoldOAuth": ["inbox:send"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 6 } }, { "name": "channel", "in": "query", "required": false, "schema": { "type": "string", "enum": ["email", "linkedin", "telegram", "whatsapp"] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "workspaceIntegrationAccountId": { "type": "string", "minLength": 6 }, "channel": { "type": "string", "enum": [ "email", "linkedin", "telegram", "whatsapp" ] }, "label": { "type": "string" }, "status": { "type": ["string", "null"] }, "canReply": { "type": "boolean" }, "canReplyAll": { "type": "boolean" }, "canReplyRecordOnly": { "type": "boolean" }, "isDefault": { "type": "boolean" } }, "required": [ "workspaceIntegrationAccountId", "channel", "label", "status", "canReply", "canReplyAll", "canReplyRecordOnly", "isDefault" ] } }, "pagination": { "type": "object", "properties": { "cursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["cursor", "hasMore"] } }, "required": ["data", "pagination"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.send_accounts.list", "scopes": ["inbox:send"], "automation": { "kind": "search", "resource": "inbox", "noun": "Inbox", "label": "List send accounts", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "inbox_send_accounts_list" } } }, "/inbox/attachments/upload-url": { "post": { "tags": ["Inbox"], "summary": "Create an inbox attachment upload URL", "description": "Create a Convex file-storage upload URL for inbox send attachments. Upload to this URL, then pass the returned storageId in a send request.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "createInboxAttachmentUploadUrl", "security": [ { "ApiKeyBearer": ["inbox:send"] }, { "BreakcoldOAuth": ["inbox:send"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "uploadUrl": { "type": "string" } }, "required": ["uploadUrl"] } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "uploadUrl": { "type": "string" } }, "required": ["uploadUrl"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.attachments.upload_url.create", "scopes": ["inbox:send"], "automation": { "kind": "create", "resource": "inbox", "noun": "Inbox", "label": "Create an inbox attachment upload URL", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "inbox_attachments_upload_url_create" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaceId": { "type": "string", "minLength": 6 } }, "required": ["workspaceId"] } } } } } }, "/records/{recordId}/conversations": { "get": { "tags": ["Inbox"], "summary": "List record conversations", "description": "List inbox conversations linked to a record.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "listRecordConversations", "security": [ { "ApiKeyBearer": ["inbox:read"] }, { "BreakcoldOAuth": ["inbox:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "recordId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "channel": { "type": "string", "enum": [ "email", "linkedin", "telegram", "whatsapp" ] }, "subject": { "type": "string" }, "lifecycle": { "type": "string" }, "mailbox": { "type": "string" }, "lastMessageAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "lastMessageSnippet": { "type": "string" }, "isClosed": { "type": "boolean" }, "hasAttachments": { "type": "boolean" }, "hasLinkedRecords": { "type": "boolean" }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "displayName": { "type": "string" }, "handle": { "type": "string" }, "email": { "type": "string" }, "isSender": { "type": "boolean" }, "isWorkspaceMember": { "type": "boolean" } }, "required": ["id"] } }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": ["id"] } } }, "required": [ "id", "workspaceId", "channel", "lastMessageAtMs", "isClosed" ] } }, "pagination": { "type": "object", "properties": { "cursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["cursor", "hasMore"] } }, "required": ["data", "pagination"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.conversations.list", "scopes": ["inbox:read"], "automation": { "kind": "search", "resource": "inbox", "noun": "Inbox", "label": "List record conversations", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "inbox_conversations_list" } } }, "/conversations/{conversationId}/messages": { "get": { "tags": ["Inbox"], "summary": "List conversation messages", "description": "List messages for a conversation.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "listConversationMessages", "security": [ { "ApiKeyBearer": ["inbox:read"] }, { "BreakcoldOAuth": ["inbox:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "conversationId": { "type": "string", "minLength": 6 }, "channel": { "type": "string", "enum": [ "email", "linkedin", "telegram", "whatsapp" ] }, "direction": { "type": "string", "enum": ["inbound", "outbound", "system"] }, "textPlain": { "type": "string" }, "textHtml": { "type": "string" }, "subject": { "type": "string" }, "sentAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "receivedAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "attachmentCount": { "type": "number" } }, "required": [ "id", "workspaceId", "conversationId", "direction", "sentAtMs" ] } }, "pagination": { "type": "object", "properties": { "cursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["cursor", "hasMore"] } }, "required": ["data", "pagination"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.messages.list", "scopes": ["inbox:read"], "automation": { "kind": "search", "resource": "inbox", "noun": "Inbox", "label": "List conversation messages", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "inbox_messages_list" } }, "post": { "tags": ["Inbox"], "summary": "Send a message in an existing conversation", "description": "Send an immediate social message, email reply, or email forward using the existing inbox send behavior. Email forwards return the newly created forwarded conversation.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "sendInboxMessage", "security": [ { "ApiKeyBearer": ["inbox:send"] }, { "BreakcoldOAuth": ["inbox:send"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "conversation": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "channel": { "type": "string", "enum": ["email", "linkedin", "telegram", "whatsapp"] }, "subject": { "type": "string" }, "lifecycle": { "type": "string" }, "mailbox": { "type": "string" }, "lastMessageAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "lastMessageSnippet": { "type": "string" }, "isClosed": { "type": "boolean" }, "hasAttachments": { "type": "boolean" }, "hasLinkedRecords": { "type": "boolean" }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "displayName": { "type": "string" }, "handle": { "type": "string" }, "email": { "type": "string" }, "isSender": { "type": "boolean" }, "isWorkspaceMember": { "type": "boolean" } }, "required": ["id"] } }, "assignees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": ["id"] } } }, "required": [ "id", "workspaceId", "channel", "lastMessageAtMs", "isClosed" ] }, "message": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "conversationId": { "type": "string", "minLength": 6 }, "channel": { "type": "string", "enum": ["email", "linkedin", "telegram", "whatsapp"] }, "direction": { "type": "string", "enum": ["inbound", "outbound", "system"] }, "textPlain": { "type": "string" }, "textHtml": { "type": "string" }, "subject": { "type": "string" }, "sentAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "receivedAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "attachmentCount": { "type": "number" } }, "required": [ "id", "workspaceId", "conversationId", "direction", "sentAtMs" ] }, "providerMessageId": { "type": "string" } }, "required": ["conversation", "message"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.messages.send", "scopes": ["inbox:send"], "automation": { "kind": "action", "resource": "inbox", "noun": "Inbox", "label": "Send a message in an existing conversation", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "inbox_messages_send" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "clientMessageId": { "type": "string" }, "textPlain": { "type": "string" }, "textHtml": { "type": "string" }, "replyToMessageId": { "type": "string" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "storageId": { "type": "string", "minLength": 6 }, "filename": { "type": "string" }, "mimeType": { "type": "string" } }, "required": ["storageId", "filename", "mimeType"] } }, "email": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["reply", "forward"] }, "to": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "required": ["email"] } }, "cc": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "required": ["email"] } }, "bcc": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "required": ["email"] } }, "subject": { "type": "string" }, "forwardMessageId": { "type": "string", "minLength": 6 }, "existingAttachments": { "type": "array", "items": { "type": "object", "properties": { "storageId": { "type": "string", "minLength": 6 }, "filename": { "type": "string" }, "mimeType": { "type": "string" } }, "required": ["storageId", "filename", "mimeType"] } }, "trackingOptions": { "type": "object", "properties": { "trackOpens": { "type": "boolean" }, "trackLinks": { "type": "boolean" } }, "required": ["trackOpens", "trackLinks"] } }, "required": ["mode", "to"] } }, "required": ["textPlain"] } } } } } }, "/conversations/{conversationId}/draft": { "get": { "tags": ["Inbox"], "summary": "Get a conversation draft", "description": "Get the authenticated effective user's private draft for an inbox conversation, or null when no draft exists.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "getInboxConversationDraft", "security": [ { "ApiKeyBearer": ["inbox:read"] }, { "BreakcoldOAuth": ["inbox:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "draft": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "conversationId": { "type": "string", "minLength": 6 }, "textPlain": { "type": "string" }, "textHtml": { "type": "string" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "conversationId", "textPlain", "createdAt", "updatedAt" ] }, { "type": "null" } ] } }, "required": ["draft"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.conversation_draft.get", "scopes": ["inbox:read"], "automation": { "kind": "search", "resource": "inbox", "noun": "Inbox", "label": "Get a conversation draft", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "inbox_conversation_draft_get" } }, "patch": { "tags": ["Inbox"], "summary": "Set a conversation draft", "description": "Create or update the authenticated effective user's private draft. Blank content clears the draft. HTML is accepted for email conversations only.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "setInboxConversationDraft", "security": [ { "ApiKeyBearer": ["inbox:send"] }, { "BreakcoldOAuth": ["inbox:send"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "draft": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "conversationId": { "type": "string", "minLength": 6 }, "textPlain": { "type": "string" }, "textHtml": { "type": "string" }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "conversationId", "textPlain", "createdAt", "updatedAt" ] }, { "type": "null" } ] } }, "required": ["draft"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.conversation_draft.set", "scopes": ["inbox:send"], "automation": { "kind": "action", "resource": "inbox", "noun": "Inbox", "label": "Set a conversation draft", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "inbox_conversation_draft_set" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "textPlain": { "type": "string" }, "textHtml": { "type": "string" } }, "required": ["textPlain"] } } } } }, "delete": { "tags": ["Inbox"], "summary": "Clear a conversation draft", "description": "Clear only the authenticated effective user's private draft for an inbox conversation.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "clearInboxConversationDraft", "security": [ { "ApiKeyBearer": ["inbox:send"] }, { "BreakcoldOAuth": ["inbox:send"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "cleared": { "type": "boolean" } }, "required": ["cleared"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.conversation_draft.clear", "scopes": ["inbox:send"], "automation": { "kind": "action", "resource": "inbox", "noun": "Inbox", "label": "Clear a conversation draft", "hidden": false, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "inbox_conversation_draft_clear" }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/messages/{messageId}": { "get": { "tags": ["Inbox"], "summary": "Get a message", "description": "Fetch one inbox message.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "getMessage", "security": [ { "ApiKeyBearer": ["inbox:read"] }, { "BreakcoldOAuth": ["inbox:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "messageId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "conversationId": { "type": "string", "minLength": 6 }, "channel": { "type": "string", "enum": ["email", "linkedin", "telegram", "whatsapp"] }, "direction": { "type": "string", "enum": ["inbound", "outbound", "system"] }, "textPlain": { "type": "string" }, "textHtml": { "type": "string" }, "subject": { "type": "string" }, "sentAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "receivedAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "attachmentCount": { "type": "number" } }, "required": [ "id", "workspaceId", "conversationId", "direction", "sentAtMs" ] } }, "required": ["message"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "inbox.messages.get", "scopes": ["inbox:read"], "automation": { "kind": "search", "resource": "inbox", "noun": "Inbox", "label": "Get a message", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "inbox_messages_get" } } }, "/meetings": { "get": { "tags": ["Meetings"], "summary": "List meetings", "description": "List workspace meetings with recording and transcript metadata.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "listMeetings", "security": [ { "ApiKeyBearer": ["meetings:read"] }, { "BreakcoldOAuth": ["meetings:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 6 } }, { "name": "eventState", "in": "query", "required": false, "schema": { "type": "string", "enum": ["active", "cancelled", "deleted"], "default": "active" } }, { "name": "hasTranscript", "in": "query", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "title": { "type": "string" }, "description": { "type": "string" }, "startTimeMs": { "type": "number", "description": "Unix timestamp in ms." }, "endTimeMs": { "type": "number", "description": "Unix timestamp in ms." }, "timezone": { "type": "string" }, "isAllDay": { "type": "boolean" }, "meetingUrl": { "type": "string" }, "organizerEmail": { "type": "string" }, "attendeeEmails": { "type": "array", "items": { "type": "string" } }, "eventState": { "type": "string", "enum": ["active", "cancelled", "deleted"] }, "botPlannedAction": { "type": "string", "enum": ["record", "do_not_record"] }, "botPlannedReason": { "type": "string" }, "callRecordingId": { "type": "string", "minLength": 6 }, "callStatus": { "type": "string" }, "recordingStatus": { "type": "string" }, "durationSec": { "type": "number" }, "startedAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "endedAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "hasTranscript": { "type": "boolean" }, "transcriptStatus": { "type": "string" }, "participants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "email": { "type": "string" }, "isHost": { "type": "boolean" }, "invitationStatus": { "type": "string" }, "fromCalendarInvitee": { "type": "boolean" }, "fromRealtimeParticipant": { "type": "boolean" }, "resolvedRecordId": { "type": "string", "minLength": 6 }, "callRecordingId": { "type": "string", "minLength": 6 } }, "required": ["id", "name"] } }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "startTimeMs", "eventState", "botPlannedAction", "hasTranscript", "participants", "createdAt", "updatedAt" ] } }, "pagination": { "type": "object", "properties": { "cursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["cursor", "hasMore"] } }, "required": ["data", "pagination"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "meetings.list", "scopes": ["meetings:read"], "automation": { "kind": "search", "resource": "meetings", "noun": "Meeting", "label": "List meetings", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "meetings_list" } } }, "/meetings/{meetingId}": { "get": { "tags": ["Meetings"], "summary": "Get a meeting", "description": "Fetch one meeting with recording and transcript metadata.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "getMeeting", "security": [ { "ApiKeyBearer": ["meetings:read"] }, { "BreakcoldOAuth": ["meetings:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "meetingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "meeting": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "title": { "type": "string" }, "description": { "type": "string" }, "startTimeMs": { "type": "number", "description": "Unix timestamp in ms." }, "endTimeMs": { "type": "number", "description": "Unix timestamp in ms." }, "timezone": { "type": "string" }, "isAllDay": { "type": "boolean" }, "meetingUrl": { "type": "string" }, "organizerEmail": { "type": "string" }, "attendeeEmails": { "type": "array", "items": { "type": "string" } }, "eventState": { "type": "string", "enum": ["active", "cancelled", "deleted"] }, "botPlannedAction": { "type": "string", "enum": ["record", "do_not_record"] }, "botPlannedReason": { "type": "string" }, "callRecordingId": { "type": "string", "minLength": 6 }, "callStatus": { "type": "string" }, "recordingStatus": { "type": "string" }, "durationSec": { "type": "number" }, "startedAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "endedAtMs": { "type": "number", "description": "Unix timestamp in ms." }, "hasTranscript": { "type": "boolean" }, "transcriptStatus": { "type": "string" }, "participants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "name": { "type": "string" }, "email": { "type": "string" }, "isHost": { "type": "boolean" }, "invitationStatus": { "type": "string" }, "fromCalendarInvitee": { "type": "boolean" }, "fromRealtimeParticipant": { "type": "boolean" }, "resolvedRecordId": { "type": "string", "minLength": 6 }, "callRecordingId": { "type": "string", "minLength": 6 } }, "required": ["id", "name"] } }, "createdAt": { "type": "number", "description": "Unix timestamp in ms." }, "updatedAt": { "type": "number", "description": "Unix timestamp in ms." } }, "required": [ "id", "workspaceId", "startTimeMs", "eventState", "botPlannedAction", "hasTranscript", "participants", "createdAt", "updatedAt" ] } }, "required": ["meeting"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "meetings.get", "scopes": ["meetings:read"], "automation": { "kind": "search", "resource": "meetings", "noun": "Meeting", "label": "Get a meeting", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "meetings_get" } } }, "/meetings/{meetingId}/transcript": { "get": { "tags": ["Meetings"], "summary": "List meeting transcript segments", "description": "List full meeting transcript text in ordered paginated segments.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "listMeetingTranscript", "security": [ { "ApiKeyBearer": ["meetings:read"] }, { "BreakcoldOAuth": ["meetings:read"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "meetingId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "meetingId": { "type": "string", "minLength": 6 }, "callRecordingId": { "type": "string", "minLength": 6 }, "callTranscriptId": { "type": "string", "minLength": 6 }, "segmentIndex": { "type": "number" }, "participantName": { "type": "string" }, "participantEmail": { "type": "string" }, "text": { "type": "string" }, "startSec": { "type": "number" }, "endSec": { "type": "number" }, "startIso": { "type": "string" }, "endIso": { "type": "string" } }, "required": [ "id", "meetingId", "callRecordingId", "callTranscriptId", "segmentIndex", "text", "startSec", "endSec" ] } }, "pagination": { "type": "object", "properties": { "cursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["cursor", "hasMore"] } }, "required": ["data", "pagination"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "meetings.transcript.list", "scopes": ["meetings:read"], "automation": { "kind": "search", "resource": "meetings", "noun": "Meeting", "label": "List meeting transcript segments", "hidden": false, "advanced": false }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "meetings_transcript_list" } } }, "/integration-hooks": { "post": { "tags": ["Webhooks"], "summary": "Create an integration hook", "description": "Create and activate a Zapier or Make webhook subscription that delivers matching future Breakcold events to the supplied external HTTPS URL.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "createIntegrationHook", "security": [ { "ApiKeyBearer": ["webhooks:write"] }, { "BreakcoldOAuth": ["webhooks:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "hook": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "endpointId": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "eventType": { "type": "string", "enum": [ "record.created", "record.updated", "record.deleted", "note.created", "note.updated", "note.deleted", "task.created", "task.completed", "relation.added", "relation.removed", "call.linked", "call.unlinked", "file.uploaded", "file.deleted" ] }, "platform": { "type": "string", "enum": ["zapier", "make"] } }, "required": [ "id", "endpointId", "workspaceId", "eventType", "platform" ] } }, "required": ["hook"] } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "properties": { "hook": { "type": "object", "properties": { "id": { "type": "string", "minLength": 6 }, "endpointId": { "type": "string", "minLength": 6 }, "workspaceId": { "type": "string", "minLength": 6 }, "eventType": { "type": "string", "enum": [ "record.created", "record.updated", "record.deleted", "note.created", "note.updated", "note.deleted", "task.created", "task.completed", "relation.added", "relation.removed", "call.linked", "call.unlinked", "file.uploaded", "file.deleted" ] }, "platform": { "type": "string", "enum": ["zapier", "make"] } }, "required": [ "id", "endpointId", "workspaceId", "eventType", "platform" ] } }, "required": ["hook"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "integration_hooks.create", "scopes": ["webhooks:write"], "automation": { "kind": "platformLifecycle", "resource": "integration_hooks", "noun": "Webhook", "label": "Create an integration hook", "hidden": true, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "integration_hooks_create" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "workspaceId": { "type": "string", "minLength": 6 }, "platform": { "type": "string", "enum": ["zapier", "make"] }, "targetUrl": { "type": "string", "format": "uri" }, "eventType": { "type": "string", "enum": [ "record.created", "record.updated", "record.deleted", "note.created", "note.updated", "note.deleted", "task.created", "task.completed", "relation.added", "relation.removed", "call.linked", "call.unlinked", "file.uploaded", "file.deleted" ] }, "filterObjectTypeIds": { "type": "array", "items": { "type": "string", "minLength": 6 } } }, "required": [ "workspaceId", "platform", "targetUrl", "eventType" ] }, "example": { "workspaceId": "workspace_id", "platform": "zapier", "targetUrl": "https://hooks.zapier.com/hooks/catch/123/abc", "eventType": "record.created" } } } } } }, "/integration-hooks/{hookId}": { "delete": { "tags": ["Webhooks"], "summary": "Delete an integration hook", "description": "Permanently delete a Zapier or Make instant-trigger webhook subscription and its stored delivery logs. The operation is idempotent.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.4 tokens120 requests/min per route/org
", "operationId": "deleteIntegrationHook", "security": [ { "ApiKeyBearer": ["webhooks:write"] }, { "BreakcoldOAuth": ["webhooks:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "Idempotency-Key", "in": "header", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate." }, { "name": "hookId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" }, "id": { "type": "string", "minLength": 6 } }, "required": ["deleted", "id"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "integration_hooks.delete", "scopes": ["webhooks:write"], "automation": { "kind": "platformLifecycle", "resource": "integration_hooks", "noun": "Webhook", "label": "Delete an integration hook", "hidden": true, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.4, "featureId": "public_api_write_route", "featureLabel": "Public API/MCP Write Route", "tokenCost": 0.4, "display": "0.4 tokens" }, "mcpTool": "integration_hooks_delete" }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/integration-samples": { "get": { "tags": ["Webhooks"], "summary": "List integration samples", "description": "Return generated sample payloads for automation-platform trigger setup.\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
Token costRate limit
0.2 tokens120 requests/min per route/org
", "operationId": "listIntegrationSamples", "security": [ { "ApiKeyBearer": ["webhooks:write"] }, { "BreakcoldOAuth": ["webhooks:write"] } ], "parameters": [ { "name": "X-Breakcold-Organization-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token." }, { "name": "workspaceId", "in": "query", "required": true, "schema": { "type": "string", "minLength": 6 } }, { "name": "eventType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "record.created", "record.updated", "record.deleted", "note.created", "note.updated", "note.deleted", "task.created", "task.completed", "relation.added", "relation.removed", "call.linked", "call.unlinked", "file.uploaded", "file.deleted" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "samples": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "required": ["samples"] } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-breakcold": { "routeKey": "integration_samples.list", "scopes": ["webhooks:write"], "automation": { "kind": "platformLifecycle", "resource": "integration_samples", "noun": "Webhook", "label": "List integration samples", "hidden": true, "advanced": true }, "rateLimit": { "route": { "perMinute": 120, "scope": "same route in the same organization" }, "shared": { "organizationPerMinute": 600, "workspacePerMinute": 300, "actorPerMinute": 180, "apiKeyPerMinute": 180, "platformPerMinute": 2000 } }, "billing": { "mode": "fixed", "tokenAmount": 0.2, "featureId": "public_api_read_route", "featureLabel": "Public API/MCP Read Route", "tokenCost": 0.2, "display": "0.2 tokens" }, "mcpTool": "integration_samples_list" } } } }, "components": { "securitySchemes": { "ApiKeyBearer": { "type": "http", "scheme": "bearer", "description": "Breakcold public API key, for example `Bearer bc_live_...`." }, "BreakcoldOAuth": { "type": "oauth2", "description": "Breakcold signed-in user access token. Most REST API integrations should use an API key instead.", "flows": { "authorizationCode": { "authorizationUrl": "https://YOUR_AUTH_DOMAIN/oauth2/authorize", "tokenUrl": "https://YOUR_AUTH_DOMAIN/oauth2/token", "scopes": { "records:read": "Access records:read", "records:write": "Access records:write", "tasks:read": "Access tasks:read", "tasks:write": "Access tasks:write", "notes:read": "Access notes:read", "notes:write": "Access notes:write", "inbox:read": "Access inbox:read", "inbox:send": "Access inbox:send", "crm:metadata:read": "Access crm:metadata:read", "crm:metadata:write": "Access crm:metadata:write", "inbox:views:read": "Access inbox:views:read", "inbox:views:write": "Access inbox:views:write", "meetings:read": "Access meetings:read", "webhooks:write": "Access webhooks:write" } } } } }, "schemas": { "PublicApiError": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "details": {}, "retryAfterMs": { "type": "number" } }, "required": ["code", "message", "requestId"] } }, "required": ["error"] } }, "responses": { "BadRequest": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiError" } } } }, "Unauthorized": { "description": "Missing or invalid authentication", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiError" } } } }, "Forbidden": { "description": "Authenticated actor cannot access this route or workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiError" } } } }, "NotFound": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiError" } } } }, "RateLimited": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApiError" } } } } } } }