Request

Lists all publishing jobs for a specific tenant, including jobs that are in progress, completed, failed, and so on. This endpoint supports two types of pagination:

  • Offset pagination
  • Checkpoint pagination

When you use offset pagination, only the first 1000 records are returned.

Note
To retrieve a list of jobs, your token must include one of the following scopes xmcpub.jobs.a:r, xmcpub.jobs.t:r, or xmcpub.jobs.t:rl.

Security
Bearer
Query
pageNumberinteger, (int32), [ 1 .. 2147483647 ]

The page number of the results to return. The first page is 1. This parameter must be used only in offset pagination requests as it indicates that offset pagination should be used.

pageSizeinteger, (int32), [ 1 .. 100 ]

The number of results per page.

Default:50
sourceArray of strings

The source value to use when filtering jobs. Use a pipe to specify multiple values (for example, ?source=Pages|Sites). Wildcards are not supported.

system.createdBy.idArray of strings

The ID of the creator to use when filtering jobs. Use a pipe to specify multiple values (for example, ?system.createdBy.id=Qbu3QmWtnQoU0my5jX9MFxBYIeQrFhd2|auth0|000b2fc5fa6b9e5883b6245b). Wildcards are not supported.

system.createdBy.nameArray of strings

The name of the creator to use when filtering jobs. Use a pipe to specify multiple values (for example, ?system.createdBy.name=John+Doe|John+Smith). Wildcards are not supported.

system.statusArray of strings

The status value to use when filtering jobs. Use a pipe to specify multiple values (for example, ?system.status=Queued|Running).

system.queuedTimeArray of strings

The job queued time to filter entries by. Use & to include more than one filter (for example, ?system.queuedTime=>2024-10-14T00:00:00.000Z&system.queuedTime=<2024-12-31T00:00:00.000Z). Only =>DATE and =<DATE filters are supported.

system.startTimeArray of strings

The job start time to filter entries by. Use & to include more than one filter (for example, ?system.startTime=>2024-10-14T00:00:00.000Z&system.startTime=<2024-12-31T00:00:00.000Z). Only =>DATE and =<DATE filters are supported.

system.finishTimeArray of strings

The job finish time to filter entries by. Use & to include more than one filter (for example, ?system.finishTime=>2024-10-14T00:00:00.000Z&system.finishTime=<2024-12-31T00:00:00.000Z). Only =>DATE and =<DATE filters are supported.

sortBystring

Field to sort jobs by. You can specify whether to sort by ascending or descending order, using the format field:order, where order can be 1 for ascending or -1 for descending (for example, name:1). The following fields are supported: name, source, system.status, system.queuedTime, system.startTime, system.finishTime.

Headers
x-sc-continuationstring, <= 16384 characters

Continuation token value from which to start the selection (checkpoint pagination). The first time you call this endpoint using checkpoint pagination, omit this header.

curl -i -X GET \
  'https://edge-platform.sitecorecloud.io/authoring/publishing/v1/jobs?pageNumber=1&pageSize=50&source=string&system.createdBy.id=string&system.createdBy.name=string&system.status=Queued&system.queuedTime=string&system.startTime=string&system.finishTime=string&sortBy=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'x-sc-continuation: string'

Responses

Jobs successfully retrieved

Bodyapplication/json
One of:

Represented batch data response.

dataArray of objects or null(PublishJobResponse)required

The collection of data for response.

pageNumberinteger, (int32)required

The page number.

pageSizeinteger, (int32)required

The page size.

totalCountinteger, (int32)required

The total count of items.

Response
{ "totalCount": 0, "pageNumber": 0, "pageSize": 0, "data": [ { … } ] }