Optimizely Attribute Types API

The Attribute Types API from Optimizely — 9 operation(s) for attribute types.

Operations 13

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/AttributeTypes List product attribute types · Returns the EntitySet AttributeTypes #
Ask an LLM
“What product attribute types are defined in the catalog, like color or size?”
“Can I list only the attribute types that are used as search filters?”
Tell an agent
List all attribute types.
List attribute types where {filter}, ordered by {orderby}.
POST /api/v1/admin/AttributeTypes Create an attribute type · Post a new entity to EntitySet AttributeTypes #
Ask an LLM
“How do I add a new product attribute such as material to the catalog?”
“Can a new attribute type be made filterable and comparable when I create it?”
Tell an agent
Create attribute type {name} labeled {label}.
Add a new attribute type {name} with filter enabled set to {isFilter}.
GET /api/v1/admin/AttributeTypes({id}) Get an attribute type by id · Returns the entity with the key from AttributeTypes #
Ask an LLM
“Can I look up one attribute type's settings by its id?”
“Is a particular attribute type searchable and shown on the product page?”
Tell an agent
Get attribute type {id}.
Fetch attribute type {id} with {expand} expanded.
PUT /api/v1/admin/AttributeTypes({id}) Replace an attribute type · Replace entity in EntitySet AttributeTypes #
Ask an LLM
“Is there a way to overwrite every field of an attribute type at once?”
“What does a full replacement of an attribute type require?”
Tell an agent
Replace attribute type {id} with name {name} and label {label}.
Overwrite the full attribute type record {id}.
DELETE /api/v1/admin/AttributeTypes({id}) Delete an attribute type · Delete entity in EntitySet AttributeTypes #
Ask an LLM
“Can I permanently delete one attribute type by id?”
“Does removing a single attribute type accept an If-Match ETag?”
Tell an agent destructive · confirm first
Delete attribute type {id}.
Delete attribute type {id} if its ETag is still {etag}.
PATCH /api/v1/admin/AttributeTypes({id}) Update fields on an attribute type · Update entity in EntitySet AttributeTypes #
Ask an LLM
“How do I turn off an attribute type without resending all its fields?”
“Can I just rename the label of an existing attribute type?”
Tell an agent
Set attribute type {id} active flag to {isActive}.
Change the label on attribute type {id} to {label}.
GET /api/v1/admin/AttributeTypes/Default.Default() Get a blank attribute type template · Call operation Default #
Ask an LLM
“What default settings does a new attribute type start with?”
“Is there an empty attribute type template to fill in?”
Tell an agent
Get the default attribute type template.
Show the default values for a new attribute type.
POST /api/v1/admin/AttributeTypes/Default.archive Archive attribute types via the archive action · Call operation archive #
Ask an LLM
“Can I archive attribute types by posting to the archive action instead of deleting them?”
“Which POST action retires several attribute types while keeping their history?”
Tell an agent
Archive attribute types {ids} using the POST archive action.
Call the archive action on attribute types {ids}.
DELETE /api/v1/admin/attributetypes/archive Archive attribute types via the DELETE route · Attribute types archive route #
Ask an LLM
“Is there a DELETE archive route for attribute types?”
“Can I archive attribute types with an HTTP DELETE on the archive path?”
Tell an agent destructive · confirm first
Archive attribute types {ids} through the DELETE archive route.
Send a DELETE to the attribute type archive path for {ids}.
DELETE /api/v1/admin/attributetypes/delete Bulk delete attribute types · Attribute types delete route #
Ask an LLM
“Can I permanently delete many attribute types in a single request?”
“Is there a bulk delete route that takes a list of attribute type ids?”
Tell an agent destructive · confirm first
Bulk delete attribute types {ids}.
Permanently remove these attribute types: {ids}.
GET /api/v1/admin/attributetypes({key})/attributevalues({attributevalueKey}) Get a value of an attribute type · Attribute types get attribute value by key and attributevaluekey #
Ask an LLM
“Can I read one allowed value, like Red, under an attribute type?”
“What does a single attribute value record for an attribute type contain?”
Tell an agent
Get attribute value {attributevalueKey} of attribute type {key}.
Show value {attributevalueKey} defined under attribute type {key}.
GET /api/v1/admin/attributetypes({key})/categoryattributetypes({categoryattributetypeKey}) Get a category link for an attribute type · Attribute types get category attribute type by key and categoryattributetypekey #
Ask an LLM
“Which categories use a given attribute type?”
“Can I read one category assignment of an attribute type?”
Tell an agent
Get category attribute type {categoryattributetypeKey} for attribute type {key}.
Show the category link {categoryattributetypeKey} on attribute type {key}.
GET /api/v1/admin/attributetypes({key})/customproperties({custompropertyKey}) Get a custom property on an attribute type · Attribute types get custom property by key and custompropertykey #
Ask an LLM
“How can I read a custom property stored on an attribute type?”
“Can extra metadata on an attribute type be fetched by property id?”
Tell an agent
Get custom property {custompropertyKey} on attribute type {key}.
Read attribute type {key}'s custom field {custompropertyKey}.

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-attribute-types-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-attribute-types-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Attribute Types API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Attribute Types
paths:
  /api/v1/admin/AttributeTypes:
    get:
      tags:
      - Attribute Types
      summary: Returns the EntitySet AttributeTypes
      operationId: AttributeTypes_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:
      - Attribute Types
      summary: Post a new entity to EntitySet AttributeTypes
      operationId: AttributeTypes_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.AttributeType'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/AttributeTypes({id}):
    get:
      tags:
      - Attribute Types
      summary: Returns the entity with the key from AttributeTypes
      operationId: AttributeTypes_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:
      - Attribute Types
      summary: Replace entity in EntitySet AttributeTypes
      operationId: AttributeTypes_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.AttributeType'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Attribute Types
      summary: Delete entity in EntitySet AttributeTypes
      operationId: AttributeTypes_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:
      - Attribute Types
      summary: Update entity in EntitySet AttributeTypes
      operationId: AttributeTypes_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.AttributeType'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/AttributeTypes/Default.Default():
    get:
      tags:
      - Attribute Types
      summary: Call operation Default
      operationId: AttributeTypes_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/AttributeTypes/Default.archive:
    post:
      tags:
      - Attribute Types
      summary: Call operation archive
      operationId: AttributeTypes_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/attributetypes/archive:
    delete:
      tags:
      - Attribute Types
      operationId: AttributeTypes_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: Attribute types archive route
      x-summary-source: derived
  /api/v1/admin/attributetypes/delete:
    delete:
      tags:
      - Attribute Types
      operationId: AttributeTypes_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: Attribute types delete route
      x-summary-source: derived
  /api/v1/admin/attributetypes({key})/attributevalues({attributevalueKey}):
    get:
      tags:
      - Attribute Types
      operationId: AttributeTypes_GetAttributeValueByKeyAndAttributevaluekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: attributevalueKey
        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: Attribute types get attribute value by key and attributevaluekey
      x-summary-source: derived
  /api/v1/admin/attributetypes({key})/categoryattributetypes({categoryattributetypeKey}):
    get:
      tags:
      - Attribute Types
      operationId: AttributeTypes_GetCategoryAttributeTypeByKeyAndCategoryattributetypekey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: categoryattributetypeKey
        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: Attribute types get category attribute type by key and categoryattributetypekey
      x-summary-source: derived
  /api/v1/admin/attributetypes({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Attribute Types
      operationId: AttributeTypes_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: Attribute types get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.AttributeType:
      required:
      - label
      - name
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        isActive:
          type: boolean
        isComparable:
          type: boolean
        isFilter:
          type: boolean
        isSearchable:
          type: boolean
        includeOnProduct:
          type: boolean
        label:
          maxLength: 1024
          minLength: 0
          type: string
        name:
          maxLength: 255
          minLength: 0
          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