integrations

List the collection queue (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/collection-ops/queue
Access token

Lists collections, one row per extraction code, for a filter (all, priority, watched, errors, stalled), optionally narrowed by progress, organization or a code-prefix / custodian-name search. Returns the page, the total for the chosen filter and the count for every filter. 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.

  • filter string

    Values are all, priority, watched, errors, or stalled. Default value is all.

  • progress string

    Values are not_started, in_progress, or not_completed.

  • orgId string
  • q string

    Maximum length is 100.

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
        • 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.

        • stageIndex number
        • status string

          Values are active, stalled, error, or completed.

        • lastEvent object | null
          Hide lastEvent attributes Show lastEvent attributes object | null
          • type string
          • message string
          • severity string
          • at string(date-time)
        • lastActivityAt string(date-time) | null
        • openInboxItems number
        • livePercent number | null
      • total number

        Rows matching the chosen filter

      • counts object

        Rows matching each filter

        Hide counts attributes Show counts attributes object
        • all number
        • priority number
        • watched number
        • errors number
        • stalled number
    • statusCode number Required
    • timestamp string(date-time) Required
GET /admin/collection-ops/queue 
curl \
 --request GET 'http://api.example.com/admin/collection-ops/queue' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": {
    "rows": [
      {
        "extractionCodeId": "65a1b2c3d4e5f6a7b8c9d0e1",
        "code": "string",
        "custodianName": "string",
        "orgId": "string",
        "caseId": "string",
        "orgPriority": true,
        "watched": true,
        "stage": "created",
        "stageIndex": 42.0,
        "status": "active",
        "lastEvent": {
          "type": "string",
          "message": "string",
          "severity": "string",
          "at": "2026-05-04T09:42:00Z"
        },
        "lastActivityAt": "2026-05-04T09:42:00Z",
        "openInboxItems": 42.0,
        "livePercent": 42.0
      }
    ],
    "total": 87,
    "counts": {
      "all": 87,
      "priority": 6,
      "watched": 3,
      "errors": 9,
      "stalled": 4
    }
  },
  "statusCode": 200,
  "timestamp": "2026-01-15T10:15:00.000Z"
}