Optimizely

Optimizely Entity Configurations API

The Entity Configurations API from Optimizely — 7 operation(s) for entity configurations.

GitHub OpenAPI

Operations 11

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/EntityConfigurations List admin entity configurations · Returns the EntitySet EntityConfigurations #
Ask an LLM
“How do I list the entity configurations that shape the admin console?”
“Can I filter entity configurations to those users can delete?”
Tell an agent
List all entity configurations.
List entity configurations matching {filter}.
POST /api/v1/admin/EntityConfigurations Create an entity configuration · Post a new entity to EntitySet EntityConfigurations #
Ask an LLM
“How do I define a new entity configuration with a label and permissions?”
“Can I set whether admins can create or delete an entity when configuring it?”
Tell an agent
Create an entity configuration named {name} labeled {label}.
Add entity configuration {name} with plural label {pluralizedLabel} and delete allowed {canDelete}.
GET /api/v1/admin/EntityConfigurations({id}) Get one entity configuration · Returns the entity with the key from EntityConfigurations #
Ask an LLM
“Is there a call to read a single entity configuration by ID?”
“What label and permissions does a specific entity configuration have?”
Tell an agent
Get entity configuration {id}.
Show the label and permissions of entity configuration {id}.
PUT /api/v1/admin/EntityConfigurations({id}) Replace an entity configuration · Replace entity in EntitySet EntityConfigurations #
Ask an LLM
“What's the call to overwrite an entire entity configuration?”
“What happens to fields I omit when replacing an entity configuration?”
Tell an agent
Replace entity configuration {id} with name {name} and label {label}.
Overwrite the full entity configuration {id} using description {description}.
DELETE /api/v1/admin/EntityConfigurations({id}) Delete an entity configuration · Delete entity in EntitySet EntityConfigurations #
Ask an LLM
“How do I remove an entity configuration by ID?”
“Can I delete an entity configuration only if nobody has changed it?”
Tell an agent destructive · confirm first
Delete entity configuration {id}.
Delete entity configuration {id} if its ETag is {etag}.
PATCH /api/v1/admin/EntityConfigurations({id}) Update an entity configuration · Update entity in EntitySet EntityConfigurations #
Ask an LLM
“How do I change the instructional text shown for an entity?”
“Can I turn off editing on an entity configuration without replacing it?”
Tell an agent
Set the instructional text of entity configuration {id} to {instructionalText}.
Set can-edit to {canEdit} on entity configuration {id}.
GET /api/v1/admin/EntityConfigurations/Default.Default() Get the default entity configuration · Call operation Default #
Ask an LLM
“What does a default entity configuration look like?”
“Where do I get starting values for a new entity configuration?”
Tell an agent
Get the default entity configuration template.
Show default values for a new entity configuration.
DELETE /api/v1/admin/entityconfigurations/delete Bulk delete entity configurations · Entity configurations delete route #
Ask an LLM
“Can I delete several entity configurations in one call?”
“Can I remove a list of entity configurations by their IDs?”
Tell an agent destructive · confirm first
Bulk delete entity configurations {ids}.
Remove these entity configurations all at once: {ids}.
GET /api/v1/admin/entityconfigurations({key})/customproperties({custompropertyKey}) Get a custom property on an entity configuration · Entity configurations get custom property by key and custompropertykey #
Ask an LLM
“Where would I read a custom property on an entity configuration?”
“Can I look up an extra attribute stored against an entity configuration?”
Tell an agent
Get custom property {prop} on entity configuration {key}.
Show custom field {prop} for entity configuration {key}.
GET /api/v1/admin/entityconfigurations({key})/entitypermissions({entitypermissionKey}) Get a permission on an entity configuration · Entity configurations get entity permission by key and entitypermissionkey #
Ask an LLM
“Which role permission applies to an entity configuration?”
“Can I read one entity permission rule by its key?”
Tell an agent
Get permission {perm} on entity configuration {key}.
Show entity permission rule {perm} for configuration {key}.
GET /api/v1/admin/entityconfigurations({key})/propertyconfigurations({propertyconfigurationKey}) Get a property configuration of an entity · Entity configurations get property configuration by key and… #
Ask an LLM
“Can I see how a single field is configured on an entity?”
“Can I read one property configuration under an entity configuration?”
Tell an agent
Get property configuration {prop} on entity configuration {key}.
Show how field configuration {prop} is set up in entity {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-entity-configurations-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-entity-configurations-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.

GitHub Google LinkedIn

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

OpenAPI Specification

optimizely-entity-configurations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Entity Configurations API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Entity Configurations
paths:
  /api/v1/admin/EntityConfigurations:
    get:
      tags:
      - Entity Configurations
      summary: Returns the EntitySet EntityConfigurations
      operationId: EntityConfigurations_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:
      - Entity Configurations
      summary: Post a new entity to EntitySet EntityConfigurations
      operationId: EntityConfigurations_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.EntityConfiguration'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/EntityConfigurations({id}):
    get:
      tags:
      - Entity Configurations
      summary: Returns the entity with the key from EntityConfigurations
      operationId: EntityConfigurations_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:
      - Entity Configurations
      summary: Replace entity in EntitySet EntityConfigurations
      operationId: EntityConfigurations_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.EntityConfiguration'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Entity Configurations
      summary: Delete entity in EntitySet EntityConfigurations
      operationId: EntityConfigurations_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:
      - Entity Configurations
      summary: Update entity in EntitySet EntityConfigurations
      operationId: EntityConfigurations_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.EntityConfiguration'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/EntityConfigurations/Default.Default():
    get:
      tags:
      - Entity Configurations
      summary: Call operation Default
      operationId: EntityConfigurations_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/entityconfigurations/delete:
    delete:
      tags:
      - Entity Configurations
      operationId: EntityConfigurations_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: Entity configurations delete route
      x-summary-source: derived
  /api/v1/admin/entityconfigurations({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Entity Configurations
      operationId: EntityConfigurations_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: Entity configurations get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/entityconfigurations({key})/entitypermissions({entitypermissionKey}):
    get:
      tags:
      - Entity Configurations
      operationId: EntityConfigurations_GetEntityPermissionByKeyAndEntitypermissionkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: entitypermissionKey
        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: Entity configurations get entity permission by key and entitypermissionkey
      x-summary-source: derived
  /api/v1/admin/entityconfigurations({key})/propertyconfigurations({propertyconfigurationKey}):
    get:
      tags:
      - Entity Configurations
      operationId: EntityConfigurations_GetPropertyConfigurationByKeyAndPropertyconfigurationkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: propertyconfigurationKey
        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: Entity configurations get property configuration by key and…
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.EntityConfiguration:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        description:
          maxLength: 2048
          minLength: 0
          type: string
        displayNameFormat:
          maxLength: 1024
          minLength: 0
          type: string
        instructionalText:
          maxLength: 2048
          minLength: 0
          type: string
        label:
          maxLength: 256
          minLength: 0
          type: string
        name:
          maxLength: 256
          minLength: 0
          type: string
        canView:
          type: boolean
        canEdit:
          type: boolean
        canCreate:
          type: boolean
        canDelete:
          type: boolean
        pluralizedLabel:
          maxLength: 256
          minLength: 0
          type: string
        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