# Breakcold API

## Docs

- [Overview](https://docs.breakcold.com/api/overview.md): Breakcold API overview.
- [Webhooks](https://docs.breakcold.com/api/webhooks.md): Understand outbound Breakcold webhooks, delivery headers, signatures, and event payloads.
- [Record Webhooks](https://docs.breakcold.com/api/webhooks/records.md): Payloads for record created, updated, and deleted events.
- [Note Webhooks](https://docs.breakcold.com/api/webhooks/notes.md): Payloads for note created, updated, and deleted events.
- [Task Webhooks](https://docs.breakcold.com/api/webhooks/tasks.md): Payloads for task created and completed events.
- [Relation Webhooks](https://docs.breakcold.com/api/webhooks/relations.md): Payloads for relation added and removed events.
- [Call Webhooks](https://docs.breakcold.com/api/webhooks/calls.md): Payloads for call linked and unlinked events.
- [File Webhooks](https://docs.breakcold.com/api/webhooks/files.md): Payloads for file uploaded and deleted events.
- [Objects & Records](https://docs.breakcold.com/api/core-concepts/objects-records.md): Understand how Breakcold objects and records work in the API.
- [Users, Workspaces, and Organizations](https://docs.breakcold.com/api/core-concepts/users-workspaces-organizations.md): Understand Breakcold's account and permission model.
- [Attributes](https://docs.breakcold.com/api/core-concepts/attributes.md): Understand fields and values on Breakcold records.
- [Text](https://docs.breakcold.com/api/core-concepts/attributes/text.md): Use text attributes in the Breakcold API.
- [Text Area](https://docs.breakcold.com/api/core-concepts/attributes/textarea.md): Use textarea attributes in the Breakcold API.
- [Email](https://docs.breakcold.com/api/core-concepts/attributes/email.md): Use email attributes in the Breakcold API.
- [Phone](https://docs.breakcold.com/api/core-concepts/attributes/phone.md): Use phone attributes in the Breakcold API.
- [Number](https://docs.breakcold.com/api/core-concepts/attributes/number.md): Use number attributes in the Breakcold API.
- [Currency](https://docs.breakcold.com/api/core-concepts/attributes/currency.md): Use currency attributes in the Breakcold API.
- [Checkbox](https://docs.breakcold.com/api/core-concepts/attributes/checkbox.md): Use checkbox attributes in the Breakcold API.
- [Select](https://docs.breakcold.com/api/core-concepts/attributes/select.md): Use select attributes in the Breakcold API.
- [Multi-Select](https://docs.breakcold.com/api/core-concepts/attributes/multiselect.md): Use multiselect attributes in the Breakcold API.
- [Location](https://docs.breakcold.com/api/core-concepts/attributes/location.md): Use location attributes in the Breakcold API.
- [LinkedIn](https://docs.breakcold.com/api/core-concepts/attributes/linkedin.md): Use linkedin attributes in the Breakcold API.
- [Twitter](https://docs.breakcold.com/api/core-concepts/attributes/twitter.md): Use twitter attributes in the Breakcold API.
- [Telegram](https://docs.breakcold.com/api/core-concepts/attributes/telegram.md): Use telegram attributes in the Breakcold API.
- [WhatsApp](https://docs.breakcold.com/api/core-concepts/attributes/whatsapp.md): Use whatsapp attributes in the Breakcold API.
- [Facebook](https://docs.breakcold.com/api/core-concepts/attributes/facebook.md): Use facebook attributes in the Breakcold API.
- [Relation](https://docs.breakcold.com/api/core-concepts/attributes/relation.md): Use relation attributes in the Breakcold API.
- [Date](https://docs.breakcold.com/api/core-concepts/attributes/date.md): Use date attributes in the Breakcold API.
- [Date & Time](https://docs.breakcold.com/api/core-concepts/attributes/datetime.md): Use datetime attributes in the Breakcold API.
- [Member](https://docs.breakcold.com/api/core-concepts/attributes/member.md): Use member attributes in the Breakcold API.
- [URL](https://docs.breakcold.com/api/core-concepts/attributes/url.md): Use url attributes in the Breakcold API.
- [API changelog](https://docs.breakcold.com/api/changelog.md): Breaking changes, new capabilities, and migration guidance for the Breakcold REST API and MCP.
- [Authentication](https://docs.breakcold.com/api/authentication.md): Get an API key and use it as your REST API token.
- [Rate limits](https://docs.breakcold.com/api/rate-limits.md): Understand REST API rate limits and what to do when you hit one.
- [List authorized workspaces](https://docs.breakcold.com/api-reference/workspaces/list-authorized-workspaces.md): List workspaces the authenticated public API actor can access in the current organization.
- [List CRM objects](https://docs.breakcold.com/api-reference/crm/list-crm-objects.md): List CRM object types in a workspace.
- [Create a CRM object](https://docs.breakcold.com/api-reference/crm/create-a-crm-object.md): Create a custom CRM object type with default fields and view.
- [Reorder CRM objects](https://docs.breakcold.com/api-reference/crm/reorder-crm-objects.md): Replace the display order for CRM object types.
- [Get a CRM object](https://docs.breakcold.com/api-reference/crm/get-a-crm-object.md): Fetch one CRM object type.
- [Delete a CRM object](https://docs.breakcold.com/api-reference/crm/delete-a-crm-object.md): Permanently delete a custom CRM object type together with its custom field definitions, field options, and saved views.
- [Update a CRM object](https://docs.breakcold.com/api-reference/crm/update-a-crm-object.md): Update custom CRM object metadata and active state.
- [List CRM fields](https://docs.breakcold.com/api-reference/crm/list-crm-fields.md): List field definitions for one CRM object type.
- [Create a CRM field](https://docs.breakcold.com/api-reference/crm/create-a-crm-field.md): Create a field definition for a CRM object type.
- [Reorder CRM fields](https://docs.breakcold.com/api-reference/crm/reorder-crm-fields.md): Replace the field order for one CRM object type.
- [Get a CRM field](https://docs.breakcold.com/api-reference/crm/get-a-crm-field.md): Fetch one CRM field definition.
- [Delete a CRM field](https://docs.breakcold.com/api-reference/crm/delete-a-crm-field.md): Permanently delete a custom CRM field definition, its field options and stored values or relations, and remove it from saved view configurations.
- [Update a CRM field](https://docs.breakcold.com/api-reference/crm/update-a-crm-field.md): Update a CRM field definition.
- [List CRM field options](https://docs.breakcold.com/api-reference/crm/list-crm-field-options.md): List options for a select or multiselect CRM field.
- [Create a CRM field option](https://docs.breakcold.com/api-reference/crm/create-a-crm-field-option.md): Create an option for a select or multiselect CRM field.
- [Reorder CRM field options](https://docs.breakcold.com/api-reference/crm/reorder-crm-field-options.md): Replace the option order for a select or multiselect CRM field.
- [Delete a CRM field option](https://docs.breakcold.com/api-reference/crm/delete-a-crm-field-option.md): Delete an option from a select or multiselect CRM field.
- [Update a CRM field option](https://docs.breakcold.com/api-reference/crm/update-a-crm-field-option.md): Update an option for a select or multiselect CRM field.
- [List CRM record views](https://docs.breakcold.com/api-reference/crm/list-crm-record-views.md): List saved record views for one CRM object type.
- [Create a CRM record view](https://docs.breakcold.com/api-reference/crm/create-a-crm-record-view.md): Create a saved record view for one CRM object type.
- [Reorder CRM record views](https://docs.breakcold.com/api-reference/crm/reorder-crm-record-views.md): Replace the saved view order for one CRM object type.
- [Get a CRM record view](https://docs.breakcold.com/api-reference/crm/get-a-crm-record-view.md): Fetch one saved record view.
- [Delete a CRM record view](https://docs.breakcold.com/api-reference/crm/delete-a-crm-record-view.md): Delete a saved record view.
- [Update a CRM record view](https://docs.breakcold.com/api-reference/crm/update-a-crm-record-view.md): Update record view metadata and replace the full saved config.
- [List inbox views](https://docs.breakcold.com/api-reference/inbox/list-inbox-views.md): List inbox views visible to the effective actor user.
- [Create an inbox view](https://docs.breakcold.com/api-reference/inbox/create-an-inbox-view.md): Create an inbox saved view for the effective actor user.
- [Get inbox view sidebar](https://docs.breakcold.com/api-reference/inbox/get-inbox-view-sidebar.md): Fetch inbox view sidebar layout for the effective actor user.
- [Reorder inbox view sidebar](https://docs.breakcold.com/api-reference/inbox/reorder-inbox-view-sidebar.md): Replace inbox view sidebar order for the effective actor user.
- [Get an inbox view](https://docs.breakcold.com/api-reference/inbox/get-an-inbox-view.md): Fetch one inbox saved view visible to the effective actor user.
- [Delete an inbox view](https://docs.breakcold.com/api-reference/inbox/delete-an-inbox-view.md): Delete a custom inbox view visible to the effective actor user.
- [Update an inbox view](https://docs.breakcold.com/api-reference/inbox/update-an-inbox-view.md): Update inbox view metadata and replace the full saved config.
- [List workspace conversations](https://docs.breakcold.com/api-reference/inbox/list-workspace-conversations.md): List or search inbox conversations in a workspace. Optionally apply a saved inbox view and filter by record-link state.
- [Compose and send a new inbox message](https://docs.breakcold.com/api-reference/inbox/compose-and-send-a-new-inbox-message.md): Send a new email, LinkedIn, Telegram, or WhatsApp message immediately and create or upsert the resulting inbox conversation.
- [List send accounts](https://docs.breakcold.com/api-reference/inbox/list-send-accounts.md): List inbox accounts the authenticated public API actor can send from in a workspace, optionally filtered by channel.
- [Create an inbox attachment upload URL](https://docs.breakcold.com/api-reference/inbox/create-an-inbox-attachment-upload-url.md): Create a Convex file-storage upload URL for inbox send attachments. Upload to this URL, then pass the returned storageId in a send request.
- [List record conversations](https://docs.breakcold.com/api-reference/inbox/list-record-conversations.md): List inbox conversations linked to a record.
- [List conversation messages](https://docs.breakcold.com/api-reference/inbox/list-conversation-messages.md): List messages for a conversation.
- [Send a message in an existing conversation](https://docs.breakcold.com/api-reference/inbox/send-a-message-in-an-existing-conversation.md): Send an immediate social message, email reply, or email forward using the existing inbox send behavior. Email forwards return the newly created forwarded conversation.
- [Get a conversation draft](https://docs.breakcold.com/api-reference/inbox/get-a-conversation-draft.md): Get the authenticated effective user's private draft for an inbox conversation, or null when no draft exists.
- [Clear a conversation draft](https://docs.breakcold.com/api-reference/inbox/clear-a-conversation-draft.md): Clear only the authenticated effective user's private draft for an inbox conversation.
- [Set a conversation draft](https://docs.breakcold.com/api-reference/inbox/set-a-conversation-draft.md): Create or update the authenticated effective user's private draft. Blank content clears the draft. HTML is accepted for email conversations only.
- [Get a message](https://docs.breakcold.com/api-reference/inbox/get-a-message.md): Fetch one inbox message.
- [List records](https://docs.breakcold.com/api-reference/records/list-records.md): List or search records in one workspace and object type.
- [Create a record](https://docs.breakcold.com/api-reference/records/create-a-record.md): 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 r…
- [Get a record](https://docs.breakcold.com/api-reference/records/get-a-record.md): Fetch a CRM record with field values.
- [Update a record](https://docs.breakcold.com/api-reference/records/update-a-record.md): 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 webhoo…
- [Archive a record](https://docs.breakcold.com/api-reference/records/archive-a-record.md): Archive a CRM record without permanently deleting it.
- [Restore a record](https://docs.breakcold.com/api-reference/records/restore-a-record.md): Restore an archived CRM record.
- [Create a custom activity](https://docs.breakcold.com/api-reference/records/create-a-custom-activity.md): 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.
- [List record tasks](https://docs.breakcold.com/api-reference/tasks/list-record-tasks.md): List tasks linked to a record.
- [Create a record task](https://docs.breakcold.com/api-reference/tasks/create-a-record-task.md): Create a task linked to a record.
- [Delete a task](https://docs.breakcold.com/api-reference/tasks/delete-a-task.md): Soft-delete a task. Deleted tasks are excluded from task lists and cannot be restored through the public API.
- [Update a task](https://docs.breakcold.com/api-reference/tasks/update-a-task.md): Update task details.
- [Complete a task](https://docs.breakcold.com/api-reference/tasks/complete-a-task.md): Mark a task as done.
- [List record notes](https://docs.breakcold.com/api-reference/notes/list-record-notes.md): List notes linked to a record.
- [Create a record note](https://docs.breakcold.com/api-reference/notes/create-a-record-note.md): 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.
- [Get a note](https://docs.breakcold.com/api-reference/notes/get-a-note.md): Fetch a note by ID.
- [Update a note](https://docs.breakcold.com/api-reference/notes/update-a-note.md): Update note content. If the workspace has a matching active webhook, the note-updated event is delivered to its external URL.
- [List meetings](https://docs.breakcold.com/api-reference/meetings/list-meetings.md): List workspace meetings with recording and transcript metadata.
- [Get a meeting](https://docs.breakcold.com/api-reference/meetings/get-a-meeting.md): Fetch one meeting with recording and transcript metadata.
- [List meeting transcript segments](https://docs.breakcold.com/api-reference/meetings/list-meeting-transcript-segments.md): List full meeting transcript text in ordered paginated segments.
- [Create an integration hook](https://docs.breakcold.com/api-reference/webhooks/create-an-integration-hook.md): Create and activate a Zapier or Make webhook subscription that delivers matching future Breakcold events to the supplied external HTTPS URL.
- [Delete an integration hook](https://docs.breakcold.com/api-reference/webhooks/delete-an-integration-hook.md): Permanently delete a Zapier or Make instant-trigger webhook subscription and its stored delivery logs. The operation is idempotent.
- [List integration samples](https://docs.breakcold.com/api-reference/webhooks/list-integration-samples.md): Return generated sample payloads for automation-platform trigger setup.
- [MCP](https://docs.breakcold.com/api/mcp.md): Use Breakcold as an MCP server.
- [Authentication](https://docs.breakcold.com/api/mcp-authentication.md): Authenticate MCP clients with OAuth sign-in or a scoped bearer token.
- [Applications](https://docs.breakcold.com/api/mcp-applications.md): Choose the application you want to connect to Breakcold MCP.
- [Claude](https://docs.breakcold.com/api/mcp-applications/claude.md): Connect Claude to Breakcold MCP.
- [ChatGPT](https://docs.breakcold.com/api/mcp-applications/chatgpt.md): Connect ChatGPT to Breakcold MCP.
- [Codex](https://docs.breakcold.com/api/mcp-applications/codex.md): Connect Codex to Breakcold MCP.
- [TypingMind](https://docs.breakcold.com/api/mcp-applications/typingmind.md): Connect TypingMind to Breakcold MCP.
- [LM Studio](https://docs.breakcold.com/api/mcp-applications/lm-studio.md): Connect LM Studio to Breakcold MCP.
- [OpenClaw](https://docs.breakcold.com/api/mcp-applications/openclaw.md): Connect OpenClaw to Breakcold MCP.
- [Hermes](https://docs.breakcold.com/api/mcp-applications/hermes.md): Connect Hermes to Breakcold MCP.
- [LibreChat](https://docs.breakcold.com/api/mcp-applications/librechat.md): Connect LibreChat to Breakcold MCP.
- [Microsoft 365 Copilot](https://docs.breakcold.com/api/mcp-applications/microsoft-365-copilot.md): Connect Microsoft 365 Copilot to Breakcold MCP.
- [Tools](https://docs.breakcold.com/api/mcp-tools.md): Available Breakcold MCP tools.
- [Rate limits](https://docs.breakcold.com/api/mcp-rate-limits.md): Understand MCP rate limits and how AI tools should handle them.

## OpenAPI Specs

- [openapi](https://docs.breakcold.com/api/openapi.json)