Get the collection status tree

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

{
  "integrations MCP server": {
    "url": "https://docs.usehearsay.com/mcp"
  }
}

GET /extraction/case/data-status-tree

Access token

Returns the data-collection status of the extraction code's case as a tree, limited to data collected with the caller's extraction code.

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
  
  id string Required
  
  kind string Required
  
  sourceId string
  
  sourceName string | null
  
  plaidItemId string | null
  
  institutionName string | null
  
  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 node. Omitted for OC callers and for OL callers on non-OC cases.
  
  backupStatus string | null
  
  Values are processing, completed, failed, or na.
  
  children array[object]
- statusCode number Required
- timestamp string(date-time) Required

GET /extraction/case/data-status-tree

curl \
 --request GET 'http://api.example.com/extraction/case/data-status-tree' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": {
    "data": [
      {
        "id": "507f1f77bcf86cd799439011",
        "kind": "financial",
        "sourceId": "65a1b2c3d4e5f6a7b8c9d0e2",
        "sourceName": "jane.doe@example.com",
        "plaidItemId": "65a1b2c3d4e5f6a7b8c9d0e2",
        "institutionName": "Example Bank",
        "itemsCount": 3,
        "pendingOcApprovalCount": 0,
        "backupStatus": "processing",
        "children": [
          {
            "name": "Messages",
            "count": 120,
            "subCount": 3
          }
        ]
      }
    ]
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}