Get history backfill job status

GET 
/v1/imap/:mailerID/history/:jobId

Returns tenant-scoped status and clamped progress for a history backfill job (percent, processed/target, startedAt/endedAt). A job owned by another tenant or an unknown job returns 404. History backfill is currently supported only for Google (Gmail) OAuth IMAP mailboxes.

Request

Path Parameters

mailerID stringrequired

Mailer ID

jobId stringrequired

History backfill job ID

Responses

200

History backfill status

application/json

Schema

Schema

endedAt string
jobId string
percent number
processed integer
startedAt string
status string
success boolean
target integer

Example (from schema)

{
  "endedAt": "string",
  "jobId": "string",
  "percent": 25,
  "processed": 250,
  "startedAt": "string",
  "status": "processing",
  "success": true,
  "target": 1000
}

400

Bad Request

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

404

Job not found

application/json

Schema

Schema

error string
success boolean

Example (from schema)

{
  "error": "string",
  "success": false
}

Loading...