Optimizely Content Items API

The Content Items API from Optimizely — 5 operation(s) for content items.

Operations 9

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/ContentItems List CMS content items · Returns the EntitySet ContentItems #
Ask an LLM
“Which content items and pages exist on my commerce website's CMS?”
“Can I filter content items to only pages for one website?”
Tell an agent
List all content items.
Find content items matching {filter}.
POST /api/v1/admin/ContentItems Create a content item · Post a new entity to EntitySet ContentItems #
Ask an LLM
“How do I add a new page or widget content item to the CMS?”
“Can I schedule when a new content item publishes?”
Tell an agent
Create content item {name} of class {class} at path {path} in zone {zone}.
Add a content item {name} with variant {variantName} and template view {templateView}, publishing on {publishOn}.
GET /api/v1/admin/ContentItems({id}) Get one content item · Returns the entity with the key from ContentItems #
Ask an LLM
“What is the publish and approval status of a specific content item?”
“Is a given content item a page or a template?”
Tell an agent
Get content item {id}.
Show content item {id} returning only {select}.
PUT /api/v1/admin/ContentItems({id}) Replace a content item record · Replace entity in EntitySet ContentItems #
Ask an LLM
“How do I overwrite a content item with a complete new record?”
“Can I fully replace a CMS content item instead of patching fields?”
Tell an agent
Replace content item {id} with name {name}, class {class} and path {path}.
Overwrite the whole record for content item {id}.
DELETE /api/v1/admin/ContentItems({id}) Delete a content item · Delete entity in EntitySet ContentItems #
Ask an LLM
“How do I remove a single content item from the CMS?”
“Can I delete a content item conditionally on its ETag?”
Tell an agent destructive · confirm first
Delete content item {id}.
Delete content item {id} if its ETag is still {ifMatch}.
PATCH /api/v1/admin/ContentItems({id}) Partially update a content item · Update entity in EntitySet ContentItems #
Ask an LLM
“Can I change just the publish date of an existing content item?”
“How do I retract a content item without rewriting the whole record?”
Tell an agent
Set content item {id} to publish on {publishOn}.
Mark content item {id} as retracted {isRetracted}.
GET /api/v1/admin/ContentItems/Default.Default() Get the default content item template · Call operation Default #
Ask an LLM
“What default values does a new content item start with?”
“Is there a blank content item template I can fetch?”
Tell an agent
Fetch the default content item template.
Get default values for a new content item.
DELETE /api/v1/admin/contentitems/delete Bulk delete content items · Content items delete route #
Ask an LLM
“How do I delete many content items in one request?”
“Can I remove several CMS content items by listing their IDs?”
Tell an agent destructive · confirm first
Bulk delete content items {ids}.
Remove all these content items at once: {ids}.
GET /api/v1/admin/contentitems({key})/customproperties({custompropertyKey}) Get a custom property of a content item · Content items get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property attached to a content item?”
“Can I fetch a single custom field from a CMS content item?”
Tell an agent
Get custom property {custompropertyKey} of content item {key}.
Show custom field {custompropertyKey} on content item {key}.

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-content-items-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

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

OpenAPI Specification

optimizely-content-items-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Content Items API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Content Items
paths:
  /api/v1/admin/ContentItems:
    get:
      tags:
      - Content Items
      summary: Returns the EntitySet ContentItems
      operationId: ContentItems_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:
      - Content Items
      summary: Post a new entity to EntitySet ContentItems
      operationId: ContentItems_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.ContentItem'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ContentItems({id}):
    get:
      tags:
      - Content Items
      summary: Returns the entity with the key from ContentItems
      operationId: ContentItems_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:
      - Content Items
      summary: Replace entity in EntitySet ContentItems
      operationId: ContentItems_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.ContentItem'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Content Items
      summary: Delete entity in EntitySet ContentItems
      operationId: ContentItems_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:
      - Content Items
      summary: Update entity in EntitySet ContentItems
      operationId: ContentItems_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.ContentItem'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ContentItems/Default.Default():
    get:
      tags:
      - Content Items
      summary: Call operation Default
      operationId: ContentItems_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/contentitems/delete:
    delete:
      tags:
      - Content Items
      operationId: ContentItems_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: Content items delete route
      x-summary-source: derived
  /api/v1/admin/contentitems({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Content Items
      operationId: ContentItems_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: Content items get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.ContentItem:
      required:
      - class
      - path
      - name
      - variantName
      - zone
      - templateView
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        class:
          maxLength: 50
          minLength: 0
          type: string
        contentKey:
          format: int32
          type: integer
        parentKey:
          format: int32
          type: integer
        pageContentKey:
          format: int32
          type: integer
        variantKey:
          format: int32
          type: integer
        path:
          maxLength: 500
          minLength: 0
          type: string
        isPage:
          type: boolean
        sortOrder:
          format: int32
          type: integer
        publishOn:
          format: date-time
          type: string
        websiteId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        approvedOn:
          format: date-time
          type: string
        submittedForApprovalOn:
          format: date-time
          type: string
        createdById:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        approvedById:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        isRetracted:
          type: boolean
        name:
          maxLength: 50
          minLength: 0
          type: string
        variantName:
          maxLength: 50
          minLength: 0
          type: string
        zone:
          maxLength: 100
          minLength: 0
          type: string
        linkedToContentKey:
          format: int32
          type: integer
        syncLinkedToChildren:
          type: boolean
        isTemplate:
          type: boolean
        templateContentKey:
          format: int32
          type: integer
        useDefaultTemplate:
          type: boolean
        templateView:
          maxLength: 100
          minLength: 0
          type: string
        isDeleted:
          type: boolean
        isDefaultVariant:
          type: boolean
        ruleManagerId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        experimentId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        isRollback:
          type: boolean
        isMobileAppPage:
          type: boolean
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query