v1

latestOpenAPI 3.0.02026-08-062903562.2 MB

MagicLink

Return the rollup status for a magic-link batch (internal).

Return the rollup status for a batch.

Unscoped findOrFail is intentional: privateEndpoint + app-token-only gate the route and the id is the batch's own surrogate key (not a tenant resource), so there is no cross-org IDOR surface.

get/scoped-magic-link/batch/{batch}

Path parameters

batchinteger required

Response

Batch status rollup.

idinteger

organization_idstring

action_scopestring

statusstring

total_countinteger

completed_countinteger

failed_countinteger

progress_percentageinteger

is_completeboolean

is_processingboolean

started_atstring date-time nullable

completed_atstring date-time nullable

error_messagestring nullable

Example response

{
  "id": 4471,
  "organization_id": "29720",
  "action_scope": "recurring_plan_edit",
  "status": "completed",
  "total_count": 100,
  "completed_count": 98,
  "failed_count": 2,
  "progress_percentage": 100,
  "is_complete": true
}