---
title: "List Optimization Resources"
method: GET
path: "/optimizations"
tags: ["optimizations"]
---

# List Optimization Resources

`GET /optimizations`

## Request

- Base URL: `https://api.ionworks.com`
- URL: `https://api.ionworks.com/optimizations`
- Auth: none declared

List optimizations as job-free resources for the project.

Same filtering as the legacy list endpoint, but each item is an
:class:`OptimizationResource` (flat status, no linked job). ``status``
filters still accept the underlying job-status vocabulary.

## Query parameters

- `project_id` string, uuid, required
- `limit` integer
- `offset` integer
- `q` string, nullable
- `name` string, nullable
- `status` string, nullable
- `template_name` string, nullable
- `cell_name` string, nullable
- `model_name` string, nullable
- `created_by_email` string, nullable
- `created_at` string, nullable
- `created_at_gt` string, nullable
- `created_at_lt` string, nullable
- `updated_at_gt` string, nullable
- `updated_at_lt` string, nullable

## Response `200`

Successful Response

- OptimizationResourceListResponse: Paginated list of job-free optimization resources.
  - `optimizations` OptimizationResource[], required
    - `id` string, required: Canonical optimization identifier.
    - `name` string, nullable
    - `description` string, nullable
    - `project_id` string, required
    - `organization_id` string, required
    - `status` 'queued' | 'running' | 'succeeded' | 'failed' | 'canceled': Frontend-facing lifecycle status for an async resource.
    - `kind` string, nullable: Optimization kind discriminator (e.g. 'optimize', 'datafit'); determines how the config is interpreted.
    - `created_at` string, date-time, nullable
    - `created_by_email` string, nullable
    - `cell_spec_id` string, nullable
    - `parameterized_model_id` string, nullable
    - `parameterized_model_name` string, nullable: Display name of the parameterized model.
    - `cell_name` string, nullable: Display name of the cell specification.
    - `optimization_template_id` string, nullable
    - `metrics` object, nullable: Result metrics of the optimization, when complete.
    - `objectives` object, nullable: Objectives/constraints from the config, for list display. Populated on list responses only.
    - `error` string, nullable: Error message if the run failed.
    - `error_code` string, nullable: Machine-readable error code.
    - `run_count` integer: Number of multistart runs.
  - `total` integer, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-30** `ea3d377fec1a`: 1 breaking
  - for the `query` request parameter `project_id`, the format changed from no format to `uuid`

[Operation history](https://skmtc.dev/ionworks/apis/ionworks-api/changes/optimizations/get.md)

---

[API](https://skmtc.dev/ionworks/apis/ionworks-api.md) - [All operations](https://skmtc.dev/ionworks/apis/ionworks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ionworks/apis/ionworks-api/revisions/abebbbc5f60a?raw)
