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

# List jobs

> Retrieve a filtered and paginated list of render jobs with various query options for job management and monitoring



## OpenAPI

````yaml /openapi.json get /jobs
openapi: 3.0.4
info:
  title: Nexrender API
  version: '2.0'
  description: >
    REST API for the Nexrender cloud rendering platform, enabling programmatic
    control over After Effects template processing, job management, and asset
    handling.


    Features include:


    - Template upload and management (AEP, MOGRT, ZIP files)

    - Job creation and status monitoring with real-time progress

    - Job nesting for multi-composition renders (parent/child jobs)

    - Job stitching to combine multiple videos into one

    - Batch job creation for submitting up to 1000 jobs at once

    - Font library management for typography consistency

    - Secret management for secure API key storage

    - Webhook notifications for job lifecycle events

    - Asset injection for dynamic content replacement


    Authentication is required for all endpoints using Bearer token
    authorization.
servers:
  - url: https://api.nexrender.com/api/v2
    description: Production API server
security:
  - apiToken: []
paths:
  /jobs:
    get:
      tags:
        - Render Management
      summary: List jobs
      description: >-
        Retrieve a filtered and paginated list of render jobs with various query
        options for job management and monitoring
      operationId: listJobs
      parameters:
        - in: query
          name: minimal
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
          description: >-
            Return minimal job data (excludes detailed stats and assets for
            performance)
        - in: query
          name: from
          schema:
            type: integer
            minimum: 0
          description: Starting offset for pagination (0-indexed)
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 1000
          description: Maximum number of jobs to return in a single request
        - in: query
          name: from_date
          schema:
            type: string
            format: date-time
          description: Filter jobs created after this date (ISO 8601 format)
        - in: query
          name: to_date
          schema:
            type: string
            format: date-time
          description: Filter jobs created before this date (ISO 8601 format)
        - in: query
          name: states
          schema:
            type: string
          description: >-
            Comma-separated list of job states to include (e.g.,
            "queued,processing,finished")
        - in: query
          name: exclude_states
          schema:
            type: string
          description: Comma-separated list of job states to exclude from results
        - in: query
          name: sort
          schema:
            type: string
            enum:
              - random
              - newest_first
              - oldest_first
              - priority
            default: oldest_first
          description: Sort order for job results and pickup priority
        - in: query
          name: tags
          schema:
            type: string
            pattern: ^[a-zA-Z0-9-_]+(,[a-zA-Z0-9-_]+)*$
          description: >-
            Filter by comma-separated tags (alphanumeric, hyphens, underscores
            only)
      responses:
        '200':
          description: Successfully retrieved list of jobs matching the specified criteria
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Job'
        '400':
          description: >-
            Invalid query parameters - malformed date filters or invalid
            pagination values
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - invalid or missing API token
components:
  schemas:
    Job:
      type: object
      description: Render job with current status, progress, and detailed statistics
      properties:
        id:
          type: string
          description: Unique job identifier used for tracking and API operations
        templateId:
          type: string
          description: >-
            Reference to the template used for this job (null if template was
            not used)
          nullable: true
        status:
          type: string
          description: >-
            Current job status (queued, render:dorender, finished, error, etc.).
            Manually cancelled jobs are normalized to `manually_cancelled` in v2
            responses even though they are stored internally as `error`.
        progress:
          type: number
          format: float
          description: Render progress as a percentage (0.0 to 100.0)
        stats:
          type: object
          description: Detailed timing and metadata statistics for the job
          properties:
            createdAt:
              type: string
              format: date-time
              description: ISO timestamp when the job was initially created
            updatedAt:
              type: string
              format: date-time
              description: ISO timestamp of the most recent job status update
            startedAt:
              type: string
              format: date-time
              nullable: true
              description: ISO timestamp when job processing began (null if not started)
            finishedAt:
              type: string
              format: date-time
              nullable: true
              description: >-
                ISO timestamp when job completed successfully (null if not
                finished)
            errorAt:
              type: string
              format: date-time
              nullable: true
              description: ISO timestamp when job encountered an error (null if no error)
            totalAssets:
              type: integer
              description: Total number of assets included in this job
            renderDuration:
              type: number
              format: float
              nullable: true
              description: Total render time in seconds (null if not completed)
            error:
              type: string
              nullable: true
              description: Error message if job failed (null if successful)
        outputUrl:
          type: string
          nullable: true
          description: URL to the rendered content
    ErrorResponse:
      type: object
      description: Standard error response format
      properties:
        error:
          type: string
          description: Human-readable error message explaining what went wrong
      required:
        - error
  securitySchemes:
    apiToken:
      type: http
      scheme: bearer
      description: >
        Bearer token authentication using API tokens for team-based access
        control.


        You can generate your own API token at:
        https://app.nexrender.com/settings/api-tokens

````