Skip to main content
List Jobs
curl --request GET \
  --url https://api.ionworks.com/jobs
{
  "jobs": [
    {
      "job_id": "<string>",
      "job_type": "dummy",
      "status": "pending",
      "priority": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "user_id": "<string>",
      "organization_id": "<string>",
      "is_terminal": true,
      "is_failed": true,
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "compute_time": 123,
      "error": "<string>",
      "error_code": "EXECUTION_TIMEOUT",
      "result": {},
      "callback_url": "<string>",
      "parent_job_id": "<string>",
      "project_id": "<string>",
      "access_level": "organization",
      "params_path": "<string>",
      "metadata_path": "<string>"
    }
  ],
  "count": 123,
  "total": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.ionworks.com/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

​
job_type
enum<string> | null

Filter by job type (for backward compatibility) Possible types for a job

Available options:
dummy,
datafit,
validation,
simulate,
evaluate_variables,
optimize
​
job_types
enum<string>[] | null

Filter by multiple job types

Possible types for a job

Available options:
dummy,
datafit,
validation,
simulate,
evaluate_variables,
optimize
​
status
enum<string> | null

Filter by job status Possible statuses for a job

Available options:
pending,
processing,
waiting,
completed,
failed,
canceled
​
limit
integer
default:10

Number of items to return

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of items to skip

Required range: x >= 0
​
ids
string[] | null

Filter by job IDs

Response

Successful Response

Schema for listing jobs with pagination

​
jobs
JobResponse · object[]
required
​
count
integer
required
​
total
integer
required