minimusdocs
Help center

Background tasks

List background tasks

GET/jobs/

read Read: looks, changes nothing. Scopes

Every background task you may see (imports, mass edits, syncs, backups…), newest first, a page at a time. An account sees the tasks it started; panel operators allowed to manage a kind of task see everyone's.

Query parameters

  • kindstring

    Only these kinds, comma-separated: import, bulk_delete, bulk_edit, ingest, series_import, provider_import, watch_scan, backup, panel_import, editor.

  • orderingstring

    Sort by created_at, kind or state; - in front for descending. Default -created_at.

  • pageinteger

    A page number within the paginated result set.

  • page_sizeinteger

    Number of results to return per page.

  • searchstring

    Matches the task's name, file or message.

  • statestring

    Only these states, comma-separated: queued, running, waiting, stalled, completed, failed, cancelled; active = queued + running.

Response

200 OK

  • countintegerrequired

    How many there are in all, on every page.

  • nextstring (uri)can be null

    The next page, or null on the last one.

  • previousstring (uri)can be null

    The page before, or null on the first one.

  • resultsobject[]required
    • idstringrequired
    • kindstringrequired
      • import - Playlist import
      • bulk_delete - Mass delete
      • bulk_edit - Mass edit
      • ingest - VOD ingest
      • series_import - TV show import
      • provider_import - Film and show import
      • watch_scan - Watch folder scan
      • backup - Backup
      • panel_import - Move from another panel
      • editor - Playlist editor

      One of: "import" "bulk_delete" "bulk_edit" "ingest" "series_import" "provider_import" "watch_scan" "backup" "panel_import" "editor"

    • kind_labelstringrequired
    • titlestringrequired
    • subtitlestringrequired
    • statestringrequired

      Where the task is, in the same words for every kind.

      • queued - Queued
      • running - Running
      • waiting - Waiting for you
      • stalled - Stalled
      • completed - Completed
      • failed - Failed
      • cancelled - Cancelled
    • state_labelstringrequired
    • statusstringrequired

      The task's own status, in its kind's words.

    • status_labelstringrequired
    • progressobjectrequired
      • doneintegerrequiredcan be null
      • totalintegerrequiredcan be null
      • percentintegerrequiredcan be null
      • phasestringrequired
    • messagestringrequired
    • detailsobject[]required
      • labelstringrequired
      • valueanyrequired
    • errorsobject[]required

      What went wrong for single items, when the kind records it.

    • linkobjectrequiredcan be null
      • pathstringrequired

        The dashboard page that shows this task.

      • queryobjectrequired
      • labelstringrequired
    • actionsstring[]required

      What the signed-in account may do to it now.

      One of: "cancel" "resume" "retry" "undo"

    • created_by_usernamestringrequiredcan be null
    • created_atstring (date-time)required
    • started_atstring (date-time)requiredcan be null
    • finished_atstring (date-time)requiredcan be null
    • updated_atstring (date-time)required

Errors

  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means