sitecore Jobs API

openapi: 3.2.0
info:
  title: Sitecore Content Hub REST Jobs API
  description: The Sitecore Content Hub REST API is a hypermedia API built on HTTP that provides programmatic access to the full range of Content Hub resources, including entities, assets, jobs, search, selections, upload, and audit logs. Developers use it to automate digital asset management workflows, migrate content, build custom integrations, and manage Content Hub configuration. The API supports standard CRUD operations and is authenticated using OAuth 2.0 tokens obtained from the Content Hub identity provider. Navigation between resources uses hyperlinks rather than hardcoded URL patterns. The base URL is tenant-specific and corresponds to the URL of the Content Hub instance followed by /api/.
  version: v1
  contact:
    name: Sitecore Support
    url: https://www.sitecore.com/support
  termsOfService: https://www.sitecore.com/legal/terms-of-service
servers:
- url: https://{tenant}.stylelabs.io/api
  description: Content Hub Production Server
  variables:
    tenant:
      description: The tenant-specific subdomain for the Content Hub instance
      default: your-tenant
security:
- bearerAuth: []
tags:
- name: Jobs
  description: Endpoints for managing background job targets including retrieval, creation, update, and deletion of job configurations.
paths:
  /jobs:
    get:
      operationId: listJobs
      summary: List jobs
      description: Retrieves a list of background job targets configured in the Content Hub instance. Jobs handle long-running operations such as asset processing, reporting, and data exports.
      tags:
      - Jobs
      parameters:
      - name: skip
        in: query
        description: Number of jobs to skip for pagination
        required: false
        schema:
          type: integer
          minimum: 0
      - name: take
        in: query
        description: Maximum number of jobs to return
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 100
      responses:
        '200':
          description: List of jobs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  responses:
    Unauthorized:
      description: Authentication token is missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      description: An error response body
      properties:
        message:
          type: string
          description: A human-readable error message
        statusCode:
          type: integer
          description: The HTTP status code
        errors:
          type: array
          description: List of detailed error messages
          items:
            type: string
    Job:
      type: object
      description: A background job target in Content Hub
      properties:
        id:
          type: integer
          description: The numeric identifier of the job
        identifier:
          type: string
          description: The string identifier of the job target
        status:
          type: string
          description: The current status of the job
          enum:
          - Queued
          - Running
          - Completed
          - Failed
        createdOn:
          type: string
          description: The ISO 8601 timestamp when the job was created
          format: date-time
        completedOn:
          type: string
          description: The ISO 8601 timestamp when the job completed
          format: date-time
    JobListResponse:
      type: object
      description: A paginated list of job configurations
      properties:
        items:
          type: array
          description: The job targets
          items:
            $ref: '#/components/schemas/Job'
        totalCount:
          type: integer
          description: Total number of jobs
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 bearer token obtained from the Content Hub identity provider. Include the token in the Authorization header as 'Bearer {token}'.
externalDocs:
  description: Sitecore Content Hub REST API Documentation
  url: https://doc.sitecore.com/ch/en/developers/cloud-dev/rest-apis.html