> ## Documentation Index
> Fetch the complete documentation index at: https://docs.merchkit.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List recent jobs

> Asynchronous jobs for this workspace, newest first.



## OpenAPI

````yaml https://www.merchkit.com/api/v1/openapi get /jobs
openapi: 3.1.0
info:
  title: Merchkit API
  version: 1.0.0
  description: >-
    Operate your Merchkit PIM programmatically. Products, images, vendors,
    categories, and data sources are all "entities" in one uniform shape: system
    fields (`id`, `type`, `label`, `parent_id`, timestamps) at the top level and
    every customer-defined key — scalars AND references — in a sparse
    `attributes` map. References read as labeled stubs `{id, type, label}` and
    write as bare UUIDs or `{id}` objects ("write what you read"). UUIDs are the
    only path identifiers; find by your own key with a filter (`GET
    /products?filter[sku]=ARIA-DT-72`) or write by it with `POST
    /{resource}/upsert` and `/batch` (products, images, vendors, and categories
    only — sources have neither route; they are created by the async `POST
    /sources` job pipeline). Start every integration with `GET
    /attributes?type=product` to learn your keys. Completeness is per-channel.
    All errors share one envelope (see the `Error` schema). Authenticate with a
    workspace-scoped API key: `Authorization: Bearer mk_live_...`. See /llms.txt
    for an agent guide.
servers:
  - url: https://www.merchkit.com/api/v1
    description: Merchkit API v1
security:
  - ApiKeyAuth: []
paths:
  /jobs:
    get:
      summary: List recent jobs
      description: Asynchronous jobs for this workspace, newest first.
      operationId: listJobs
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          description: Page size, 1–200 (default 50).
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
          description: Zero-based offset, echoed back in `pagination.offset`.
      responses:
        '200':
          description: A page of jobs.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Job'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
              example:
                data:
                  - id: 1f7c9a2b-6d43-4e8f-b501-a92c7d3e6f18
                    name: Process Source
                    status: running
                    progress:
                      current: 40
                      total: 100
                      percent: 40
                    created_at: '2026-07-18T09:30:22Z'
                    started_at: '2026-07-18T09:30:22Z'
                    completed_at: null
                    result: null
                    metadata:
                      workflow: process-source
                      url: >-
                        https://nordictimber.example/catalog/aria-oak-dining-table
                      via: api_v1
                pagination:
                  total: 128
                  limit: 50
                  offset: 0
                  has_more: true
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Job:
      type: object
      description: An asynchronous operation. Poll until a terminal status.
      required:
        - id
        - name
        - status
        - progress
        - created_at
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          enum:
            - pending
            - running
            - completed
            - failed
            - cancelled
        progress:
          type: object
          properties:
            current:
              type: integer
            total:
              type:
                - integer
                - 'null'
            percent:
              type: number
        created_at:
          type: string
          format: date-time
        started_at:
          type:
            - string
            - 'null'
          format: date-time
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
        result:
          type: 'null'
          description: Reserved for future async write results; always null today.
        metadata:
          type:
            - object
            - 'null'
      example:
        id: 1f7c9a2b-6d43-4e8f-b501-a92c7d3e6f18
        name: Process Source
        status: running
        progress:
          current: 40
          total: 100
          percent: 40
        created_at: '2026-07-18T09:30:22Z'
        started_at: '2026-07-18T09:30:22Z'
        completed_at: null
        result: null
        metadata:
          workflow: process-source
          url: https://nordictimber.example/catalog/aria-oak-dining-table
          via: api_v1
    Pagination:
      type: object
      properties:
        total:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
          description: The exact requested offset, echoed back.
        has_more:
          type: boolean
      example:
        total: 128
        limit: 50
        offset: 0
        has_more: true
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Workspace-scoped API key. Available scopes:

        - `read:products`: List and read products, including variants,
        references, and completeness.

        - `write:products`: Create, update, and upsert products and their
        attribute values.

        - `delete:products`: Delete products.

        - `read:images`: List and read images.

        - `write:images`: Create, update, and upsert images and their attribute
        values.

        - `delete:images`: Delete images.

        - `read:vendors`: List and read vendors.

        - `write:vendors`: Create, update, and upsert vendors and their
        attribute values.

        - `delete:vendors`: Delete vendors.

        - `read:categories`: List and read categories.

        - `write:categories`: Create, update, and upsert categories and their
        attribute values.

        - `delete:categories`: Delete categories.

        - `read:sources`: List and read data sources, including scraped content.

        - `write:sources`: Create data sources (triggers processing) and update
        their attribute values.

        - `delete:sources`: Delete data sources.

        - `read:attributes`: List and read attribute definitions.

        - `write:attributes`: Create and update attribute definitions.

        - `read:views`: List and read saved grid views (MCP surface).

        - `write:views`: Create and update grid views (MCP surface).

        - `read:channels`: Read the enabled channel catalog.

        - `read:events`: Read the workspace change feed and per-entity events.

        - `read:jobs`: List and poll asynchronous job status.

````