Optimizely Categories API
The Categories API from Optimizely — 22 operation(s) for categories.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/optimizely-categories-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Optimizely Categories API
version: '1.0'
description: 'Operations tagged Categories across 2 of this provider''s published API definitions: optimizely-configured-commerce-admin-api-v1-openapi.json, optimizely-configured-commerce-storefront-api-v1-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Categories
paths:
/api/v1/admin/Categories:
get:
tags:
- Categories
summary: Returns the EntitySet Categories
operationId: Categories_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:
- Categories
summary: Post a new entity to EntitySet Categories
operationId: Categories_Post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Data.Entities.Category'
description: The entity to post
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/Categories({id}):
get:
tags:
- Categories
summary: Returns the entity with the key from Categories
operationId: Categories_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:
- Categories
summary: Replace entity in EntitySet Categories
operationId: Categories_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.Category'
description: The entity to put
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
delete:
tags:
- Categories
summary: Delete entity in EntitySet Categories
operationId: Categories_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:
- Categories
summary: Update entity in EntitySet Categories
operationId: Categories_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.Category'
description: The entity to patch
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/Categories/Default.Default():
get:
tags:
- Categories
summary: Call operation Default
operationId: Categories_Default
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/Categories/Default.archive:
post:
tags:
- Categories
summary: Call operation archive
operationId: Categories_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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories({key})/categoryPersonas:
get:
tags:
- Categories
operationId: Categories_GetCategoryPersonasByKey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: archiveFilter
in: query
required: false
schema:
type: integer
format: int32
enum:
- 0
- 1
- 2
- 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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories/categoriesWithParents:
post:
tags:
- Categories
operationId: Categories_GetCategoriesWithParents
requestBody:
content:
application/json:
schema:
type: array
items:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
security:
- access_token: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories/archive:
delete:
tags:
- Categories
operationId: Categories_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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories/delete:
delete:
tags:
- Categories
operationId: Categories_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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories({key})/attributevalues({attributevalueKey}):
get:
tags:
- Categories
operationId: Categories_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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories({key})/categoryattributetypes({categoryattributetypeKey}):
get:
tags:
- Categories
operationId: Categories_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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories({key})/categoryrelatedproducts({categoryrelatedproductKey}):
get:
tags:
- Categories
operationId: Categories_GetCategoryRelatedProductByKeyAndCategoryrelatedproductkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: categoryrelatedproductKey
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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories({key})/customproperties({custompropertyKey}):
get:
tags:
- Categories
operationId: Categories_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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories({key})/dealers({dealerKey}):
get:
tags:
- Categories
operationId: Categories_GetDealerByKeyAndDealerkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: dealerKey
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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories({key})/documents({documentKey}):
get:
tags:
- Categories
operationId: Categories_GetDocumentByKeyAndDocumentkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: documentKey
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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories({key})/personas({personaKey}):
get:
tags:
- Categories
operationId: Categories_GetPersonaByKeyAndPersonakey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: personaKey
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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories({key})/products({productKey}):
get:
tags:
- Categories
operationId: Categories_GetProductByKeyAndProductkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: productKey
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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories({key})/specifications({specificationKey}):
get:
tags:
- Categories
operationId: Categories_GetSpecificationByKeyAndSpecificationkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: specificationKey
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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories({key})/subcategories({categoryKey}):
get:
tags:
- Categories
operationId: Categories_GetSubCategoryByKeyAndCategorykey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: categoryKey
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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/admin/categories({key})/taxexemptions({taxexemptionKey}):
get:
tags:
- Categories
operationId: Categories_GetTaxExemptionByKeyAndTaxexemptionkey
parameters:
- name: key
in: path
required: true
schema:
type: string
format: uuid
- name: taxexemptionKey
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: []
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/categories:
get:
tags:
- Categories
operationId: CategoriesV1_GetCollectionAsync
parameters:
- name: parameter.maxDepth
in: query
required: false
schema:
type: integer
format: int32
- name: parameter.startCategoryId
in: query
required: false
schema:
type: string
format: uuid
- name: parameter.includeStartCategory
in: query
required: false
schema:
type: boolean
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CategoryCollectionModel'
text/json:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CategoryCollectionModel'
application/xml:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CategoryCollectionModel'
text/xml:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CategoryCollectionModel'
text/html:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CategoryCollectionModel'
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/categories/{categoryId}:
get:
tags:
- Categories
operationId: CategoriesV1_GetByIdAsync
parameters:
- name: categoryId
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CategoryModel'
text/json:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CategoryModel'
application/xml:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CategoryModel'
text/xml:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CategoryModel'
text/html:
schema:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CategoryModel'
servers:
- url: https://dogfood.commerce.insitesandbox.com
/api/v1/categories/feederData:
get:
tags:
- Categories
operationId: CategoriesV1_GetFeederData
parameters:
- name: type
in: query
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
text/json:
schema:
type: object
application/xml:
schema:
type: object
text/xml:
schema:
type: object
text/html:
schema:
type: object
servers:
- url: https://dogfood.commerce.insitesandbox.com
components:
schemas:
Insite.Data.Entities.Category:
required:
- erpProductValues
- imageAltText
- largeImagePath
- metaDescription
- metaKeywords
- name
- pageTitle
- shortDescription
- smallImagePath
- urlSegment
type: object
properties:
id:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
activateOn:
format: date-time
type: string
contentManagerId:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
deactivateOn:
format: date-time
type: string
erpProductValues:
type: string
imageAltText:
maxLength: 1024
minLength: 0
type: string
isDynamic:
type: boolean
isFeatured:
type: boolean
largeImagePath:
maxLength: 1024
minLength: 0
type: string
metaDescription:
type: string
metaKeywords:
type: string
name:
maxLength: 255
minLength: 0
type: string
pageTitle:
maxLength: 1024
minLength: 0
type: string
parentId:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
ruleManagerId:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
shortDescription:
maxLength: 255
minLength: 0
type: string
showDetail:
type: boolean
smallImagePath:
maxLength: 1024
minLength: 0
type: string
sortOrder:
format: int32
type: integer
searchBoost:
format: decimal
type: number
productSearchBoost:
format: decimal
type: number
urlSegment:
maxLength: 255
minLength: 0
type: string
websiteId:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
openGraphTitle:
maxLength: 2048
minLength: 0
type: string
openGraphUrl:
maxLength: 2048
minLength: 0
type: string
openGraphImage:
maxLength: 1024
minLength: 0
type: string
mobileBannerImageUrl:
maxLength: 1024
minLength: 0
type: string
mobilePrimaryText:
maxLength: 1024
minLength: 0
type: string
mobileSecondaryText:
maxLength: 1024
minLength: 0
type: string
mobileTextJustification:
maxLength: 32
minLength: 0
type: string
mobileTextColor:
maxLength: 8
minLength: 0
type: string
excludeFromRecommendations:
type: boolean
pimCategoryId:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
createdOn:
format: date-time
type: string
createdBy:
type: string
modifiedOn:
format: date-time
type: string
modifiedBy:
type: string
Insite.Catalog.WebApi.V1.ApiModels.CategoryCollectionModel:
type: object
properties:
uri:
type: string
categories:
type: array
items:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CategoryModel'
properties:
type: object
additionalProperties:
type: string
Insite.Catalog.WebApi.V1.ApiModels.CategoryModel:
type: object
properties:
uri:
type: string
id:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
parentId:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
name:
type: string
shortDescription:
type: string
urlSegment:
type: string
smallImagePath:
type: string
largeImagePath:
type: string
imageAltText:
type: string
activateOn:
format: date-time
type: string
deactivateOn:
format: date-time
type: string
metaKeywords:
type: string
metaDescription:
type: string
htmlContent:
type: string
sortOrder:
format: int32
type: integer
isFeatured:
type: boolean
isDynamic:
type: boolean
subCategories:
type: array
items:
$ref: '#/components/schemas/Insite.Catalog.WebApi.V1.ApiModels.CategoryModel'
path:
type: string
mobileBannerImageUrl:
type: string
mobilePrimaryText:
type: string
mobileSecondaryText:
type: string
mobileTextJustification:
type: string
mobileTextColor:
type: string
properties:
type: object
additionalProperties:
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
x-refined-from:
- optimizely-configured-commerce-admin-api-v1-openapi.json
- optimizely-configured-commerce-storefront-api-v1-openapi.json