List inbox cards (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

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

GET /admin/collection-ops/inbox

Access token

Lists inbox items for one status (open by default; cleared looks back clearedSinceHours, default 24), optionally priority-only, grouped into one card per extraction code, priority organizations first, then most recent. Returns the page of cards, the total and the number of codes per status. Super admin only; 404 while the collection-ops console is turned off.

Query parameters

skip number

Maximum value is 10000. Default value is 0.
limit number

Maximum value is 100. Default value is 25.
status string

Values are open, snoozed, or cleared. Default value is open.
priority boolean
clearedSinceHours number

Maximum value is 720. Default value is 24.

Responses

200 application/json
Hide response attributes Show response attributes object
- data object Required
  
  Hide data attributes Show data attributes object
  
  rows array[object]
  
  Hide rows attributes Show rows attributes object
  
  extractionCodeId string
  
  code string | null
  
  custodianName string | null
  
  orgId string | null
  
  caseId string | null
  
  orgPriority boolean
  
  stage string | null
  
  Values are created, email_sent, portal_login, download_clicked, code_login, extracting, extracted, uploaded, or completed.
  
  status string | null
  
  Values are active, stalled, error, or completed.
  
  lastTriggeredAt string(date-time)
  
  recovered boolean
  
  Every item on the card has a later success
  
  items array[object]
  
  Hide items attributes Show items attributes object
  
  id string
  
  reason string
  
  Values are backup_failed, upload_failed, processing_failed, export_failed, invite_failed, extraction_too_long, upload_too_long, slow_transfer, went_silent, device_not_detected, or stalled.
  
  errorCode string | null
  
  summary string
  
  status string
  
  Values are open, snoozed, or cleared.
  
  triggerCount number
  
  lastTriggeredAt string(date-time)
  
  recoveredAt string(date-time) | null
  
  snoozedUntil string(date-time) | null
  
  clearedAt string(date-time) | null
  
  clearedBy string | null
  
  User id
  
  total number
  
  counts object
  
  Number of extraction codes per status
  
  Hide counts attributes Show counts attributes object
  
  open number
  
  snoozed number
  
  cleared number
- statusCode number Required
- timestamp string(date-time) Required

GET /admin/collection-ops/inbox

curl \
 --request GET 'http://api.example.com/admin/collection-ops/inbox' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "data": {
    "rows": [
      {
        "extractionCodeId": "65a1b2c3d4e5f6a7b8c9d0e1",
        "code": "string",
        "custodianName": "string",
        "orgId": "string",
        "caseId": "string",
        "orgPriority": true,
        "stage": "created",
        "status": "active",
        "lastTriggeredAt": "2026-05-04T09:42:00Z",
        "recovered": true,
        "items": [
          {
            "id": "65a1b2c3d4e5f6a7b8c9d0e1",
            "reason": "backup_failed",
            "errorCode": "DEVICE_UNPLUGGED",
            "summary": "Backup failed: device unplugged",
            "status": "open",
            "triggerCount": 2,
            "lastTriggeredAt": "2026-05-04T09:42:00Z",
            "recoveredAt": "2026-05-04T09:42:00Z",
            "snoozedUntil": "2026-05-04T09:42:00Z",
            "clearedAt": "2026-05-04T09:42:00Z",
            "clearedBy": "string"
          }
        ]
      }
    ],
    "total": 12,
    "counts": {
      "open": 12,
      "snoozed": 2,
      "cleared": 5
    }
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}