Skip to main content
GET
/
jobs
List jobs
curl --request GET \
  --url https://api.nexrender.com/api/v2/jobs \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "templateId": "<string>",
    "status": "<string>",
    "progress": 123,
    "stats": {
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "finishedAt": "2023-11-07T05:31:56Z",
      "errorAt": "2023-11-07T05:31:56Z",
      "totalAssets": 123,
      "renderDuration": 123,
      "error": "<string>"
    },
    "outputUrl": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer token authentication using API tokens for team-based access control.

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

Query Parameters

​
minimal
enum<string>

Return minimal job data (excludes detailed stats and assets for performance)

Available options:
true,
false
​
from
integer

Starting offset for pagination (0-indexed)

Required range: x >= 0
​
limit
integer

Maximum number of jobs to return in a single request

Required range: 1 <= x <= 1000
​
from_date
string<date-time>

Filter jobs created after this date (ISO 8601 format)

​
to_date
string<date-time>

Filter jobs created before this date (ISO 8601 format)

​
states
string

Comma-separated list of job states to include (e.g., "queued,processing,finished")

​
exclude_states
string

Comma-separated list of job states to exclude from results

​
sort
enum<string>
default:oldest_first

Sort order for job results and pickup priority

Available options:
random,
newest_first,
oldest_first,
priority
​
tags
string

Filter by comma-separated tags (alphanumeric, hyphens, underscores only)

Response

Successfully retrieved list of jobs matching the specified criteria

​
id
string

Unique job identifier used for tracking and API operations

​
templateId
string | null

Reference to the template used for this job (null if template was not used)

​
status
string

Current job status (queued, render:dorender, finished, error, etc.)

​
progress
number

Render progress as a percentage (0.0 to 100.0)

​
stats
object

Detailed timing and metadata statistics for the job

​
outputUrl
string | null

URL to the rendered content

⌘I