List workload reports

Read measured workload against the agreed limits. At a limit, work already within scope can continue; the next operation that would exceed any dimension is rejected or blocked before excess records are processed. Counts across monitors are deduplicated by subject, source record ID and source version during the month. No automatic repricing, mixed-tier limits or extra usage charge occurs. AMLOK must approve an amended rate card before blocked work resumes. Whole-underwriting counts include the complete evidence history; Signal counts only new processed record versions in the UTC calendar month. Counters and limit checks are atomic across concurrent work. as_of and the cursor freeze a read snapshot; a new first-page read gets current progress.

GET /v1/workloads

cURL

cURL

curl --request GET --fail-with-body --max-time 30 \
  "${AMLOK_API_BASE_URL}/v1/workloads?subject_id=biz_example&limit=100" \
  --header "Authorization: Bearer ${AMLOK_API_KEY}" \
  --header "Accept: application/json"

200

synthetic

{
  "data": [
    {
      "id": "workload_example",
      "object": "workload",
      "workspace_id": "wsp_example",
      "subject_id": "biz_example",
      "product": "insights",
      "workflow_run_id": "wfr_example",
      "monitoring_period_id": null,
      "rate_card_id": "billing_rate_card_example",
      "tier": "standard",
      "as_of": "2026-10-23T14:00:00Z",
      "period_start": "2025-10-01T00:00:00Z",
      "period_end": "2026-10-01T00:00:00Z",
      "record_counting_basis": "per_underwriting",
      "bank_accounts": {
        "used": 2,
        "limit": 2,
        "remaining": 0
      },
      "business_integrations": {
        "used": 5,
        "limit": 5,
        "remaining": 0
      },
      "records": {
        "used": 2,
        "limit": 75000,
        "remaining": 74998
      },
      "status": "at_limit",
      "blocking_dimensions": [],
      "analysis_scope": "Routine reconciliation and standard analysis",
      "input_manifest_id": "manifest_example"
    },
    {
      "id": "workload_signal_example",
      "object": "workload",
      "workspace_id": "wsp_example",
      "subject_id": "biz_example",
      "product": "signal",
      "workflow_run_id": null,
      "monitoring_period_id": "monitoring_period_example",
      "rate_card_id": "billing_rate_card_example",
      "tier": "standard",
      "as_of": "2026-10-23T14:00:00Z",
      "period_start": "2026-10-01T00:00:00Z",
      "period_end": "2026-11-01T00:00:00Z",
      "record_counting_basis": "new_records_per_month",
      "bank_accounts": {
        "used": 2,
        "limit": 2,
        "remaining": 0
      },
      "business_integrations": {
        "used": 5,
        "limit": 5,
        "remaining": 0
      },
      "records": {
        "used": 50,
        "limit": 75000,
        "remaining": 74950
      },
      "status": "at_limit",
      "blocking_dimensions": [],
      "analysis_scope": "Routine reconciliation and standard analysis",
      "input_manifest_id": null
    }
  ],
  "page": {
    "next_cursor": null,
    "has_more": false,
    "limit": 100
  },
  "meta": {
    "request_id": "req_example",
    "schema_version": "1.4.2",
    "generated_at": "2026-10-23T14:00:00Z",
    "data_status": "complete"
  }
}

Required scope: billing:read

Read measured workload against the agreed limits. At a limit, work already within scope can continue; the next operation that would exceed any dimension is rejected or blocked before excess records are processed. Counts across monitors are deduplicated by subject, source record ID and source version during the month. No automatic repricing, mixed-tier limits or extra usage charge occurs. AMLOK must approve an amended rate card before blocked work resumes. Whole-underwriting counts include the complete evidence history; Signal counts only new processed record versions in the UTC calendar month. Counters and limit checks are atomic across concurrent work. as_of and the cursor freeze a read snapshot; a new first-page read gets current progress.

Product scope · Processing lifecycle · Errors

Authorizations

Authorization · string · header · required

Server-to-server API key bound to exactly one workspace, institution tenant and environment. No caller-supplied workspace override is accepted. Do not use in public browser code.

Query Parameters

subject_id · string

Authorized borrower/business.

product · enum<string>

Product filter.

Available options: insights, signal

limit · integer

Default 100; maximum 200.

Required range: 1 <= x <= 200

cursor · string

Opaque continuation bound to the original filters and snapshot.

Response

200

application/json

Authorized response.

data · object[] · required

Show child attributes

page · object · required

Show child attributes

meta · object · required

Show child attributes