Get one collection's detail (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/collections/{codeId}

Access token

Returns one extraction code's collection state: header (code, custodian, stage, status, requester and case), stage bar, per-source state, live backup/upload attempts, the last computer seen, up to 50 live inbox items and per-requested-source progress. Returns 404 when the code has no collection state. Super admin only; 404 while the collection-ops console is turned off.

Path parameters

codeId string Required

Id of the extraction code

Responses

200 application/json
Hide response attributes Show response attributes object
- data object Required
  
  Hide data attributes Show data attributes object
  
  header object
  
  Hide header attributes Show header attributes object
  
  extractionCodeId string
  
  code string
  
  custodianName string | null
  
  orgId string | null
  
  caseId string | null
  
  orgPriority boolean
  
  watched boolean
  
  stage string
  
  Values are created, email_sent, portal_login, download_clicked, code_login, extracting, extracted, uploaded, or completed.
  
  status string
  
  Values are active, stalled, error, or completed.
  
  lifecycleMs number | null
  
  From creation to completion, or to now while open
  
  completedAt string(date-time) | null
  
  failedAttempts number
  
  requestedBy object | null
  
  Hide requestedBy attributes Show requestedBy attributes object | null
  
  userId string
  
  name string | null
  
  email string | null
  
  caseName string | null
  
  stageBar array[object]
  
  Hide stageBar attributes Show stageBar attributes object
  
  stage string
  
  tracked boolean
  
  reached boolean
  
  at string(date-time) | null
  
  sources array[object]
  
  Hide sources attributes Show sources attributes object
  
  key string
  
  dataSource string | null
  
  stage string
  
  Values are created, email_sent, portal_login, download_clicked, code_login, extracting, extracted, uploaded, or completed.
  
  stageOrder number
  
  status string
  
  Values are active, error, or completed.
  
  lastAt string(date-time)
  
  lastErrorCode string | null
  
  live array[object]
  
  Hide live attributes Show live attributes object
  
  attemptId string
  
  activity string
  
  Values are backup or upload.
  
  dataSource string | null
  
  deviceId string | null
  
  systemId string | null
  
  percent number | null
  
  bytesDone number | null
  
  bytesTotal number | null
  
  rateBps number | null
  
  etaSec number | null
  
  phase string | null
  
  freeDiskBytes number | null
  
  slowSince string(date-time) | null
  
  startedAt string(date-time) | null
  
  lastHeartbeatAt string(date-time)
  
  computer object | null
  
  Hide computer attributes Show computer attributes object | null
  
  systemId string | null
  
  appVersion string | null
  
  os string | null
  
  model string | null
  
  totalMemBytes number | null
  
  freeDiskBytes number | null
  
  at string(date-time) | null
  
  openItems array[object]
  
  Live inbox items, newest first, at most 50
  
  Hide openItems attributes Show openItems 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
  
  requestedSources array[object]
  
  Hide requestedSources attributes Show requestedSources attributes object
  
  dataSource string
  
  sourceType string
  
  status string
  
  Values are pending, in_progress, failed, or completed.
  
  rows number
  
  completedRows number
  
  sourcesProgress object
  
  Hide sourcesProgress attributes Show sourcesProgress attributes object
  
  requested number
  
  completed number
- statusCode number Required
- timestamp string(date-time) Required

GET /admin/collection-ops/collections/{codeId}

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

Response examples (200)

{
  "data": {
    "header": {
      "extractionCodeId": "65a1b2c3d4e5f6a7b8c9d0e1",
      "code": "K7Q2ZP",
      "custodianName": "Jane Doe",
      "orgId": "string",
      "caseId": "string",
      "orgPriority": true,
      "watched": true,
      "stage": "created",
      "status": "active",
      "lifecycleMs": 42.0,
      "completedAt": "2026-05-04T09:42:00Z",
      "failedAttempts": 42.0,
      "requestedBy": {
        "userId": "string",
        "name": "string",
        "email": "paralegal@example.com"
      },
      "caseName": "Smith v. Jones"
    },
    "stageBar": [
      {
        "stage": "string",
        "tracked": true,
        "reached": true,
        "at": "2026-05-04T09:42:00Z"
      }
    ],
    "sources": [
      {
        "key": "ios:00008110-001A2B3C4D5E6F70",
        "dataSource": "ios",
        "stage": "created",
        "stageOrder": 42.0,
        "status": "active",
        "lastAt": "2026-05-04T09:42:00Z",
        "lastErrorCode": "string"
      }
    ],
    "live": [
      {
        "attemptId": "string",
        "activity": "backup",
        "dataSource": "string",
        "deviceId": "string",
        "systemId": "string",
        "percent": 42.0,
        "bytesDone": 42.0,
        "bytesTotal": 42.0,
        "rateBps": 42.0,
        "etaSec": 42.0,
        "phase": "string",
        "freeDiskBytes": 42.0,
        "slowSince": "2026-05-04T09:42:00Z",
        "startedAt": "2026-05-04T09:42:00Z",
        "lastHeartbeatAt": "2026-05-04T09:42:00Z"
      }
    ],
    "computer": {
      "systemId": "string",
      "appVersion": "3.14.0",
      "os": "string",
      "model": "string",
      "totalMemBytes": 42.0,
      "freeDiskBytes": 42.0,
      "at": "2026-05-04T09:42:00Z"
    },
    "openItems": [
      {
        "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"
      }
    ],
    "requestedSources": [
      {
        "dataSource": "gmail",
        "sourceType": "string",
        "status": "pending",
        "rows": 42.0,
        "completedRows": 42.0
      }
    ],
    "sourcesProgress": {
      "requested": 3,
      "completed": 1
    }
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}