Optimizely Entity Definitions API

The Entity Definitions API from Optimizely — 6 operation(s) for entity definitions.

Operations 6

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/EntityDefinitions List admin entity definitions · Returns the EntitySet EntityDefinitions #
Ask an LLM
“Which entity types does the commerce admin define, with their properties?”
“Can I see the metadata for every admin entity at once?”
Tell an agent
List all entity definitions.
Show entity definitions matching {filter}.
GET /api/v1/admin/EntityDefinitions('{name}') Get one entity definition by name · Returns the entity with the key from EntityDefinitions #
Ask an LLM
“What properties does a specific admin entity, like customerOrder, have?”
“Can I fetch the definition of a single entity type by its name?”
Tell an agent
Show the entity definition for {name}.
Get metadata for entity type {name}.
GET /api/v1/admin/EntityDefinitions/Default.PropertyValidations(entityName='{entityName}') Get property validations via OData function · Call operation PropertyValidations #
Ask an LLM
“Can I read an entity's field validation rules through the OData PropertyValidations function?”
“Which validation rules apply to an entity's properties, using the Default. function call?”
Tell an agent
Get property validations for {entityName} using the Default.PropertyValidations function.
Call the OData PropertyValidations function for entity {entityName}.
GET /api/v1/admin/EntityDefinitions/Default.DisplayNameFormats() Get display name formats via OData function · Call operation DisplayNameFormats #
Ask an LLM
“How are entity display names formatted, via the OData DisplayNameFormats function?”
“Can I call Default.DisplayNameFormats to see naming templates?”
Tell an agent
Call the Default.DisplayNameFormats function.
Get display name formats through the OData function.
GET /api/v1/admin/entitydefinitions/PropertyValidations(entityName='{entityName}') Get property validations via route · Entity definitions get property validations by entityname 2 #
Ask an LLM
“Is there a plain route for an entity's property validation rules?”
“What are the required-field and length rules for an entity, from the lowercase entitydefinitions path?”
Tell an agent
Get property validations for {entityName} from the PropertyValidations route.
Fetch field validation rules of {entityName} via the non-OData path.
GET /api/v1/admin/entitydefinitions/displayNameFormats Get display name formats via route · Entity definitions get display name formats 2 #
Ask an LLM
“Is there a simple displayNameFormats route for entity naming templates?”
“Where can I fetch display name formats without OData function syntax?”
Tell an agent
Get display name formats from the displayNameFormats route.
Fetch entity naming templates via the plain displayNameFormats path.

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-definitions-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-entity-definitions-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Entity Definitions API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Entity Definitions
paths:
  /api/v1/admin/EntityDefinitions:
    get:
      tags:
      - Entity Definitions
      summary: Returns the EntitySet EntityDefinitions
      operationId: EntityDefinitions_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
  /api/v1/admin/EntityDefinitions('{name}'):
    get:
      tags:
      - Entity Definitions
      summary: Returns the entity with the key from EntityDefinitions
      operationId: EntityDefinitions_GetByName
      parameters:
      - name: name
        in: path
        description: 'key: name'
        required: true
        schema:
          type: string
      - 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
  /api/v1/admin/EntityDefinitions/Default.PropertyValidations(entityName='{entityName}'):
    get:
      tags:
      - Entity Definitions
      summary: Call operation PropertyValidations
      operationId: EntityDefinitions_GetPropertyValidationsByEntityname_1
      parameters:
      - name: entityName
        in: path
        description: 'parameter: entityName'
        required: true
        schema:
          type: string
      - 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
  /api/v1/admin/EntityDefinitions/Default.DisplayNameFormats():
    get:
      tags:
      - Entity Definitions
      summary: Call operation DisplayNameFormats
      operationId: EntityDefinitions_GetDisplayNameFormats_1
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
  /api/v1/admin/entitydefinitions/PropertyValidations(entityName='{entityName}'):
    get:
      tags:
      - Entity Definitions
      operationId: EntityDefinitions_GetPropertyValidationsByEntityname_2
      parameters:
      - name: entityName
        in: path
        required: true
        schema:
          type: string
      - 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
      summary: Entity definitions get property validations by entityname 2
      x-summary-source: derived
  /api/v1/admin/entitydefinitions/displayNameFormats:
    get:
      tags:
      - Entity Definitions
      operationId: EntityDefinitions_GetDisplayNameFormats_2
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      summary: Entity definitions get display name formats 2
      x-summary-source: derived
components:
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query