List Experiment Templates

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ionworks.com/experiment_templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ionworks.com/experiment_templates"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ionworks.com/experiment_templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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>",
      "project_id": "<string>"
    }
  ],
  "count": 123,
  "total": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

List Experiment Templates

List a project’s experiment templates.

project_id is required. Protocols are project-scoped: every project holds its own copies of the built-in catalog, so an organization-wide list returns the same protocol once per project rather than a meaningful catalog. This endpoint used to union the org’s unscoped rows with the system organization’s; both of those sources are gone in the contract phase, so rather than silently returning N copies of everything it now rejects the call. 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, one page of up to PostgREST’s max_rows is returned; compare count against total to detect that there is more. 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. project_id : str Project whose protocols to return. Required — see above. name : str | None, optional Text filter on the protocol name, per the field’s policy in _PROTOCOL_FILTERS: ilike.%rpt% for a partial match, eq.RPT for an exact one. A bare value is equality. created_by_email : str | None, optional Text filter on the creator’s email, same operator syntax as name. created_at, updated_at : str | None, optional Date filters: gte.value / lte.value etc. Use the _gt / _lt variants together for a between query. order_by : str, optional Column to sort by. Defaults to created_at. order : str, optional Sort direction. Defaults to desc.

Returns

ExperimentTemplateListResponse items, count (rows in this response) and total (every protocol matching the filters). count < total means the result was truncated — page through with limit / offset to get the rest.

Raises

BadRequestError If project_id is omitted, or a filter value violates its field policy. An unsupported order_by / order is a 422 from FastAPI.

List Experiment Templates

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ionworks.com/experiment_templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ionworks.com/experiment_templates"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ionworks.com/experiment_templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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>",
      "project_id": "<string>"
    }
  ],
  "count": 123,
  "total": 123
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Query Parameters

limit

integer | null

Required range: 1 <= x <= 100

offset

integer | null

Required range: x >= 0

include

string | null

project_id

string | null

name

string | null

created_by_email

string | null

created_at

string | null

created_at_gt

string | null

created_at_lt

string | null

updated_at

string | null

updated_at_gt

string | null

updated_at_lt

string | null

order_by

enum<string>

default:created_at

Available options:

name,

created_at,

updated_at

order

enum<string>

default:desc

Available options:

asc,

desc

Response

Successful Response

Paginated list of experiment templates.

items

ExperimentTemplate · object[]

required

Show child attributes

count

integer

required

total

integer

required

⌘I

API Reference

Cell Specifications

Cell Instances

Cell Measurements

Programs

Sites

Cyclers

Channels

Simulations

parameterized_models

discovery

Pipeline

simple_pipeline

protocols

users

jobs

optimization

optimizations

Organizations

project-webhooks

studies

Lab

Planned Measurements

Health check

List Experiment Templates

Parameters

Returns

Raises

Query Parameters

Response