> ## 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.

# 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.



## OpenAPI

````yaml https://api.ionworks.com/openapi.json get /experiment_templates
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://api.ionworks.com
    description: Production
security: []
paths:
  /experiment_templates:
    get:
      tags:
        - experiment_templates
      summary: List Experiment Templates
      description: >-
        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.
      operationId: list_experiment_templates_experiment_templates_get
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 100
                minimum: 1
              - type: 'null'
            title: Limit
        - name: offset
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                minimum: 0
              - type: 'null'
            title: Offset
        - name: include
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Include
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ExperimentTemplateListResponse'
                  - type: array
                    items:
                      $ref: '#/components/schemas/ExperimentTemplate'
                title: Response List Experiment Templates Experiment Templates Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ExperimentTemplateListResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/ExperimentTemplate'
          type: array
          title: Items
        count:
          type: integer
          title: Count
        total:
          type: integer
          title: Total
      type: object
      required:
        - items
        - count
        - total
      title: ExperimentTemplateListResponse
      description: Paginated list of experiment templates.
    ExperimentTemplate:
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
          description: Unique identifier for the template
        name:
          type: string
          title: Name
          description: Name of the template
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Description of the template
        description_template:
          anyOf:
            - type: string
            - type: 'null'
          title: Description Template
          description: >-
            Template string for generating user-facing descriptions with
            {{param}} placeholders
        protocol_config:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Protocol Config
          description: >-
            Protocol configuration (UCP format). Omitted from list responses by
            default; opt in via ``?include=protocol_config``.
        parameters_schema:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Parameters Schema
          description: >-
            Parameters schema defining what parameters this template accepts.
            Omitted from list responses by default; opt in via
            ``?include=parameters_schema``.
        organization_id:
          type: string
          title: Organization Id
          description: ID of the organization that owns this template
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
          description: When the template was created
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated At
          description: When the template was last updated
        plot_options:
          additionalProperties: true
          type: object
          title: Plot Options
          description: >-
            Plot configuration options organized by plot type (time_series,
            metrics)
        time_series_spec:
          additionalProperties: true
          type: object
          title: Time Series Spec
          description: Specification mapping time-series keys to calculation rules.
        metrics_spec:
          additionalProperties: true
          type: object
          title: Metrics Spec
          description: Specification mapping metric names to calculation rules.
        source_protocol:
          anyOf:
            - type: string
            - type: 'null'
          title: Source Protocol
          description: Original protocol text as entered by the user
        created_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By
          description: User ID of the user who created this template
        created_by_email:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By Email
          description: Email of the user who created this template
      type: object
      required:
        - name
        - organization_id
      title: ExperimentTemplate
      description: Pydantic model for experiment template database entity.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````