Homepage

admin_background_jobs

Last edit: Oct 13, 2026

Returns background jobs of the instance that are scheduled (default), waiting
for a retry, dead or running, depending on filter.type. Without sort,
scheduled, retry and dead jobs are listed by timestamp. Only the first 50
pages of up to 100 jobs each can be retrieved.

admin_background_jobs(
  filter: BackgroundJobsFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [BackgroundJobsSortInput!]
): BackgroundJobCollection!

Arguments

filter (BackgroundJobsFilterInput)

Conditions the returned results must match. All conditions are combined with AND

page (Int)

Page number to return, starting at 1. Requesting a page beyond the last one
returns an empty results list. Maximum 50, higher values are treated as 50

per_page (Int)

Number of results per page, must be greater than 0. Maximum 100, higher values are treated as 100

sort (BackgroundJobsSortInput)

Sort order of the results. Fields are applied one after another, so the last one given determines the order

Type

BackgroundJobCollection

Paginated list of background jobs

Questions?

We are always happy to help with any questions you may have.

contact us