Optimizely

Optimizely System Lists API

The System Lists API from Optimizely — 8 operation(s) for system lists.

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/admin/SystemLists List and filter system lists · Returns the EntitySet SystemLists #
Ask an LLM
“How can I see all the system lists that drive dropdowns in my commerce admin?”
“Can I filter system lists by name and return only selected fields?”
Tell an agent
List all system lists.
List system lists matching {filter}.
POST /api/v1/admin/SystemLists Create a system list · Post a new entity to EntitySet SystemLists #
Ask an LLM
“How do I add a new system list of predefined values?”
“What do I need to supply when creating a system list, like additional info?”
Tell an agent
Create a system list named {name} described as {description} with additional info {additionalInfo}.
Add system list {name} ({description}), notes {additionalInfo}, retiring on {deactivateOn}.
GET /api/v1/admin/SystemLists({id}) Get one system list by id · Returns the entity with the key from SystemLists #
Ask an LLM
“How can I look up a single system list by its id?”
“Can I expand a system list's values when I fetch it?”
Tell an agent
Show system list {id}.
Fetch system list {id} expanding {expand}.
PUT /api/v1/admin/SystemLists({id}) Replace a system list entirely · Replace entity in EntitySet SystemLists #
Ask an LLM
“How do I overwrite every field of a system list in one call?”
“Will a full replace of a system list drop fields I omit?”
Tell an agent
Replace system list {id} with name {name}, description {description} and info {additionalInfo}.
Overwrite the full record of system list {id}.
DELETE /api/v1/admin/SystemLists({id}) Delete one system list · Delete entity in EntitySet SystemLists #
Ask an LLM
“How do I remove one system list permanently?”
“Can I guard a system list delete with an If-Match ETag?”
Tell an agent destructive · confirm first
Delete system list {id}.
Remove system list {id} only if the ETag matches {etag}.
PATCH /api/v1/admin/SystemLists({id}) Update some fields of a system list · Update entity in EntitySet SystemLists #
Ask an LLM
“How can I change only the description of a system list?”
“Can I set a deactivation date on a system list without replacing it?”
Tell an agent
Update the description of system list {id} to {description}.
Deactivate system list {id} on {deactivateOn}.
GET /api/v1/admin/SystemLists/Default.Default() Get default values for a new system list · Call operation Default #
Ask an LLM
“What defaults does a new system list come with?”
“Where do I grab an empty system list template?”
Tell an agent
Fetch the default system list template.
Show the starting values for new system lists.
POST /api/v1/admin/SystemLists/Default.archive Archive system lists with the archive action · Call operation archive #
Ask an LLM
“How do I archive system lists using the archive action?”
“Can I retire several system lists without deleting them?”
Tell an agent destructive · confirm first
Archive system lists {ids} via the archive action.
Call the system list archive operation for {ids}.
DELETE /api/v1/admin/systemlists/archive Archive system lists via the DELETE route · System lists archive route #
Ask an LLM
“Is there a DELETE route for archiving system lists by id?”
“Can I archive system lists through /systemlists/archive?”
Tell an agent destructive · confirm first
Send the archive DELETE for system lists {ids}.
Archive system lists {ids} through the systemlists/archive route.
DELETE /api/v1/admin/systemlists/delete Bulk delete system lists by ids · System lists delete route #
Ask an LLM
“How do I delete a batch of system lists at once?”
“Can I pass multiple ids to remove several system lists?”
Tell an agent destructive · confirm first
Bulk delete system lists {ids}.
Permanently delete every system list in {ids}.
GET /api/v1/admin/systemlists({key})/customproperties({custompropertyKey}) Get a custom property of a system list · System lists get custom property by key and custompropertykey #
Ask an LLM
“Where can I read a custom property on a system list?”
“How do I fetch one custom attribute stored on a system list?”
Tell an agent
Get custom property {custompropertyKey} of system list {key}.
Read custom field {custompropertyKey} on system list {key}.
GET /api/v1/admin/systemlists({key})/values({systemlistvalueKey}) Get one value from a system list · System lists get value by key and systemlistvaluekey #
Ask an LLM
“How do I read a single option value inside a system list?”
“Which value entries belong to a given system list?”
Tell an agent
Get value {systemlistvalueKey} from system list {key}.
Show list entry {systemlistvalueKey} in system list {key}.

Specifications

⚙
OpenAPI
https://artifacts.apis.io/optimizely/openapi/optimizely-system-lists-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/optimizely:optimizely-system-lists-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-system-lists-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 System Lists API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: System Lists
paths:
  /api/v1/admin/SystemLists:
    get:
      tags:
      - System Lists
      summary: Returns the EntitySet SystemLists
      operationId: SystemLists_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - System Lists
      summary: Post a new entity to EntitySet SystemLists
      operationId: SystemLists_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.SystemList'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SystemLists({id}):
    get:
      tags:
      - System Lists
      summary: Returns the entity with the key from SystemLists
      operationId: SystemLists_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - System Lists
      summary: Replace entity in EntitySet SystemLists
      operationId: SystemLists_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.SystemList'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - System Lists
      summary: Delete entity in EntitySet SystemLists
      operationId: SystemLists_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - System Lists
      summary: Update entity in EntitySet SystemLists
      operationId: SystemLists_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.SystemList'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SystemLists/Default.Default():
    get:
      tags:
      - System Lists
      summary: Call operation Default
      operationId: SystemLists_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/SystemLists/Default.archive:
    post:
      tags:
      - System Lists
      summary: Call operation archive
      operationId: SystemLists_Archive
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      requestBody:
        $ref: '#/components/requestBodies/Affiliates_ArchiveParameters'
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/systemlists/archive:
    delete:
      tags:
      - System Lists
      operationId: SystemLists_ArchiveRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: System lists archive route
      x-summary-source: derived
  /api/v1/admin/systemlists/delete:
    delete:
      tags:
      - System Lists
      operationId: SystemLists_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: System lists delete route
      x-summary-source: derived
  /api/v1/admin/systemlists({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - System Lists
      operationId: SystemLists_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: System lists get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/systemlists({key})/values({systemlistvalueKey}):
    get:
      tags:
      - System Lists
      operationId: SystemLists_GetValueByKeyAndSystemlistvaluekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: systemlistvalueKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: System lists get value by key and systemlistvaluekey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.SystemList:
      required:
      - name
      - description
      - additionalInfo
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        name:
          maxLength: 256
          minLength: 0
          type: string
        description:
          maxLength: 1024
          minLength: 0
          type: string
        additionalInfo:
          maxLength: 1024
          minLength: 0
          type: string
        deactivateOn:
          format: date-time
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  requestBodies:
    Affiliates_ArchiveParameters:
      content:
        application/json:
          schema:
            type: object
            properties: {}
      description: archive action parameters
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query