List Experiment Templates

curl --request GET \
  --url https://api.ionworks.com/experiment_templates

{
  "items": [
    {
      "name": "<string>",
      "organization_id": "<string>",
      "id": "<string>",
      "description": "<string>",
      "description_template": "<string>",
      "protocol_config": {},
      "parameters_schema": {},
      "created_at": "<string>",
      "updated_at": "<string>",
      "plot_options": {},
      "time_series_spec": {},
      "metrics_spec": {},
      "source_protocol": "<string>",
      "created_by": "<string>",
      "created_by_email": "<string>"
    }
  ],
  "count": 123,
  "total": 123
}

List Experiment Templates

List experiment templates accessible to the current organization.

Returns both organization-specific and system templates, excluding hidden ones. The response is lightweight by default: large JSONB columns (protocol_config, parameters_schema, time_series_spec, metrics_spec, plot_options) and the source_protocol text are omitted unless explicitly requested via ?include=. Fetch the full template via GET /{template_id} when the user opens one.

Parameters

limit : int | None, optional Page size (1-100). When omitted the full list is returned. offset : int | None, optional Number of records to skip before the page starts. include : str | None, optional Comma-separated list of heavy columns to include in the response. Supported values: protocol_config, parameters_schema, time_series_spec, metrics_spec, plot_options, source_protocol. Unknown names are silently ignored.

Returns

ExperimentTemplateListResponse | list[ExperimentTemplate] Paginated response with items, count, and total when limit is provided; otherwise a plain list.

List Experiment Templates

curl --request GET \
  --url https://api.ionworks.com/experiment_templates

{
  "items": [
    {
      "name": "<string>",
      "organization_id": "<string>",
      "id": "<string>",
      "description": "<string>",
      "description_template": "<string>",
      "protocol_config": {},
      "parameters_schema": {},
      "created_at": "<string>",
      "updated_at": "<string>",
      "plot_options": {},
      "time_series_spec": {},
      "metrics_spec": {},
      "source_protocol": "<string>",
      "created_by": "<string>",
      "created_by_email": "<string>"
    }
  ],
  "count": 123,
  "total": 123
}

Query Parameters

limit

integer | null

Required range: 1 <= x <= 100

offset

integer | null

Required range: x >= 0

include

string | null

Response

Successful Response

ExperimentTemplateListResponse · object
ExperimentTemplate · object[]

Paginated list of experiment templates.

items

ExperimentTemplate · object[]

required

Show child attributes

count

integer

required

total

integer

required

⌘I