Skip to main content
GET
/
jobs
List jobs
curl --request GET \
  --url https://api.renderjuice.com/api/external/v1/jobs \
  --header 'Authorization: Bearer <token>'
{
  "jobs": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "completed",
      "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "rootFolderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "normalizedSeconds": 123,
      "previewUrl": "<string>",
      "failedReason": {
        "name": "<string>",
        "type": "<string>"
      },
      "requestedConfig": "<unknown>",
      "finalConfig": "<unknown>",
      "output": {
        "isDeletedForClient": true
      },
      "isAnalysisSkipped": true,
      "analysisId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "analysis": "<unknown>",
      "sceneFile": "<unknown>"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 10,
    "total": 100,
    "totalPages": 10
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Format: Bearer RJ-XXX.... Get your API key from the Renderjuice dashboard.

Query Parameters

​
page
integer
default:1

Page number to retrieve (1-indexed) Page number to retrieve (1-indexed). Defaults to 1 if not provided.

Required range: x > 0
Example:

1

​
pageSize
integer
default:20

Number of jobs to return per page Number of jobs to return per page. Defaults to 20 if not provided (max: 100).

Required range: 0 < x <= 100
Example:

20

​
status
enum<string>

Filter jobs by status Filter jobs by status. If not provided, returns jobs with all statuses.

Available options:
created,
validating,
validated,
rendering,
finalizing,
completed,
failed,
canceled,
booting,
suspended
Example:

"rendering"

Response

200 - application/json

Success

​
jobs
object[]
required
​
pagination
object
required