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

# List record events

> List a record's activity timeline, newest first: field changes (with old and new values), enrichment, notes, tasks and other activity logged on the record itself. Filter by category or action. Field changes are returned in `changes`; values are display strings. Conversation events need the inbox:read scope and follow the caller's inbox access.

<table width="100%">
  <thead>
    <tr>
      <th>Token cost</th>
      <th>Rate limit</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>0.2 tokens</td>
      <td>120 requests/min per route/org</td>
    </tr>
  </tbody>
</table>



## OpenAPI

````yaml /api/openapi.json get /records/{recordId}/events
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)
security: []
tags:
  - name: Workspaces
  - name: CRM
  - name: Records
  - name: Tasks
  - name: Notes
  - name: Inbox
  - name: Meetings
  - name: Webhooks
paths:
  /records/{recordId}/events:
    get:
      tags:
        - Records
      summary: List record events
      description: >-
        List a record's activity timeline, newest first: field changes (with old
        and new values), enrichment, notes, tasks and other activity logged on
        the record itself. Filter by category or action. Field changes are
        returned in `changes`; values are display strings. Conversation events
        need the inbox:read scope and follow the caller's inbox access.


        <table width="100%">
          <thead>
            <tr>
              <th>Token cost</th>
              <th>Rate limit</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <td>0.2 tokens</td>
              <td>120 requests/min per route/org</td>
            </tr>
          </tbody>
        </table>
      operationId: listRecordEvents
      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: category
          in: query
          required: false
          description: >-
            Event category. crm holds field changes, record creation, archiving
            and relation changes.
          schema:
            type: string
            enum:
              - crm
              - communication
              - task
              - note
              - file
              - enrichment
              - system
              - activity
        - name: action
          in: query
          required: false
          description: >-
            Exact event action, e.g. field_updated, record_created,
            enrichment_completed, member_changed, relation_added, note_added.
          schema:
            type: string
            maxLength: 100
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 6
                        recordId:
                          type: string
                          minLength: 6
                        category:
                          type: string
                          enum:
                            - crm
                            - communication
                            - task
                            - note
                            - file
                            - enrichment
                            - system
                            - activity
                          description: >-
                            Event category. crm holds field changes, record
                            creation, archiving and relation changes.
                        action:
                          type: string
                        actor:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - user
                                - system
                                - ai
                                - external
                            userId:
                              type: string
                              minLength: 6
                            name:
                              type: string
                          required:
                            - type
                            - name
                        source:
                          type: string
                          description: >-
                            Where the event came from: ui, api, import,
                            automation, webhook, enrichment, inbox,
                            auto_meeting, contact_sync or extension.
                        occurredAt:
                          type: number
                          description: Unix timestamp in ms.
                        changes:
                          type: array
                          items:
                            type: object
                            properties:
                              fieldId:
                                type:
                                  - string
                                  - 'null'
                              fieldName:
                                type: string
                              fieldType:
                                type:
                                  - string
                                  - 'null'
                              oldValue:
                                type:
                                  - string
                                  - 'null'
                                description: >-
                                  Previous value as displayed in Breakcold; null
                                  when empty or not logged (enrichment, member
                                  changes).
                              newValue:
                                type:
                                  - string
                                  - 'null'
                                description: >-
                                  New value as displayed in Breakcold; null when
                                  cleared.
                            required:
                              - fieldId
                              - fieldName
                              - fieldType
                              - oldValue
                              - newValue
                      required:
                        - id
                        - recordId
                        - category
                        - action
                        - actor
                        - source
                        - occurredAt
                        - changes
                  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'
      security:
        - ApiKeyBearer:
            - records:read
        - BreakcoldOAuth:
            - records:read
components:
  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'
  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
  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
            inbox:attachments:read: Access inbox:attachments:read
            meetings:read: Access meetings:read
            webhooks:write: Access webhooks:write

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.