integrations

List a case's event log (internal)

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://docs.usehearsay.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}
Close
GET /admin/case/{caseId}/events
Access token

Lists every event recorded on the case, newest first, in every category, with actors' names and emails shown in full, filtered by type and category and paged with page and perPage. Super admin only.

Path parameters

  • caseId string Required

    Id of the case

Query parameters

  • page number

    Default value is 1.

  • perPage number

    Maximum value is 100. Default value is 10.

  • skip number

    If skip/limit not provided, page/perPage will take precedence

  • limit number

    If skip/limit not provided, page/perPage will take precedence

  • sortOrder string

    Values are asc or desc. Default value is asc.

  • type string

    Values are financial_connection_removed, oc_invited, oc_accepted, oc_member_added, oc_member_removed, oc_ec_created, oc_suggestion_created, oc_suggestion_updated, oc_suggestion_message, oc_suggestion_rejected, oc_ec_approved, oc_data_approved, oc_data_revoked, oc_code_released, oc_code_unreleased, member_invited, member_accepted, case_created, case_status_changed, extraction_code_created, extraction_code_updated, extraction_code_locked, custodian_updated, device_attached, data_uploaded, export_started, export_finished, export_errored, or export_cancelled.

  • category string

    Values are general, case_data, or oc.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • data object Required
      Hide data attributes Show data attributes object
      • total number Required
      • page number
      • perPage number
      • skip number
      • limit number
      • totalPages number Required
      • nextPage number | null Required
      • previousPage number | null Required
      • data array[object]
        Hide data attributes Show data attributes object
        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • type string Required

          Values are financial_connection_removed, oc_invited, oc_accepted, oc_member_added, oc_member_removed, oc_ec_created, oc_suggestion_created, oc_suggestion_updated, oc_suggestion_message, oc_suggestion_rejected, oc_ec_approved, oc_data_approved, oc_data_revoked, oc_code_released, oc_code_unreleased, member_invited, member_accepted, case_created, case_status_changed, extraction_code_created, extraction_code_updated, extraction_code_locked, custodian_updated, device_attached, data_uploaded, export_started, export_finished, export_errored, or export_cancelled.

        • category string Required

          Values are general, case_data, or oc.

        • description string Required
        • createdBy object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide createdBy attributes Show createdBy attributes object
          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • email string Required
        • metadata object Required
    • statusCode number Required
    • timestamp string(date-time) Required
GET /admin/case/{caseId}/events 
curl \
 --request GET 'http://api.example.com/admin/case/{caseId}/events' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": {
    "total": 42,
    "page": 1,
    "perPage": 20,
    "skip": 0,
    "limit": 20,
    "totalPages": 3,
    "nextPage": 2,
    "previousPage": 42.0,
    "data": [
      {
        "createdAt": "2026-01-15T14:30:00.000Z",
        "updatedAt": "2026-01-15T14:30:00.000Z",
        "id": "507f1f77bcf86cd799439011",
        "type": "financial_connection_removed",
        "category": "general",
        "description": "Export finished",
        "createdBy": {
          "createdAt": "2026-01-15T14:30:00.000Z",
          "updatedAt": "2026-01-15T14:30:00.000Z",
          "id": "507f1f77bcf86cd799439011",
          "name": "Jane Doe",
          "email": "jane.doe@example.com"
        },
        "metadata": {}
      }
    ]
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}