Get data-collection status (v2)

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 /case/{caseId}/data-status-v2

Data-collection status grouped by data source, with item counts and the extraction code each source came from. For the full tree view, use data-status-tree-v3.

Headers

  • organization string Required

    id of the selected (active) organization

Path parameters

  • caseId string Required

    Id of the case

Query parameters

  • extractionCode string
  • searchText string
  • tags array[string]

    Tag ids (comma-separated). Filters device conversations, emails, files, and financial sources. Excludes discord/reddit.

  • searchMatchType string

    Match type for message text search. FUZZY allows typo tolerance, EXACT requires exact token match.

    Values are FUZZY or EXACT. Default value is FUZZY.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • data object Required
      Hide data attribute Show data attribute object
      • data array[object] Required
        Hide data attributes Show data attributes object
        • code string Required
        • createdDate string(date-time) Required
        • dueDate string(date-time)
        • dateRangeStart string(date-time)
        • dateRangeEnd string(date-time)
        • collectionMethod string Required
        • notes string | null
        • custodian object
          Hide custodian attributes Show custodian attributes object
          • name string Required
          • email string Required
        • dataSources array[object] Required
          Hide dataSources attributes Show dataSources attributes object
          • id string Required
          • type string Required

            Name of the master data source

          • category string | null Required
          • name string Required
          • status string Required
          • itemsCount number
          • pendingOcApprovalCount number

            Set only for an Originating-org Lawyer on an OC-enabled case: count of items uploaded but not yet OC-approved for this source. Omitted for OC callers and for OL callers on non-OC cases.

          • ocSharedStatus string

            Opposing-council only: how this source has been shared with the OL. shared/pending summarize a partially-approved source by whether anything is still outstanding — see pendingOcApprovalCount for the exact split. Omitted for OL/OG callers.

            Values are shared, pending, or not_gated.

          • sizeBytes number
          • dateCompleted string(date-time)
          • sourceId string
    • statusCode number Required
    • timestamp string(date-time) Required
GET /case/{caseId}/data-status-v2
curl \
 --request GET 'http://api.example.com/case/{caseId}/data-status-v2' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "organization: string"
Response examples (200)
{
  "data": {
    "data": [
      {
        "code": "K7Q2-9XPL",
        "createdDate": "2026-01-10T09:00:00.000Z",
        "dueDate": "2026-02-01T00:00:00.000Z",
        "dateRangeStart": "2025-01-01T00:00:00.000Z",
        "dateRangeEnd": "2025-12-31T23:59:59.000Z",
        "collectionMethod": "allow_client",
        "notes": "string",
        "custodian": {
          "name": "Jane Doe",
          "email": "jane.doe@example.com"
        },
        "dataSources": [
          {
            "id": "507f1f77bcf86cd799439011",
            "type": "iMessage",
            "category": "string",
            "name": "iPhone 15",
            "status": "completed",
            "itemsCount": 1250,
            "pendingOcApprovalCount": 0,
            "ocSharedStatus": "shared",
            "sizeBytes": 52428800,
            "dateCompleted": "2026-01-15T14:30:00.000Z",
            "sourceId": "507f1f77bcf86cd799439012"
          }
        ]
      }
    ]
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}